DialogNode Structure Reference


                    
                    
                    TypeEnum

How the dialog node is processed.

Declaration

Swift

public enum TypeEnum : String


                    
                    
                    EventName

How an event_handler node is processed.

Declaration

Swift

public enum EventName : String


                    
                    
                    DigressIn

Whether this top-level dialog node can be digressed into.

Declaration

Swift

public enum DigressIn : String


                    
                    
                    DigressOut

Whether this dialog node can be returned to after a digression.

Declaration

Swift

public enum DigressOut : String


                    
                    
                    DigressOutSlots

Whether the user can digress to top-level nodes while filling out slots.

Declaration

Swift

public enum DigressOutSlots : String


                    
                    
                    dialogNode

The unique ID of the dialog node. This is an internal identifier used to refer to the dialog node from other dialog nodes and in the diagnostic information included with message responses. This string can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.

Declaration

Swift

public var dialogNode: String


                    
                    
                    description

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters.

Declaration

Swift

public var description: String?


                    
                    
                    conditions

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters.

Declaration

Swift

public var conditions: String?


                    
                    
                    parent

The unique ID of the parent dialog node. This property is omitted if the dialog node has no parent.

Declaration

Swift

public var parent: String?


                    
                    
                    previousSibling

The unique ID of the previous sibling dialog node. This property is omitted if the dialog node has no previous sibling.

Declaration

Swift

public var previousSibling: String?


                    
                    
                    output

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

Declaration

Swift

public var output: DialogNodeOutput?


                    
                    
                    context

The context for the dialog node.

Declaration

Swift

public var context: DialogNodeContext?


                    
                    
                    metadata

The metadata for the dialog node.

Declaration

Swift

public var metadata: [String : JSON]?


                    
                    
                    nextStep

The next step to execute following this dialog node.

Declaration

Swift

public var nextStep: DialogNodeNextStep?


                    
                    
                    title

A human-readable name for the dialog node. If the node is included in disambiguation, this title is used to populate the label property of the corresponding suggestion in the suggestion response type (unless it is overridden by the user_label property). The title is also used to populate the topic property in the connect_to_agent response type. This string can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.

Declaration

Swift

public var title: String?


                    
                    
                    type

How the dialog node is processed.

Declaration

Swift

public var type: String?


                    
                    
                    eventName

How an event_handler node is processed.

Declaration

Swift

public var eventName: String?


                    
                    
                    variable

The location in the dialog context where output is stored.

Declaration

Swift

public var variable: String?


                    
                    
                    actions

An array of objects describing any actions to be invoked by the dialog node.

Declaration

Swift

public var actions: [DialogNodeAction]?


                    
                    
                    digressIn

Whether this top-level dialog node can be digressed into.

Declaration

Swift

public var digressIn: String?


                    
                    
                    digressOut

Whether this dialog node can be returned to after a digression.

Declaration

Swift

public var digressOut: String?


                    
                    
                    digressOutSlots

Whether the user can digress to top-level nodes while filling out slots.

Declaration

Swift

public var digressOutSlots: String?


                    
                    
                    userLabel

A label that can be displayed externally to describe the purpose of the node to users. If set, this label is used to identify the node in disambiguation responses (overriding the value of the title property).

Declaration

Swift

public var userLabel: String?


                    
                    
                    disambiguationOptOut

Whether the dialog node should be excluded from disambiguation suggestions. Valid only when type=standard or frame.

Declaration

Swift

public var disambiguationOptOut: Bool?


                    
                    
                    disabled

For internal use only.

Declaration

Swift

public var disabled: Bool?


                    
                    
                    created

The timestamp for creation of the object.

Declaration

Swift

public var created: Date?


                    
                    
                    updated

The timestamp for the most recent update to the object.

Declaration

Swift

public var updated: Date?


                    
                    
                    init(dialogNode:description:conditions:parent:previousSibling:output:context:metadata:nextStep:title:type:eventName:variable:actions:digressIn:digressOut:digressOutSlots:userLabel:disambiguationOptOut:)

Initialize a DialogNode with member variables.

Declaration

Swift

public init(
    dialogNode: String,
    description: String? = nil,
    conditions: String? = nil,
    parent: String? = nil,
    previousSibling: String? = nil,
    output: DialogNodeOutput? = nil,
    context: DialogNodeContext? = nil,
    metadata: [String: JSON]? = nil,
    nextStep: DialogNodeNextStep? = nil,
    title: String? = nil,
    type: String? = nil,
    eventName: String? = nil,
    variable: String? = nil,
    actions: [DialogNodeAction]? = nil,
    digressIn: String? = nil,
    digressOut: String? = nil,
    digressOutSlots: String? = nil,
    userLabel: String? = nil,
    disambiguationOptOut: Bool? = nil
)

Parameters

`dialogNode`	The unique ID of the dialog node. This is an internal identifier used to refer to the dialog node from other dialog nodes and in the diagnostic information included with message responses. This string can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
`description`	The description of the dialog node. This string cannot contain carriage return, newline, or tab characters.
`conditions`	The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters.
`parent`	The unique ID of the parent dialog node. This property is omitted if the dialog node has no parent.
`previousSibling`	The unique ID of the previous sibling dialog node. This property is omitted if the dialog node has no previous sibling.
`output`	The output of the dialog node. For more information about how to specify dialog node output, see the documentation.
`context`	The context for the dialog node.
`metadata`	The metadata for the dialog node.
`nextStep`	The next step to execute following this dialog node.
`title`	A human-readable name for the dialog node. If the node is included in disambiguation, this title is used to populate the label property of the corresponding suggestion in the `suggestion` response type (unless it is overridden by the user_label property). The title is also used to populate the topic property in the `connect_to_agent` response type. This string can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
`type`	How the dialog node is processed.
`eventName`	How an `event_handler` node is processed.
`variable`	The location in the dialog context where output is stored.
`actions`	An array of objects describing any actions to be invoked by the dialog node.
`digressIn`	Whether this top-level dialog node can be digressed into.
`digressOut`	Whether this dialog node can be returned to after a digression.
`digressOutSlots`	Whether the user can digress to top-level nodes while filling out slots.
`userLabel`	A label that can be displayed externally to describe the purpose of the node to users. If set, this label is used to identify the node in disambiguation responses (overriding the value of the title property).
`disambiguationOptOut`	Whether the dialog node should be excluded from disambiguation suggestions. Valid only when type=`standard` or `frame`.

Return Value

An initialized DialogNode.