IWorkflow interface

Package:

botbuilder-calling

IWorkflow is a JSON body send by the bot in response to IConversation or IConversationResult request from Skype Bot Platform for Calling. IWorkflow contains list of one or more actions that bots instructs Skype Bot Platform for Calling on execute on its behalf as well as callback HTTPs address if bot wants to be notified about result of last executed action outcome.

Extends

IEvent

Properties

actions	A list of one or more actions that a bot wants to execute on call.
address	Address routing information for the event. Save this field to external storage somewhere to later compose a proactive message to the user.
agent	SDK thats processing the event. Will always be 'botbuilder'.
links	A callback link that will be used once the workflow is executed to reply with outcome of workflow.
notificationSubscriptions	This field indicates that application wants to receive notification updates. Call state change notification is added to this list by default and cannot be unsubscribed.
source	The original source of the event (i.e. 'facebook', 'skype', 'slack', etc.)
sourceEvent	The original event in the sources native schema. For outgoing messages can be used to pass source specific event data like custom attachments.
type	Defines type of event. Should be 'message' for an IEvent.
user	For incoming event this is the user that sent the event. By default this is a copy of address.user but you can configure your bot with a lookupUser function that lets map the incoming user to an internal user id.

Property Details

actions

A list of one or more actions that a bot wants to execute on call.

actions: IAction[]

Property Value

IAction[]

address

Address routing information for the event. Save this field to external storage somewhere to later compose a proactive message to the user.

address: IAddress

Property Value

IAddress

agent

SDK thats processing the event. Will always be 'botbuilder'.

agent: string

Property Value

string

links

A callback link that will be used once the workflow is executed to reply with outcome of workflow.

links?: any

Property Value

any

notificationSubscriptions

This field indicates that application wants to receive notification updates. Call state change notification is added to this list by default and cannot be unsubscribed.

notificationSubscriptions?: string[]

Property Value

string[]

source

The original source of the event (i.e. 'facebook', 'skype', 'slack', etc.)

source: string

Property Value

string

sourceEvent

The original event in the sources native schema. For outgoing messages can be used to pass source specific event data like custom attachments.

sourceEvent: any

Property Value

any

type

Defines type of event. Should be 'message' for an IEvent.

type: string

Property Value

string

user

For incoming event this is the user that sent the event. By default this is a copy of address.user but you can configure your bot with a lookupUser function that lets map the incoming user to an internal user id.

user: IIdentity

Property Value

IIdentity