Class VariableController

date

number

create

• create(parentId: string, type: VariableType): Promise<EditorResponse<string>>

  This method creates a new variable

  Parameters

  • parentId: string

    parent id of the created variable
  • type: VariableType

    type of the created variable

  Returns Promise<EditorResponse<string>>

  the new created variable id

duplicate

• duplicate(id: string): Promise<EditorResponse<string>>

  This method creates a copy of a variable

  Parameters

  • id: string

  Returns Promise<EditorResponse<string>>

getAll

• getAll(): Promise<EditorResponse<Variable[]>>

  This method returns the list of variables

  Returns Promise<EditorResponse<Variable[]>>

getById

• getById(id: string): Promise<EditorResponse<Variable>>

  This method returns a variable by id

  Parameters

  • id: string

    the id of a specific variable

  Returns Promise<EditorResponse<Variable>>

getByName

• getByName(name: string): Promise<EditorResponse<Variable>>

  This method returns a variable by name

  Parameters

  • name: string

    the name of a specific variable

  Returns Promise<EditorResponse<Variable>>

getImageVariableConnectorId

• getImageVariableConnectorId(id: string): Promise<EditorResponse<string>>

  This method gets the image variable connector id.

  Parameters

  • id: string

    The id of the image variable

  Returns Promise<EditorResponse<string>>

  The id of the connector

getPrivateData

• getPrivateData(id: string): Promise<EditorResponse<PrivateData>>

  Gets the private data for any variable

  Parameters

  • id: string

    the id of the variable

  Returns Promise<EditorResponse<PrivateData>>

  the private data

groupVariables

• groupVariables(name: string, ids: string[]): Promise<EditorResponse<string>>

  This method aggregates the provided variables into a new group

  Parameters

  • name: string

    name of the new group
  • ids: string[]

    list of variable ids to group together

  Returns Promise<EditorResponse<string>>

  group id

move

• move(order: number, id: string, parentId: string): Promise<EditorResponse<null>>

  This method moves a variable's position

  Parameters

  • order: number

    new order of variable
  • id: string

    id of the variable
  • parentId: string

    parent id of the created variable

  Returns Promise<EditorResponse<null>>

moveVariables

• moveVariables(
      order: number,
      ids: string[],
      parentId: string,
  ): Promise<EditorResponse<null>>

  This method changes positions of variables

  Parameters

  • order: number

    new order of variable
  • ids: string[]

    Array of the variable IDs
  • parentId: string

    parent id of the variables

  Returns Promise<EditorResponse<null>>

remove

• remove(ids: string[]): Promise<EditorResponse<null>>

  This method removes a list of variables.

  All connectors linked to the variables will be unregistered.

  Parameters

  • ids: string[]

    list of the variables to be removed

  Returns Promise<EditorResponse<null>>

removeSource

• removeSource(id: string): Promise<EditorResponse<null>>

  Parameters

  • id: string

    the id of the variable to update

  Returns Promise<EditorResponse<null>>

  Deprecated

  use setValue instead and pass null as the value argument.

  This method removes the variable source

rename

• rename(id: string, name: string): Promise<EditorResponse<null>>

  This method sets a new name for a variable

  Parameters

  • id: string

    id of the variable
  • name: string

    name of the variable

  Returns Promise<EditorResponse<null>>

resetHelpText

• resetHelpText(id: string): Promise<EditorResponse<null>>

  This method resets a help text for a variable

  Parameters

  • id: string

    id of the variable

  Returns Promise<EditorResponse<null>>

resetPlaceholder

• resetPlaceholder(id: string): Promise<EditorResponse<null>>

  This method resets a placeholder for a variable

  Parameters

  • id: string

    id of the variable

  Returns Promise<EditorResponse<null>>

setAllowImageQuery

• setAllowImageQuery(
      id: string,
      allowQuery: boolean,
  ): Promise<EditorResponse<null>>

  This method sets the allowQuery flag for an image variable

  Parameters

  • id: string

    the id of the variable
  • allowQuery: boolean

    the allowQuery flag

  Returns Promise<EditorResponse<null>>

setAllowImageUpload

• setAllowImageUpload(
      id: string,
      allowUpload: boolean,
  ): Promise<EditorResponse<null>>

  This method sets the allowUpload flag for an image variable

  Parameters

  • id: string

    the id of the variable
  • allowUpload: boolean

    the allowUpload flag

  Returns Promise<EditorResponse<null>>

setHelpText

• setHelpText(id: string, helpText: string): Promise<EditorResponse<null>>

  This method sets a new help text for a variable

  Parameters

  • id: string

    id of the variable
  • helpText: string

    placeholder of the variable

  Returns Promise<EditorResponse<null>>

setImageVariableConnector

• setImageVariableConnector(
      id: string,
      registration: ConnectorRegistration,
  ): Promise<EditorResponse<string>>

  This method sets the image variable connector. Setting a connector will automatically remove the assetId linked to the connector if present. If a connector was the source of the variable, it will be unregistered.

  Parameters

  • id: string

    The id of the image variable to update
  • registration: ConnectorRegistration

    registration object containing all details about the connector

  Returns Promise<EditorResponse<string>>

  The new id of the connector

setImageVariableValueWithContext

• setImageVariableValueWithContext(
      id: string,
      value: null | string,
      context: Dictionary,
  ): Promise<EditorResponse<null>>

  This method sets the value of an image variable along with its context in a single atomic operation

  Parameters

  • id: string

    the id of the image variable to update
  • value: null | string

    the new value of the image variable
  • context: Dictionary

    the context dictionary

  Returns Promise<EditorResponse<null>>

setIsHidden

• setIsHidden(id: string, isHidden: boolean): Promise<EditorResponse<null>>

  Parameters

  • id: string

    variable id
  • isHidden: boolean

    visibility flag

  Returns Promise<EditorResponse<null>>

  Deprecated

  Use setVariableVisibility instead. This method redirects to setVariableVisibility and sets visibility config for a variable by id.

setIsReadonly

• setIsReadonly(id: string, isReadonly: boolean): Promise<EditorResponse<null>>

  This method sets isReadonly flag for a variable

  Parameters

  • id: string
  • isReadonly: boolean

  Returns Promise<EditorResponse<null>>

setIsRequired

• setIsRequired(id: string, isRequired: boolean): Promise<EditorResponse<null>>

  This method sets isRequired flag for a variable

  Parameters

  • id: string
  • isRequired: boolean

  Returns Promise<EditorResponse<null>>

setIsVisible

• setIsVisible(id: string, isVisible: boolean): Promise<EditorResponse<null>>

  Parameters

  • id: string

    variable id
  • isVisible: boolean

    visibility flag

  Returns Promise<EditorResponse<null>>

  Deprecated

  Use setVariableVisibility instead. This method redirects to setVariableVisibility and sets visibility config for a variable by id.

setLabel

• setLabel(id: string, label: null | string): Promise<EditorResponse<null>>

  This method sets a new label for a variable

  Parameters

  • id: string

    id of the variable
  • label: null | string

    label of the variable

  Returns Promise<EditorResponse<null>>

setLayoutsForVariableVisibility

• setLayoutsForVariableVisibility(
      layoutIdList?: null | string[],
  ): Promise<EditorResponse<null>>

  This method sets which layouts are considered for variable visibility

  Parameters

  • OptionallayoutIdList: null | string[]

    nullable layout id list. Pass null to reset to follow selected layout.

  Returns Promise<EditorResponse<null>>

setListVariable

• setListVariable(id: string, items: string[]): Promise<EditorResponse<null>>

  This method sets the items of the list variable

  The items need to be unique and are not case sensitive.

  Parameters

  • id: string

    the id of the list variable
  • items: string[]

    the items of the list

  Returns Promise<EditorResponse<null>>

setMinImageUploadSize

• setMinImageUploadSize(
      id: string,
      minWidth: null | string,
      minHeight: null | string,
  ): Promise<EditorResponse<null>>

  This method sets the minimum size (both width and height) for an image variable that will be uploaded

  Parameters

  • id: string

    the id of the variable
  • minWidth: null | string

    the minimum width
  • minHeight: null | string

    the minimum height

  Returns Promise<EditorResponse<null>>

setPlaceholder

• setPlaceholder(id: string, placeholder: string): Promise<EditorResponse<null>>

  This method sets a new placeholder for a variable

  Parameters

  • id: string

    id of the variable
  • placeholder: string

    placeholder of the variable

  Returns Promise<EditorResponse<null>>

setPrefix

• setPrefix(id: string, prefix: null | string): Promise<EditorResponse<null>>
  Experimental

  Sets the prefix for a supported variable

  Parameters

  • id: string

    the id of the variable to update
  • prefix: null | string

    the prefix to set/clear

  Returns Promise<EditorResponse<null>>

setPrefixCharacterStyle

• setPrefixCharacterStyle(
      id: string,
      characterStyleId: null | string,
  ): Promise<EditorResponse<null>>
  Experimental

  Sets the prefix character style for a supported variable

  Parameters

  • id: string

    the id of the variable to update
  • characterStyleId: null | string

    the id of the character style to use/clear for the prefix

  Returns Promise<EditorResponse<null>>

setPrivateData

• setPrivateData(
      id: string,
      privateData: PrivateData,
  ): Promise<EditorResponse<null>>

  Sets the private data for any variable

  Parameters

  • id: string

    the id of the variable to update
  • privateData: PrivateData

    the private data

  Returns Promise<EditorResponse<null>>

setRemoveParagraphIfEmpty

• setRemoveParagraphIfEmpty(
      id: string,
      removeParagraphIfEmpty: boolean,
  ): Promise<EditorResponse<null>>

  This method sets removeParagraphIfEmpty flag for a variable

  Parameters

  • id: string

    The id of the variable to update
  • removeParagraphIfEmpty: boolean

    Set to true to remove the paragraph if it is empty, or false to keep it

  Returns Promise<EditorResponse<null>>

setSuffix

• setSuffix(id: string, suffix: null | string): Promise<EditorResponse<null>>
  Experimental

  Sets the suffix for a supported variable

  Parameters

  • id: string

    the id of the variable to update
  • suffix: null | string

    the suffix to set/clear

  Returns Promise<EditorResponse<null>>

setSuffixCharacterStyle

• setSuffixCharacterStyle(
      id: string,
      characterStyleId: null | string,
  ): Promise<EditorResponse<null>>
  Experimental

  Sets the suffix character style for a supported variable

  Parameters

  • id: string

    the id of the variable to update
  • characterStyleId: null | string

    the id of the character style to use/clear for the suffix

  Returns Promise<EditorResponse<null>>

setType

• setType(id: string, type: VariableType): Promise<EditorResponse<null>>

  This method sets a new type for a variable

  Parameters

  • id: string

    id of the variable
  • type: VariableType

    type of the variable

  Returns Promise<EditorResponse<null>>

setValue

• setValue(
      id: string,
      value: null | string | number | boolean,
  ): Promise<EditorResponse<null>>

  This method sets a new value for a variable

  If the value is some text to be set on a ShortTextVariable, it must not contain any type of line breaks.

  If the value is passing a context on an image variable value, it will be available from the connector.

  Parameters

  • id: string

    the id of the variable
  • value: null | string | number | boolean

    the new value of the variable

  Returns Promise<EditorResponse<null>>

setVariableVisibility

• setVariableVisibility(
      id: string,
      config: VariableVisibility,
  ): Promise<EditorResponse<null>>

  This method sets visibility config for a variable by id

  Parameters

  • id: string

    variable id
  • config: VariableVisibility

    visibility config

  Returns Promise<EditorResponse<null>>

ungroupVariables

• ungroupVariables(id: string): Promise<EditorResponse<null>>

  This method dissolves the specified group

  Parameters

  • id: string

    id of the variable group

  Returns Promise<EditorResponse<null>>