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

This is the action which customers can specify to indicate that the server call agent should play/tts out prompt(s). More...

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

Public Member Functions

 PlayPrompt ()
 
override void Validate ()
 

Properties

string Action [get, set]
 The type of action. Various concrete action classes specify their name. This is used to deserialize a list of actions from JSON to their respective concrete classes. More...
 
bool IsStandaloneAction [get]
 Flag to indicate whether this action must not be specified along with any other actions. More...
 
string OperationId [get, set]
 An operation Id needs to be specified by customer so that they can correlate outcome to the action. This becomes necessary when multiple actions are specified in one response body More...
 
IEnumerable< PromptPrompts [get, set]
 List of prompts to play out More...
 

Detailed Description

This is the action which customers can specify to indicate that the server call agent should play/tts out prompt(s).

Definition at line 10 of file PlayPrompt.cs.

Constructor & Destructor Documentation

Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.PlayPrompt.PlayPrompt ( )
inline

Definition at line 18 of file PlayPrompt.cs.

Member Function Documentation

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

Reimplemented from Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.ActionBase.

Definition at line 23 of file PlayPrompt.cs.

Property Documentation

string Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.ActionBase.Action
getsetinherited

The type of action. Various concrete action classes specify their name. This is used to deserialize a list of actions from JSON to their respective concrete classes.

Definition at line 40 of file ActionBase.cs.

bool Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.ActionBase.IsStandaloneAction
getinherited

Flag to indicate whether this action must not be specified along with any other actions.

Definition at line 46 of file ActionBase.cs.

string Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.ActionBase.OperationId
getsetinherited

An operation Id needs to be specified by customer so that they can correlate outcome to the action. This becomes necessary when multiple actions are specified in one response body

Note: this is the first serialized field since it has the lowest order. By default Json.net starts ordering from -1.

Definition at line 33 of file ActionBase.cs.

IEnumerable<Prompt> Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.PlayPrompt.Prompts
getset

List of prompts to play out

Definition at line 16 of file PlayPrompt.cs.


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