Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UpdateDialogNodeParams

Parameters for the updateDialogNode operation.

Hierarchy

  • UpdateDialogNodeParams

Index

Properties

dialogNode

dialogNode: string

The dialog node ID (for example, get_order).

Optional headers

headers: OutgoingHttpHeaders

Optional includeAudit

includeAudit: boolean

Whether to include the audit properties (created and updated timestamps) in the response.

Optional newActions

newActions: DialogNodeAction[]

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

Optional newConditions

newConditions: string

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

Optional newContext

newContext: JsonObject

The context for the dialog node.

Optional newDescription

newDescription: string

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

Optional newDialogNode

newDialogNode: string

The dialog node ID. This string must conform to the following restrictions:

  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.

Optional newDigressIn

newDigressIn: DigressIn | string

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

Optional newDigressOut

newDigressOut: DigressOut | string

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

Optional newDigressOutSlots

newDigressOutSlots: DigressOutSlots | string

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

Optional newDisambiguationOptOut

newDisambiguationOptOut: boolean

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

Optional newEventName

newEventName: EventName | string

How an event_handler node is processed.

Optional newMetadata

newMetadata: JsonObject

The metadata for the dialog node.

Optional newNextStep

newNextStep: DialogNodeNextStep

The next step to execute following this dialog node.

Optional newOutput

newOutput: DialogNodeOutput

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

Optional newParent

newParent: string

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

Optional newPreviousSibling

newPreviousSibling: string

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

Optional newTitle

newTitle: string

The alias used to identify the dialog node. This string must conform to the following restrictions:

  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.

Optional newType

newType: Type | string

How the dialog node is processed.

Optional newUserLabel

newUserLabel: string

A label that can be displayed externally to describe the purpose of the node to users.

Optional newVariable

newVariable: string

The location in the dialog context where output is stored.

workspaceId

workspaceId: string

Unique identifier of the workspace.

Generated using TypeDoc