Script: Class dw.web.PageMetaData
Class PageMetaData
- Object
- dw.web.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:
<head> <title>${pdict.CurrentPageMetaData.title}</title> <meta name="description" content="${pdict.CurrentPageMetaData.description}"/> . . . </head>
To update the CurrentPageMetaData there is the pipelet UpdatePageMetaData provided.
Properties
description : String
The page's description.
keywords : String
The page's key words.
pageMetaTags : Array Read Only
All page meta tags added to this container.
title : String
The page's title.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
addPageMetaTag(pageMetaTag : PageMetaTag) : void
Adds a page meta tag to this container.
addPageMetaTags(pageMetaTags : Array) : void
Adds a page meta tags list to this container.
getDescription() : String
Returns the page's description.
getKeywords() : String
Returns the page's key words.
getPageMetaTags() : Array
Returns all page meta tags added to this container.
Returns the page's title.
isPageMetaTagSet(id : String) : boolean
Returns true if a page meta tag with the given ID is set, false otherwise.
setDescription(description : String) : void
Sets the page's description.
setKeywords(keywords : String) : void
Sets the page's key words.
setTitle(title : String) : void
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
Method Detail
addPageMetaTag
addPageMetaTag(pageMetaTag : PageMetaTag) : void
Adds a page meta tag to this container.
Parameters:
pageMetaTag - the page meta tag to be added
addPageMetaTags
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
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
setDescription(description : String) : void
Sets the page's description.
Parameters:
description - the page's description.
setKeywords
setKeywords(keywords : String) : void
Sets the page's key words.
Parameters:
keywords - the page's key words.
setTitle
setTitle(title : String) : void
Sets the page's title.
Parameters:
title - the page's title.