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:
To update the CurrentPageMetaData there is the pipelet UpdatePageMetaData provided.
| Property | Description |
|---|---|
| description: String | Returns the page's description. |
| keywords: String | Returns the page's key words. |
pageMetaTags: Array (read-only) | Returns all page meta tags added to this container. |
| title: String | Returns the page's title. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| 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. |
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
- description: String
Returns the page's description.
- keywords: String
Returns the page's key words.
- pageMetaTags: Array
(read-only) Returns all page meta tags added to this container.
- title: String
Returns the page's title.
- addPageMetaTag(pageMetaTag: PageMetaTag): void
Adds a page meta tag to this container.
Parameters:
- pageMetaTag - the page meta tag to be added
- addPageMetaTags(pageMetaTags: Array): void
Adds a page meta tags list to this container.
Parameters:
- pageMetaTags - the page meta tags list to be added
- getDescription(): String
Returns the page's description.
Returns:
- the page's description.
- getKeywords(): String
Returns the page's key words.
Returns:
- the page's key words.
- getPageMetaTags(): Array
Returns all page meta tags added to this container.
Returns:
- page meta tags
- getTitle(): String
Returns the page's title.
Returns:
- the page's title.
- 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(description: String): void
Sets the page's description.
Parameters:
- description - the page's description.
- setKeywords(keywords: String): void
Sets the page's key words.
Parameters:
- keywords - the page's key words.
- setTitle(title: String): void
Sets the page's title.
Parameters:
- title - the page's title.