IConversationResult interface

Package:

botbuilder-calling

IConversationResult is a JSON body of any subsequent request following the initial IConversation notification that is send to a bot from Skype Bot Platform for Calling. IConversationResult is posted to a callback link provided by previous Workflow response. IConversationResult represents the result of a last successful action from previous Workflow response.

Extends

IEvent

Properties

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'.
callState	Indicates the current state of the call.
links	Dictionary containing list of HTTPs links.
operationOutcome	Outcome of last executed workflow action.
recordedAudio	Buffer of recorded data for a RecordAction.
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

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

callState

Indicates the current state of the call.

callState: string

Property Value

string

links

Dictionary containing list of HTTPs links.

links?: any

Property Value

any

operationOutcome

Outcome of last executed workflow action.

operationOutcome: IActionOutcome

Property Value

IActionOutcome

recordedAudio

Buffer of recorded data for a RecordAction.

recordedAudio?: any

Property Value

any

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