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

Namespace for utilities and helpers in the Microsoft Bot Builder Calling SDK. More...

Classes

class  ApplicationState
 
class  JSONConstants
 
class  JsonCreationConverter
 Helper class to use for deserializing where the concrete classes are determined by checking properties in the JSON data. More...
 
class  MaxValues
 
class  MinValues
 
class  MultiPartConstants
 
class  Serializer
 Helper class for serializing/deserializing More...
 
class  StringEnumConverterWithDefault
 Specialized StringEnumConverter that returns the default enum value instead of throwing if the string cannot be matched to an enum value during deserialization. More...
 
class  Utils
 Utils class More...
 

Enumerations

enum  CallState {
  CallState.Unknown, CallState.Idle, CallState.Incoming, CallState.Establishing,
  CallState.Established, CallState.Hold, CallState.Unhold, CallState.Transferring,
  CallState.Redirecting, CallState.Terminating, CallState.Terminated
}
 The various possible states of a AudioVideoCall. More...
 
enum  Culture { Culture.Unknown, Culture.EnUs }
 Cultures we support for recognition or prompt playing More...
 
enum  DigitCollectionCompletionReason {
  DigitCollectionCompletionReason.Unknown, DigitCollectionCompletionReason.InitialSilenceTimeout, DigitCollectionCompletionReason.InterdigitTimeout, DigitCollectionCompletionReason.CompletedStopToneDetected,
  DigitCollectionCompletionReason.CallTerminated, DigitCollectionCompletionReason.TemporarySystemFailure
}
 Reason for completion of Digit Collection Operation More...
 
enum  ModalityType { ModalityType.Unknown, ModalityType.Audio, ModalityType.Video, ModalityType.VideoBasedScreenSharing }
 List of supported modality types More...
 
enum  Outcome { Outcome.Success, Outcome.Failure }
 Possible outcomes More...
 
enum  RecognitionCompletionReason {
  RecognitionCompletionReason.Unknown, RecognitionCompletionReason.InitialSilenceTimeout, RecognitionCompletionReason.IncorrectDtmf, RecognitionCompletionReason.InterdigitTimeout,
  RecognitionCompletionReason.SpeechOptionMatched, RecognitionCompletionReason.DtmfOptionMatched, RecognitionCompletionReason.CallTerminated, RecognitionCompletionReason.TemporarySystemFailure
}
 Reason for completion of Recognition(speech/dtmf) Operation More...
 
enum  RecordingCompletionReason {
  RecordingCompletionReason.Unknown, RecordingCompletionReason.InitialSilenceTimeout, RecordingCompletionReason.MaxRecordingTimeout, RecordingCompletionReason.CompletedSilenceDetected,
  RecordingCompletionReason.CompletedStopToneDetected, RecordingCompletionReason.CallTerminated, RecordingCompletionReason.TemporarySystemFailure
}
 Reason for completion of Recording Operation More...
 
enum  RecordingFormat { RecordingFormat.Unknown, RecordingFormat.Wma, RecordingFormat.Wav, RecordingFormat.Mp3 }
 Encoding format to be used for recording More...
 
enum  ResolutionFormat {
  ResolutionFormat.Unknown, ResolutionFormat.Sd360p, ResolutionFormat.Sd540p, ResolutionFormat.Hd720p,
  ResolutionFormat.Hd1080p
}
 List of supported video resolution formats More...
 
enum  SayAs {
  SayAs.Unknown, SayAs.YearMonthDay, SayAs.MonthDayYear, SayAs.DayMonthYear,
  SayAs.YearMonth, SayAs.MonthYear, SayAs.MonthDay, SayAs.DayMonth,
  SayAs.Day, SayAs.Month, SayAs.Year, SayAs.Cardinal,
  SayAs.Ordinal, SayAs.Letters, SayAs.Time12, SayAs.Time24,
  SayAs.Telephone, SayAs.Name, SayAs.PhoneticName
}
 Difference SayAs attributes we support for tts More...
 
enum  VoiceGender { VoiceGender.Male, VoiceGender.Female }
 Voice genders we support for tts More...
 

Detailed Description

Namespace for utilities and helpers in the Microsoft Bot Builder Calling SDK.

Enumeration Type Documentation

The various possible states of a AudioVideoCall.

Enumerator
Unknown 

Unknown not recognized.

Idle 

Initial state

Incoming 

The call has just been received

Establishing 

The call establishment is in progress after initiating or accepting the call

Established 

The call is established

Hold 

The call is on Hold

Unhold 

The call is Unhold

Transferring 

The call has initiated a transfer

Redirecting 

The call has initiated a redirection

Terminating 

The call is terminating

Terminated 

The call has terminated

Definition at line 8 of file CallState.cs.

Cultures we support for recognition or prompt playing

Enumerator
Unknown 

Unknown not recognized.

EnUs 

Definition at line 10 of file Culture.cs.

Reason for completion of Digit Collection Operation

Enumerator
Unknown 

Unknown not recognized.

InitialSilenceTimeout 

The max time period by which user is supposed to start punching in digits has elapsed.

This results in a "failed" DigitCollection Attempt

InterdigitTimeout 

The maximum time period between user punching in successive digits has elapsed.

This results in a "successful" DigitCollection Attempt and we return the digits collected till then.

CompletedStopToneDetected 

Digit collection attempt was stopped by user punching in a stop tone.

This results in a "successful" DigitCollection Attempt and we return the digits collected till then. The stopTone(s) detected are excluded from the digits we return.

CallTerminated 

The underlying call was terminated

This results in a "failed" DigitCollection Attempt

TemporarySystemFailure 

Misc System Failure

Definition at line 9 of file DigitCollectionCompletionReason.cs.

List of supported modality types

Enumerator
Unknown 
Audio 
Video 
VideoBasedScreenSharing 

Definition at line 9 of file ModalityType.cs.

Possible outcomes

Enumerator
Success 

Success

Failure 

Failure

Definition at line 9 of file Outcome.cs.

Reason for completion of Recognition(speech/dtmf) Operation

Enumerator
Unknown 

Unknown not recognized.

InitialSilenceTimeout 

The maximum initial silence that can be tolerated had been reached

This results in a "failed" Recognition Attempt

IncorrectDtmf 

The Recognition completed because the user punched in wrong dtmf which was not amongst the possible choices.

We would only look for dtmfs when dtmf recognition is requested. Thus for pure speech menus, this completion reason would never be possible.

This results in a "failed" Recognition Attempt

InterdigitTimeout 

The maximum time period between user punching in successive digits has elapsed.

We would only look for dtmfs when dtmf recognition is requested. Thus for pure speech menus, this completion reason would never be possible.

This results in a "failed" Recognition Attempt.

SpeechOptionMatched 

The recognition successfully matched a Grammar option

DtmfOptionMatched 

The recognition successfully matched a Dtmf option

CallTerminated 

The underlying call was terminated

This results in a "failed" Recognition Attempt

TemporarySystemFailure 

Misc System Failure

Definition at line 9 of file RecognitionCompletionReason.cs.

Reason for completion of Recording Operation

Enumerator
Unknown 

Unknown not recognized.

InitialSilenceTimeout 

The maximum initial silence that can be tolerated had been reached

This results in a "failed" Recording Attempt

MaxRecordingTimeout 

The maximum duration that can be allowed for recording had been reached

This results in a "successful" Recording Attempt

CompletedSilenceDetected 

Recording was completed as detected by silence after a talk spurt

This results in a "successful" Recording Attempt

CompletedStopToneDetected 

Recording was completed by user punching in a stop tone

This results in a "successful" Recording Attempt

CallTerminated 

The underlying call was terminated

This results in a "successful" Recording Attempt if there were any bytes recorded

TemporarySystemFailure 

Misc System Failure

Definition at line 9 of file RecordingCompletionReason.cs.

Encoding format to be used for recording

Enumerator
Unknown 

Unknown not recognized.

Wma 

WMA

Wav 

WAV

Mp3 

MP3

Definition at line 9 of file RecordingFormat.cs.

List of supported video resolution formats

Enumerator
Unknown 

Unknown not recognized.

Sd360p 
Sd540p 
Hd720p 
Hd1080p 

Definition at line 10 of file ResolutionFormat.cs.

Difference SayAs attributes we support for tts

Enumerator
Unknown 

Unknown not recognized.

YearMonthDay 
MonthDayYear 
DayMonthYear 
YearMonth 
MonthYear 
MonthDay 
DayMonth 
Day 
Month 
Year 
Cardinal 
Ordinal 
Letters 
Time12 
Time24 
Telephone 
Name 
PhoneticName 

Definition at line 9 of file SayAs.cs.

Voice genders we support for tts

Enumerator
Male 
Female 

Definition at line 9 of file VoiceGender.cs.