Declared in Voiceflow.schema.json

Overview

Field name/value pairs for the STVoiceFlow framework to create or update while processing a "process" type Voiceflow Module.

Note: Unless stated otherwise, value of properties that are of type "string" can be updated at runtime by an application if their value is entered as a field name wrapped by "$[" and "]". If a property is of a type other than "string", then an additional property of type "string" with the same property name appended with the string "Runtime" is added to have its value entered as a field name wrapped by "$[" and "]". This allows the application to set the value of the field name at runtime to be the value of the original non-runtime property. Valid values of runtime fields override the values of non-runtime properties.

Properties

  •   name

    Field name. Name of field is always enclosed with "$[" at beginning and with "]" at end. Example: "name": "$[SleepModeReason]".

    Parameter is required.

           json parameter
  •   value

    Value of the field. Example: "value": "UserRequested". The value cannot be set at runtime.

    Parameter is required.

           json parameter

JSON Parameters

name

"name": string

Discussion

Field name. Name of field is always enclosed with "$[" at beginning and with "]" at end. Example: "name": "$[SleepModeReason]".

Parameter is required.

Declared In

Voiceflow.schema.json

value

"value": string

Discussion

Value of the field. Example: "value": "UserRequested". The value cannot be set at runtime.

Parameter is required.

Declared In

Voiceflow.schema.json