Class PageMetaData

Contains meta data about the page.

For each request an instance of this class will be placed in the pipeline dictionary under the key “CurrentPageMetaData”. The information stored in CurrentPageMetaData can be referenced in templates and rendered in an HTML head section: for example:

1<head>
2<title>${pdict.CurrentPageMetaData.title}</title>
3<meta name="description" content="${pdict.CurrentPageMetaData.description}"/>
4.
5.
6.
7</head>

To update the CurrentPageMetaData there is the pipelet UpdatePageMetaData provided.

Property Summary 

PropertyDescription
description: StringReturns the page’s description.
keywords: StringReturns the page’s key words.
pageMetaTags: Array (read-only)Returns all page meta tags added to this container.
title: StringReturns the page’s title.

Constructor Summary 

This class does not have a constructor, so you cannot create it directly.

Method Summary 

MethodDescription
addPageMetaTag(PageMetaTag)Adds a page meta tag to this container.
addPageMetaTags(Array)Adds a page meta tags list to this container.
getDescription()Returns the page’s description.
getKeywords()Returns the page’s key words.
getPageMetaTags()Returns all page meta tags added to this container.
getTitle()Returns the page’s title.
isPageMetaTagSet(String)Returns true if a page meta tag with the given ID is set, false otherwise.
setDescription(String)Sets the page’s description.
setKeywords(String)Sets the page’s key words.
setTitle(String)Sets the page’s title.

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Property Details 

description 

description: String

Returns the page's description.


keywords 

keywords: String

Returns the page's key words.


pageMetaTags 

pageMetaTags: Array (read-only)

Returns all page meta tags added to this container.


title 

title: String

Returns the page's title.


Method Details 

addPageMetaTag(PageMetaTag) 

addPageMetaTag(pageMetaTag: PageMetaTag): void

Adds a page meta tag to this container.

Parameters:

  • pageMetaTag - the page meta tag to be added

addPageMetaTags(Array) 

addPageMetaTags(pageMetaTags: Array): void

Adds a page meta tags list to this container.

Parameters:

  • pageMetaTags - the page meta tags list to be added

getDescription() 

getDescription(): String

Returns the page's description.

Returns:

  • the page's description.

getKeywords() 

getKeywords(): String

Returns the page's key words.

Returns:

  • the page's key words.

getPageMetaTags() 

getPageMetaTags(): Array

Returns all page meta tags added to this container.

Returns:

  • page meta tags

getTitle() 

getTitle(): String

Returns the page's title.

Returns:

  • the page's title.

isPageMetaTagSet(String) 

isPageMetaTagSet(id: String): Boolean

Returns true if a page meta tag with the given ID is set, false otherwise.

Parameters:

  • id - the ID to be check if a page meta tag is set

Returns:

  • true if a page meta tag with the given ID is set, false otherwise

setDescription(String) 

setDescription(description: String): void

Sets the page's description.

Parameters:

  • description - the page's description.

setKeywords(String) 

setKeywords(keywords: String): void

Sets the page's key words.

Parameters:

  • keywords - the page's key words.

setTitle(String) 

setTitle(title: String): void

Sets the page's title.

Parameters:

  • title - the page's title.