Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Workflow Class Reference

This class contains the workflow the customer sent for the OnInComingCall POST or any subsequent POST to their callback url. Basically this workflow defines the set of actions, the customer wants us to perform and then callback to them. More...

Public Member Functions

void Validate ()
 

Properties

IEnumerable< ActionBaseActions [get, set]
 List of actions to perform . ex : playPrompt, record, hangup More...
 
string AppState [get, set]
 Opaque string to facilitate app developers to pass their custom data in this field. This field is echo'd back in the 'result' POST for this 'workflow'. More...
 
CallbackLink Links [get, set]
 Callback link to call back the customer on, once we have performed the set of actions. More...
 
IEnumerable< NotificationTypeNotificationSubscriptions [get, set]
 This element indicates that application wants to receive notification updates. Call state notifications are added to this list by default and cannot be unsubscribed to. Subscriptions to rosterUpdate are only used for multiParty calls. More...
 

Detailed Description

This class contains the workflow the customer sent for the OnInComingCall POST or any subsequent POST to their callback url. Basically this workflow defines the set of actions, the customer wants us to perform and then callback to them.

Definition at line 14 of file Workflow.cs.

Member Function Documentation

void Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Workflow.Validate ( )
inline

Definition at line 56 of file Workflow.cs.

Property Documentation

IEnumerable<ActionBase> Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Workflow.Actions
getset

List of actions to perform . ex : playPrompt, record, hangup

Definition at line 39 of file Workflow.cs.

string Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Workflow.AppState
getset

Opaque string to facilitate app developers to pass their custom data in this field. This field is echo'd back in the 'result' POST for this 'workflow'.

Definition at line 46 of file Workflow.cs.

CallbackLink Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Workflow.Links
getset

Callback link to call back the customer on, once we have performed the set of actions.

Note : a. We would always return the outcome : i. of the last operation if all operations were performed successfully OR ii. outcome of first failed operation b. If any operation fails, then we immediately callback the customer webservice with the outcome, and skip processing other operations defined in the "actions" list. c. If no callback link is provided, then we keep performing all specified operations, until i. we hit the end - then we hangup (if call connected to server call agent) ii. We hit a failure - then we hangup (if call connected to server call agent) iii. We hit a max call duration timeout - then we hangup (if call connected to server call agent) d. Any validation failure of this workflow object would result in us returning the workflowValidationOutcome object to the customer's callback url and not proceed with any defined actions.

Definition at line 33 of file Workflow.cs.

IEnumerable<NotificationType> Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Workflow.NotificationSubscriptions
getset

This element indicates that application wants to receive notification updates. Call state notifications are added to this list by default and cannot be unsubscribed to. Subscriptions to rosterUpdate are only used for multiParty calls.

Definition at line 54 of file Workflow.cs.


The documentation for this class was generated from the following file: