Class CMSRecord

• TopLevel.Object
  • dw.experience.cms.CMSRecord

This class represents a Salesforce CMS record, exposing its:

• id, see getID()
• type, see getType()
• attributes, see getAttributes()

The attributes are key value pairs:

• the key being the attribute id as given in the type.attribute_definitionsentries
• the value being a DWScript API object resolved from the raw attribute value based on the attribute type as given in the type.attribute_definitionsentries (similar to how ComponentScriptContext.getContent()exposes the raw attribute value of a Component.getAttribute(String)in shape of a DWScript API object based on the attribute type)

Property Summary 

Property	Description
ID: String (read-only)	Return the id of the Salesforce CMS record.
attributes: Map (read-only)	Return the Salesforce CMS record attributes as key value pairs: the key being the attribute id as given in the [getType()](dw.experience.cms.CMSRecord.md#gettype).attribute_definitions entries the value being a DWScript API object resolved from the raw attribute value based on the attribute type as given in the [getType()](dw.experience.cms.CMSRecord.md#gettype).attribute_definitions entries (similar to how ComponentScriptContext.getContent() exposes the raw attribute value of a Component.getAttribute(String) in shape of a DWScript API object based on the attribute type) The attributes are also conveniently accessible through named property support.
type: Map (read-only)	Return the type of the Salesforce CMS record sufficing the content/schema/cmsrecord.json#/definitions/cms_content_type schema.

Constructor Summary 

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

Method Summary 

Method	Description
getAttributes()	Return the Salesforce CMS record attributes as key value pairs: the key being the attribute id as given in the [getType()](dw.experience.cms.CMSRecord.md#gettype).attribute_definitions entries the value being a DWScript API object resolved from the raw attribute value based on the attribute type as given in the [getType()](dw.experience.cms.CMSRecord.md#gettype).attribute_definitions entries (similar to how ComponentScriptContext.getContent() exposes the raw attribute value of a Component.getAttribute(String) in shape of a DWScript API object based on the attribute type) The attributes are also conveniently accessible through named property support.
getID()	Return the id of the Salesforce CMS record.
getType()	Return the type of the Salesforce CMS record sufficing the content/schema/cmsrecord.json#/definitions/cms_content_type schema.

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 

ID 

ID: String (read-only)

Return the id of the Salesforce CMS record.

---

attributes 

attributes: Map (read-only)

Return the Salesforce CMS record attributes as key value pairs:

• the key being the attribute id as given in the [getType()](dw.experience.cms.CMSRecord.md#gettype).attribute_definitionsentries
• the value being a DWScript API object resolved from the raw attribute value based on the attribute type as given in the [getType()](dw.experience.cms.CMSRecord.md#gettype).attribute_definitionsentries (similar to how ComponentScriptContext.getContent()exposes the raw attribute value of a Component.getAttribute(String)in shape of a DWScript API object based on the attribute type)

The attributes are also conveniently accessible through named property support. That means if myCmsRecord.getAttributes().get('foo') yields value 'bar', then myCmsRecord.foo will give the same results.

---

type 

type: Map (read-only)

Return the type of the Salesforce CMS record sufficing the content/schema/cmsrecord.json#/definitions/cms_content_type schema. Properties can be accessed accordingly:

• getType().id : string
• getType().name : string
• getType().attribute_definitions : Map(see content/schema/attributedefinition.json)

---

Method Details 

getAttributes() 

getAttributes(): Map

Return the Salesforce CMS record attributes as key value pairs:

• the key being the attribute id as given in the [getType()](dw.experience.cms.CMSRecord.md#gettype).attribute_definitionsentries
• the value being a DWScript API object resolved from the raw attribute value based on the attribute type as given in the [getType()](dw.experience.cms.CMSRecord.md#gettype).attribute_definitionsentries (similar to how ComponentScriptContext.getContent()exposes the raw attribute value of a Component.getAttribute(String)in shape of a DWScript API object based on the attribute type)

The attributes are also conveniently accessible through named property support. That means if myCmsRecord.getAttributes().get('foo') yields value 'bar', then myCmsRecord.foo will give the same results.

Returns:

• the cms record attributes

---

getID() 

getID(): String

Return the id of the Salesforce CMS record.

Returns:

• the id of the Salesforce CMS record

---

getType() 

getType(): Map

Return the type of the Salesforce CMS record sufficing the content/schema/cmsrecord.json#/definitions/cms_content_type schema. Properties can be accessed accordingly:

• getType().id : string
• getType().name : string
• getType().attribute_definitions : Map(see content/schema/attributedefinition.json)

Returns:

• the type of the cms record

---