Class VariableController

The VariableController is responsible for all communication regarding the variables. Methods inside this controller can be called by window.SDK.variable.{method-name}

Hierarchy

VariableController

Methods

create

create(parentId: string, type: VariableType): Promise<EditorResponse<string>>
This method creates a new variable

Returns
the new created variable id
Parameters
- parentId: string
  
  parent id of the created variable
- type: VariableType
  
  type of the created variable
Returns Promise<EditorResponse<string>>
- Defined in controllers/VariableController.ts:85

duplicate

duplicate(id: string): Promise<EditorResponse<string>>
This method creates a copy of a variable

Returns
Parameters
- id: string
Returns Promise<EditorResponse<string>>
- Defined in controllers/VariableController.ts:170

getAll

getAll(): Promise<EditorResponse<Variable[]>>
This method returns the list of variables

Returns

Returns Promise<EditorResponse<Variable[]>>
- Defined in controllers/VariableController.ts:27

getById

getById(id: string): Promise<EditorResponse<Variable>>
This method returns a variable by id

Returns
Parameters
- id: string
  
  the id of a specific variable
Returns Promise<EditorResponse<Variable>>
- Defined in controllers/VariableController.ts:46

getByName

getByName(name: string): Promise<EditorResponse<Variable>>
This method returns a variable by name

Returns
Parameters
- name: string
  
  the name of a specific variable
Returns Promise<EditorResponse<Variable>>
- Defined in controllers/VariableController.ts:65

getImageVariableConnectorId

getImageVariableConnectorId(id: string): Promise<EditorResponse<string>>
This method gets the image variable connector id.

Returns
The id of the connector
Parameters
- id: string
  
  The id of the image variable
Returns Promise<EditorResponse<string>>
- Defined in controllers/VariableController.ts:263

groupVariables

groupVariables(name: string, ids: string[]): Promise<EditorResponse<string>>
This method aggregates the provided variables into a new group

Returns
group id
Parameters
- name: string
  
  name of the new group
- ids: string[]
  
  list of variable ids to group together
Returns Promise<EditorResponse<string>>
- Defined in controllers/VariableController.ts:181

move

move(order: number, id: string, parentId: string): Promise<EditorResponse<null>>
This method moves a variable's position

Returns
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>>
- Defined in controllers/VariableController.ts:203

moveVariables

moveVariables(order: number, ids: string[], parentId: string): Promise<EditorResponse<null>>
This method changes positions of variables

Returns
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>>
- Defined in controllers/VariableController.ts:215

remove

remove(ids: string[]): Promise<EditorResponse<null>>
This method removes a list of variables.

All connectors linked to the variables will be unregistered.

Returns
Parameters
- ids: string[]
  
  list of the variables to be removed
Returns Promise<EditorResponse<null>>
- Defined in controllers/VariableController.ts:97

removeSource

removeSource(id: string): Promise<EditorResponse<null>>
Deprecated
use setValue instead and pass null as the value argument.

This method removes the variable source
Parameters
- id: string
  
  the id of the variable to update
Returns Promise<EditorResponse<null>>
- Defined in controllers/VariableController.ts:289

rename

rename(id: string, name: string): Promise<EditorResponse<null>>
This method sets a new name for a variable

Returns
Parameters
- id: string
  
  id of the variable
- name: string
  
  name of the variable
Returns Promise<EditorResponse<null>>
- Defined in controllers/VariableController.ts:108

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.

Returns
The new id of the connector
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>>
- Defined in controllers/VariableController.ts:276

setIsHidden

setIsHidden(id: string, isHidden: boolean): Promise<EditorResponse<null>>
Deprecated
Use setIsVisible instead.

This method sets isHidden flag for a variable

Returns
Parameters
- id: string
- isHidden: boolean
Returns Promise<EditorResponse<null>>
- Defined in controllers/VariableController.ts:235

setIsReadonly

setIsReadonly(id: string, isReadonly: boolean): Promise<EditorResponse<null>>
This method sets isReadonly flag for a variable

Returns
Parameters
- id: string
- isReadonly: boolean
Returns Promise<EditorResponse<null>>
- Defined in controllers/VariableController.ts:253

setIsRequired

setIsRequired(id: string, isRequired: boolean): Promise<EditorResponse<null>>
This method sets isRequired flag for a variable

Returns
Parameters
- id: string
- isRequired: boolean
Returns Promise<EditorResponse<null>>
- Defined in controllers/VariableController.ts:244

setIsVisible

setIsVisible(id: string, isVisible: boolean): Promise<EditorResponse<null>>
This method sets isVisible flag for a variable

Returns
Parameters
- id: string
- isVisible: boolean
Returns Promise<EditorResponse<null>>
- Defined in controllers/VariableController.ts:224

setLabel

setLabel(id: string, label: string): Promise<EditorResponse<null>>
This method sets a new label for a variable

Returns
Parameters
- id: string
  
  id of the variable
- label: string
  
  label of the variable
Returns Promise<EditorResponse<null>>
- Defined in controllers/VariableController.ts:119

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.

Returns
Parameters
- id: string
  
  the id of the list variable
- items: string[]
  
  the items of the list
Returns Promise<EditorResponse<null>>
- Defined in controllers/VariableController.ts:144

setType

setType(id: string, type: VariableType): Promise<EditorResponse<null>>
This method sets a new type for a variable

Returns
Parameters
- id: string
  
  id of the variable
- type: VariableType
  
  type of the variable
Returns Promise<EditorResponse<null>>
- Defined in controllers/VariableController.ts:130

setValue

setValue(id: string, value: null | string | boolean): Promise<EditorResponse<null>>
This method sets a new value for a variable

Returns
Parameters
- id: string
  
  the id of the variable
- value: null | string | boolean
  
  the new value of the variable
Returns Promise<EditorResponse<null>>
- Defined in controllers/VariableController.ts:161

ungroupVariables

ungroupVariables(id: string): Promise<EditorResponse<null>>
This method dissolves the specified group

Returns
Parameters
- id: string
  
  id of the variable group
Returns Promise<EditorResponse<null>>
- Defined in controllers/VariableController.ts:191

Class VariableController

Hierarchy

Index

Methods

Methods

create

Returns

Parameters

parentId: string

type: VariableType

Returns Promise<EditorResponse<string>>

duplicate

Returns

Parameters

id: string

Returns Promise<EditorResponse<string>>

getAll

Returns

Returns Promise<EditorResponse<Variable[]>>

getById

Returns

Parameters

id: string

Returns Promise<EditorResponse<Variable>>

getByName

Returns

Parameters

name: string

Returns Promise<EditorResponse<Variable>>

getImageVariableConnectorId

Returns

Parameters

id: string

Returns Promise<EditorResponse<string>>

groupVariables

Returns

Parameters

name: string

ids: string[]

Returns Promise<EditorResponse<string>>

move

Returns

Parameters

order: number

id: string

parentId: string

Returns Promise<EditorResponse<null>>

moveVariables

Returns

Parameters

order: number

ids: string[]

parentId: string

Returns Promise<EditorResponse<null>>

remove

Returns

Parameters

ids: string[]

Returns Promise<EditorResponse<null>>

removeSource

Deprecated

Parameters

id: string

Returns Promise<EditorResponse<null>>

rename

Returns

Parameters

id: string

name: string

Returns Promise<EditorResponse<null>>

setImageVariableConnector

Returns

Parameters

id: string

registration: ConnectorRegistration

Returns Promise<EditorResponse<string>>

setIsHidden

Deprecated

Returns

Parameters