Type alias Variable

Type declaration

• createVariable:function

  • createVariable(variableId: string, value: string, description: string, expressionType?: VariableExpressionType, noEncode?: boolean): Promise<VariableSkeleton>

  • Create variable

    Parameters

    • variableId: string

      variable id/name
    • value: string

      variable value
    • description: string

      variable description
    • Optional expressionType: VariableExpressionType

      type of the value
    • Optional noEncode: boolean

      do not encode if passing a pre-encoded (base64) value

    Returns Promise<VariableSkeleton>

    a promise that resolves to a variable object

• deleteVariable:function

  • deleteVariable(variableId: string): Promise<VariableSkeleton>

  • Delete variable by id/name

    Parameters

    • variableId: string

      variable id/name

    Returns Promise<VariableSkeleton>

    a promise that resolves to a variable object

• exportVariable:function

  • exportVariable(variableId: string, noDecode?: boolean): Promise<VariablesExportInterface>

  • Export variable. The response can be saved to file as is.

    Parameters

    • variableId: string

      variable id/name
    • Optional noDecode: boolean

      Do not decode value (default: false)

    Returns Promise<VariablesExportInterface>

    Promise resolving to a VariablesExportInterface object.

• exportVariables:function

  • exportVariables(noDecode?: boolean): Promise<VariablesExportInterface>

  • Export all variables

    Parameters

    • Optional noDecode: boolean

      Do not decode values (default: false)

    Returns Promise<VariablesExportInterface>

    Promise resolving to an VariablesExportInterface object.

• getVariable:function

  • getVariable(variableId: string): Promise<VariableSkeleton>

  • Get variable by id/name

    Parameters

    • variableId: string

      variable id/name

    Returns Promise<VariableSkeleton>

    a promise that resolves to a variable object

    Deprecated

    since v2.0.0 use readVariable instead

    readVariable(variableId: string): Promise<VariableSkeleton>
    Copy

• getVariables:function

  • getVariables(): Promise<VariableSkeleton[]>

  • Get all variables

    Returns Promise<VariableSkeleton[]>

    a promise that resolves to an array of variable objects

    Deprecated

    since v2.0.0 use readVariables instead

    readVariables(): Promise<VariableSkeleton[]>
    Copy

• importVariable:function

  • importVariable(variableId: string, importData: VariablesExportInterface): Promise<VariableSkeleton>

  • Import variable by id

    Parameters

    • variableId: string

      variable id/name
    • importData: VariablesExportInterface

      import data

    Returns Promise<VariableSkeleton>

    imported variable object

• importVariables:function

  • importVariables(importData: VariablesExportInterface): Promise<VariableSkeleton[]>

  • Import variables

    Parameters

    • importData: VariablesExportInterface

      import data

    Returns Promise<VariableSkeleton[]>

    array of imported variable objects

• putVariable:function

  • putVariable(variableId: string, valueBase64: string, description: string, expressionType?: VariableExpressionType): Promise<VariableSkeleton>

  • Create variable

    Parameters

    • variableId: string

      variable id/name
    • valueBase64: string

      base64-encoded variable value
    • description: string

      variable description
    • Optional expressionType: VariableExpressionType

      type of the value

    Returns Promise<VariableSkeleton>

    a promise that resolves to a variable object

    Deprecated

    since v2.0.0 use createVariable instead

    createVariable(variableId: string, value: string, description: string, expressionType?: VariableExpressionType): Promise<VariableSkeleton>
    Copy

• readVariable:function

  • readVariable(variableId: string, noDecode?: boolean): Promise<VariableSkeleton>

  • Read variable by id/name

    Parameters

    • variableId: string

      variable id/name
    • Optional noDecode: boolean

      Do not decode value (default: false)

    Returns Promise<VariableSkeleton>

    a promise that resolves to a variable object

• readVariables:function

  • readVariables(noDecode?: boolean): Promise<VariableSkeleton[]>

  • Read all variables

    Parameters

    • Optional noDecode: boolean

      Do not decode values (default: false)

    Returns Promise<VariableSkeleton[]>

    a promise that resolves to an array of variable objects

• setVariableDescription:function

  • setVariableDescription(variableId: string, description: string): Promise<any>

  • Set variable description

    Parameters

    • variableId: string

      variable id/name
    • description: string

      variable description

    Returns Promise<any>

    a promise that resolves to an empty string

    Deprecated

    since v2.0.0 use updateVariableDescription instead

    updateVariableDescription(variableId: string, description: string): Promise<any>
    Copy

• updateVariable:function

  • updateVariable(variableId: string, value: string, description: string, expressionType?: VariableExpressionType, noEncode?: boolean): Promise<VariableSkeleton>

  • Update or create variable

    Parameters

    • variableId: string

      variable id/name
    • value: string

      variable value
    • description: string

      variable description
    • Optional expressionType: VariableExpressionType

      type of the value
    • Optional noEncode: boolean

      do not encode if passing a pre-encoded (base64) value

    Returns Promise<VariableSkeleton>

    a promise that resolves to a variable object

• updateVariableDescription:function

  • updateVariableDescription(variableId: string, description: string): Promise<VariableSkeleton>

  • Update variable description

    Parameters

    • variableId: string

      variable id/name
    • description: string

      variable description

    Returns Promise<VariableSkeleton>

    a promise that resolves to a status object