Class VariableController

image

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>>

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>>