Runtime | SiteKiosk Online API

siteKiosk.content.runtime

Index

Methods

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

Methods

deleteCollectionDataRow

deleteCollectionDataRow(collectionId: string, compareFieldIndex: number, compareFieldValue: any): void
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

deleteVariable(variableName: string): void
Removes a variable from the __variables collection.
Parameters
- variableName: string
  
  The name of the variable to be deleted
Returns void

getCollectionDataRow

getCollectionDataRow(collectionId: string, compareFieldIndex: number, compareFieldValue: any): any
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

getIsRtl(): boolean
Whether the UI is set Right To Left.

Returns boolean

getSwitchValue

getSwitchValue(switchName: string): boolean
Returns the value of a switch found by its name.
Parameters
- switchName: string
  
  The switch name to get the value from.
Returns boolean

getVariableDescription

getVariableDescription(variableName: string): {
    options?: string;
    type: VariableType;
    value: VariableValue;
}
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

getVariableValue(variableName: string): any
Returns the value of a variable found by its name.
Parameters
- variableName: string
  
  The variable name to get the value from.
Returns any

getVariables

getVariables(): any
Returns all variables stored in the "__variables" collection

Returns any

onVariableValueChanged

onVariableValueChanged(variableName: string, callback: ((value: any) => void)): EventSubscription
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

setCollectionDataRow(collectionId: string, compareFieldIndex: number, compareFieldValue: any, rowFields: any[]): void
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

setSwitchValue

setSwitchValue(switchName: string, newValue: boolean): void
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

setVariableDescription(variableName: string, variableInitialValue: string | number | boolean, variableType: "number" | "option" | "switch" | "text", variableOptions?: string, newVariableName?: string): void
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

setVariableValue(variableName: string, newValue: any): void
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

setVariables(variables: [VariableDescription]): void
Sets all variables in the __variables collection to the provided values.
Parameters
- variables: [VariableDescription]
Returns void

siteKiosk.content.runtime

Index

Methods

Methods

deleteCollectionDataRow

Parameters

collectionId: string

compareFieldIndex: number

compareFieldValue: any

Returns void

deleteVariable

Parameters

variableName: string

Returns void

getCollectionDataRow

Parameters

collectionId: string

compareFieldIndex: number

compareFieldValue: any

Returns any

getIsRtl

Returns boolean

getSwitchValue

Parameters

switchName: string

Returns boolean

getVariableDescription

Parameters

variableName: string

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

Optional options?: string

type: VariableType

value: VariableValue

getVariableValue

Parameters

variableName: string

Returns any

getVariables

Returns any

onVariableValueChanged

Returns

Parameters

variableName: string

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

Parameters

value: any

Returns void

Returns EventSubscription

setCollectionDataRow

Parameters

collectionId: string

compareFieldIndex: number

compareFieldValue: any

rowFields: any[]

Returns void

setSwitchValue

Parameters

switchName: string

newValue: boolean

Returns void

setVariableDescription

Parameters

variableName: string

variableInitialValue: string | number | boolean

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

Optional variableOptions: string

Optional newVariableName: string

Returns void

setVariableValue

Parameters

variableName: string

newValue: any

Returns void

setVariables

Parameters

variables: [VariableDescription]

Returns void

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

`Optional` options?: string

`Optional` variableOptions: string

`Optional` newVariableName: string