API Docs for: 1.5.0
Show:

ObjectStateCreateStruct Class

Defined in: src/structures/ObjectStateCreateStruct.js:5

Returns a structure used to create a new Object State. See ContentService.createObjectState

Constructor

ObjectStateCreateStruct

(
  • identifier
  • languageCode
  • priority
  • names
  • descriptions
)

Defined in src/structures/ObjectStateCreateStruct.js:5

Parameters:

  • identifier String

    unique ObjectState identifier (e.g. "some-new-state")

  • languageCode String

    The language code (eng-GB, fre-FR, ...)

  • priority Number
  • names Array

    Multi language value (see example)

  • descriptions Array

    Multi language value (see example)

Example:

 var objectStateCreateStruct = contentService.newObjectStateCreateStruct(
     "some-id",
     "eng-US",
     0,
     [
         {
             "_languageCode":"eng-US",
             "#text":"Some Name"
         }
     ],
     [
         {
             "_languageCode":"eng-US",
             "#text":"Some Description"
         }
     ]
 );

Item Index