Class VariableController

Index

Methods

getAll getById getByName setImageVariableConnector setListVariable

Methods

getAll

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

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

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>>
- Defined in src/next/controllers/VariableController.ts:38

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>>
- Defined in src/next/controllers/VariableController.ts:48

setImageVariableConnector

setImageVariableConnector(
    id: string,
    registration:
        | ConnectorUrlRegistration
        | ConnectorGrafxRegistration
        | ConnectorLocalRegistration,
): 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:
      | ConnectorUrlRegistration
      | ConnectorGrafxRegistration
      | ConnectorLocalRegistration
  registration object containing all details about the connector
Returns Promise<EditorResponse<string>>
The new id of the connector
- Defined in src/next/controllers/VariableController.ts:80

setListVariable

setListVariable(
id: string,
items: ListVariableItem[],
): 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: ListVariableItem[]
  the items of the list
Returns Promise<EditorResponse<null>>
- Defined in src/next/controllers/VariableController.ts:62