Microsoft.Bot.Builder.Calling.ObjectModel.Contracts Namespace Reference

Namespace for contracts used by the Microsoft Bot Builder Calling SDK. More...

Classes

class  ActionBase
 Base class for various actions More...
 
class  ActionConverter
 By default Json.net doesn't know how to deserialize JSON data into Interfaces or abstract classes. This custom Converter helps deserialize "actions" specified in JSON into respective concrete "action" classes. More...
 
class  AgentContactNotification
 Message type for notifying agents that a user has added or removed them. More...
 
class  Answer
 This is the action which customers can specify to indicate that the server call agent should accept the call. The media is hosted by the server call agent More...
 
class  AnswerOutcome
 This is the outcome of the "answer" action. This is conveyed to the customer as POST to the customer CallBack Url. More...
 
class  BaseMessage
 Base message wrapper for all API messages. The format is: { type: (type-of-message), to: (to-user-MRI), from: (from-user-MRI), (optional additional-message-specific-properties), (optional additional-message-specific-properties), (optional additional-message-specific-properties), } More...
 
class  CallbackLink
 
class  CallStateChangeNotification
 This concrete class defines the call state change notification schema. More...
 
class  ChoiceOutcome
 This is a part of the "recognize" action outcome. This is specified if the customer had specified any recognition options. More...
 
class  CollectDigits
 This is part of the "recognize" action. If the customer wants to collect digits - this needs to be specified. Ex: enter 5 digit zip code followed by pound sign. More...
 
class  CollectDigitsOutcome
 This is a part of the "recognize" action outcome. This is specified if the customer had specified any collectDigits operation. More...
 
class  Conversation
 This defines the set of the properties that define a conversation. A conversation includes participants, modalities etc. More...
 
class  ConversationBase
 This base class defines a subset of properties which define a conversation. Conversation class derives from this and adds more properties - they are passed in OnIncomingCall ConversationResultBase class derives from this and adds more properties - they are passed in POST to callback Url to list operation outcomes More...
 
class  ConversationResult
 Once we have peformed the "actions" requested by the customer, we POST back to customer callback Url with this "result" object. More...
 
class  Hangup
 This is the action which customers can specify to indicate that the server call agent should hangup the call. More...
 
class  HangupOutcome
 This is the outcome of the "hangup" action. This is conveyed to the customer as POST to the customer CallBack Url (if specified). More...
 
class  NotificationBase
 This base class defines a subset of properties which define a notification. CallStateNotification and RosterUpdates are examples of Notifications. More...
 
class  NotificationConverter
 By default Json.net doesn't know how to deserialize JSON data into Interfaces or abstract classes. This custom Converter helps deserialize "Notifications" specified in JSON into respective concrete "Notification" classes. More...
 
class  NotificationResponse
 This class contains the response the customer sent for the notification POST to their callback url. More...
 
class  OperationOutcomeBase
 Base class for various "action(s)" outcome(s) More...
 
class  OperationOutcomeConverter
 By default Json.net doesn't know how to deserialize JSON data into Interfaces or abstract classes. This custom Converter helps deserialize "operationOutcomes" specified in JSON into respective concrete "OperationOutcome" classes. More...
 
class  Participant
 This class describes a participant. This can be a participant in any modality in a 2 or multi-party conversation More...
 
class  PlayPrompt
 This is the action which customers can specify to indicate that the server call agent should play/tts out prompt(s). More...
 
class  PlayPromptOutcome
 This is the outcome of the "playPrompt" action. This is conveyed to the customer as POST to the customer CallBack Url. More...
 
class  Prompt
 This class represents a single prompt More...
 
class  RecognitionOption
 This is part of the "recognize" action. If the customer wants to speech/dtmf choice based recognition - this needs to be specified. Ex: say "Sales" or enter 1 for Sales department More...
 
class  Recognize
 This is the action which customers can specify to indicate that the server call agent should perform speech or dtmf recognition. More...
 
class  RecognizeOutcome
 This is the outcome of the "recognize" action. This is conveyed to the customer as POST to the customer CallBack Url. More...
 
class  Record
 This is the action which customers can specify to indicate that the server call agent should start recording user speech. More...
 
class  RecordOutcome
 This is the outcome of the "record" action. This is conveyed to the customer as POST to the customer CallBack Url. More...
 
class  Reject
 This is the action which customers can specify to indicate that the server call agent should reject the call. More...
 
class  RejectOutcome
 This is the outcome of the "reject" action. This is conveyed to the customer as POST to the customer CallBack Url (if specified). More...
 
class  ValidActions
 This is a helper class for validating actions specified by customers More...
 
class  ValidDtmfs
 This is a helper class for validating dtmfs specified in strings More...
 
class  ValidOutcomes
 This is a helper class for validating outcomes. This can be used by customers or by us (before we send the outcome on the wire) More...
 
class  Workflow
 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...
 
class  WorkflowValidationOutcome
 If the customer's "response" fails validation, this is the outcome conveyed to the customer as POST to the customer CallBack Url. More...
 

Enumerations

enum  NotificationType { NotificationType.Unknown, NotificationType.RosterUpdate, NotificationType.CallStateChange }
 List of various notification types More...
 

Detailed Description

Namespace for contracts used by the Microsoft Bot Builder Calling SDK.

Enumeration Type Documentation

List of various notification types

Enumerator
Unknown 

Not recognized notification type.

RosterUpdate 

Roster Update Notification

CallStateChange 

Call State change notification

Definition at line 10 of file NotificationType.cs.