siteKiosk.content.runtime

Methods

deleteCollectionDataRow deleteVariable getCollectionDataRow getIsRtl getSwitchValue getVariableDescription getVariableValue getVariables onVariableValueChanged setCollectionDataRow setCurrentLanguage setSwitchValue setVariableDescription setVariableValue setVariables

Methods

deleteCollectionDataRow

  • Delete a collection data row.

    Parameters

    • collectionId: string

      The collection ID to be deleted from.

    • compareFieldIndex: number

      The field index to be searched for.

    • compareFieldValue: any

      The field value to be searched for.

    Returns void

deleteVariable

  • Removes a variable from the __variables collection.

    Parameters

    • variableName: string

      The name of the variable to be deleted

    Returns void

getCollectionDataRow

  • Returns a collection data row found by the given parameters.

    Parameters

    • collectionId: string

      The collection ID to get the data row from.

    • compareFieldIndex: number

      The field index to be searched for.

    • compareFieldValue: any

      The field value to be searched for.

    Returns any

getIsRtl

  • Whether the UI is set Right To Left.

    Returns boolean

getSwitchValue

  • Returns the value of a switch found by its name.

    Parameters

    • switchName: string

      The switch name to get the value from.

    Returns boolean

getVariableDescription

  • Returns the variable type and initial value in the __variables collection found by its name.

    Parameters

    • variableName: string

      The variable name to get

    Returns {
        options?: string;
        type: VariableType;
        value: VariableValue;
    }

    • Optional options?: string
    • type: VariableType
    • value: VariableValue

getVariableValue

  • Returns the value of a variable found by its name.

    Parameters

    • variableName: string

      The variable name to get the value from.

    Returns any

getVariables

  • Returns all variables stored in the "__variables" collection

    Returns any

onVariableValueChanged

  • Registers a callback to be called when a variable changes.

    Returns

    A function to remove the callback.

    Parameters

    • variableName: string

      The variable name to watch for changes.

    • callback: ((value: any) => void)

      The callback to be called when the variable changes.

        • (value: any): void

        • Parameters

          • value: any

          Returns void

    Returns EventSubscription

setCollectionDataRow

  • Adds or updates a collection data row.

    Parameters

    • collectionId: string

      The collection ID to set the data row for.

    • compareFieldIndex: number

      The field index to be searched for.

    • compareFieldValue: any

      The field value to be searched for.

    • rowFields: any[]

      The data row to be set.

    Returns void

setCurrentLanguage

  • Sets the current language using a language code.

    Parameters

    • lang: string

      The language code

    Returns void

setSwitchValue

  • Sets or updates the variable of a switch found by its name.

    Parameters

    • switchName: string

      The switch name to set the value for.

    • newValue: boolean

      The value to be set.

    Returns void

setVariableDescription

  • Adds or updates a variable description.

    Parameters

    • variableName: string

      The name of the variable to be updated or added

    • variableInitialValue: string | number | boolean

      The starting value of the variable

    • variableType: "number" | "option" | "switch" | "text"

      The type of the variable: can be "text", "number", "switch" or "option"

    • Optional variableOptions: string
    • Optional newVariableName: string

      The new name of the variable in case it should be renamed

    Returns void

setVariableValue

  • Sets or updates a variable.

    Parameters

    • variableName: string

      The variable name to set the value for.

    • newValue: any

      The value to be set.

    Returns void

setVariables

  • Sets all variables in the __variables collection to the provided values.

    Parameters

    • variables: [VariableDescription]

    Returns void

Generated using TypeDoc