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

Once we have peformed the "actions" requested by the customer, we POST back to customer callback Url with this "result" object. More...

Inheritance diagram for Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.ConversationResult:

Public Member Functions

override void Validate ()
 

Properties

string AppId [get, set]
 AppId of the customer ( if any ) More...
 
string AppState [get, set]
 Opaque string to facilitate app developers to pass their custom data in this field. This field is the same value that was passed 'response' by the customer. More...
 
CallState CallState [get, set]
 Current state of the Call More...
 
string Id [get, set]
 Conversation Id More...
 
Dictionary< string, Uri > Links [get, set]
 Any links we want to surface to the customer for them to invoke us back on. More...
 
OperationOutcomeBase OperationOutcome [get, set]
 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 response object would result in us returning the WorkflowValidationOutcome object to the customer's callback url and not proceed with any defined actions. More...
 

Detailed Description

Once we have peformed the "actions" requested by the customer, we POST back to customer callback Url with this "result" object.

Definition at line 10 of file ConversationResult.cs.

Member Function Documentation

override void Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.ConversationResult.Validate ( )
inlinevirtual

Property Documentation

string Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.ConversationBase.AppId
getsetinherited

AppId of the customer ( if any )

Definition at line 26 of file ConversationBase.cs.

string Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.ConversationBase.AppState
getsetinherited

Opaque string to facilitate app developers to pass their custom data in this field. This field is the same value that was passed 'response' by the customer.

Definition at line 33 of file ConversationBase.cs.

CallState Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.ConversationResult.CallState
getset

Current state of the Call

Definition at line 32 of file ConversationResult.cs.

string Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.ConversationBase.Id
getsetinherited

Conversation Id

Definition at line 20 of file ConversationBase.cs.

Dictionary<string, Uri> Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.ConversationBase.Links
getsetinherited

Any links we want to surface to the customer for them to invoke us back on.

Definition at line 39 of file ConversationBase.cs.

OperationOutcomeBase Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.ConversationResult.OperationOutcome
getset

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 response 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 26 of file ConversationResult.cs.


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