Microsoft.Bot.Schema Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
AadResourceUrls |
Schema of the target resource for which the Bot Framework Token Service would exchange a cached token for a user. This class applies only to AAD V1 connections. |
ActionTypes |
Defines values for ActionTypes. |
Activity |
An Activity is the basic communication type for the Bot Framework 3.0 protocol. |
ActivityEventNames |
Define values for common event names used by activities of type Event. |
ActivityExtensions |
Helper functions for Message Activities. |
ActivityImportance |
Defines values for ActivityImportance. |
ActivityTypes |
Defines values for ActivityTypes. |
ActivityTypesEx |
Additional values for ActivityTypes beyond the auto-generated ActivityTypes class. |
AdaptiveCardAuthentication |
Defines the structure that arrives in the Activity.Value.Authentication for Invoke activity with Name of 'adaptiveCard/action'. |
AdaptiveCardInvokeAction |
Defines the structure that arrives in the Activity.Value.Action for Invoke activity with Name of 'adaptiveCard/action'. |
AdaptiveCardInvokeResponse |
Defines the structure that is returned as the result of an Invoke activity with Name of 'adaptiveCard/action'. |
AdaptiveCardInvokeValue |
Defines the structure that arrives in the Activity.Value for Invoke activity with Name of 'adaptiveCard/action'. |
AnimationCard |
An animation card (Ex: gif or short video clip). |
Attachment |
An attachment within an activity. |
AttachmentData |
Attachment data. |
AttachmentInfo |
Metadata for an attachment. |
AttachmentLayoutTypes |
Defines values for AttachmentLayoutTypes. |
AttachmentView |
Attachment View name and size. |
AudioCard |
Audio card. |
BasicCard |
A basic card. |
CallerIdConstants |
Constants used to populate the CallerId property. |
CardAction |
A clickable action. |
CardImage |
An image on a card. |
ChannelAccount |
Channel account information needed to route a message. |
CommandResultValue<T> |
The value field of a ICommandResultActivity contains metadata related to a command result. An optional extensible data payload may be included if defined by the command result activity name. The presence of an error field indicates that the original command failed to complete. |
CommandValue<T> |
The value field of a ICommandActivity contains metadata related to a command. An optional extensible data payload may be included if defined by the command activity name. |
ContactRelationUpdateActionTypes |
Defines values for ContactRelationUpdateActionTypes. |
ConversationAccount |
Conversation account represents the identity of the conversation within a channel. |
ConversationMembers |
Conversation and its members. |
ConversationParameters |
Parameters for creating a new conversation. |
ConversationReference |
An object relating to a particular point in a conversation. |
ConversationResourceResponse |
A response containing a resource. |
ConversationsResult |
Conversations result. |
DeliveryModes |
Defines values for DeliveryModes. |
EndOfConversationCodes |
Defines values for EndOfConversationCodes. |
Entity |
Metadata object pertaining to an activity. |
Error |
Object representing error information. |
ErrorCodes |
Error codes to communicate when throwing an APIException. |
ErrorResponse |
An HTTP API response. |
ErrorResponseException |
Exception thrown for an invalid response with ErrorResponse information. |
ExpectedReplies |
Replies in response to ExpectReplies. |
Extensions |
Extension methods for converting strongly typed Card objects to Attachment. |
Fact |
Set of key-value pairs. Advantage of this section is that key and value properties will be rendered with default style information with some delimiter between them. So there is no need for developer to specify style information. |
GeoCoordinates |
GeoCoordinates (entity type: "https://schema.org/GeoCoordinates"). |
HandoffEventNames |
Defines values for handoff event names. |
HeroCard |
HeroCard ContentType value. |
IActivityExtensions |
Provides additional methods to work with IActivity. |
InnerHttpError |
Object representing inner http error. |
InputHints |
Defines values for InputHints. |
InstallationUpdateActionTypes |
Defines values for InstallationUpdateActionTypes. |
MediaCard |
Media card. |
MediaEventValue |
Supplementary parameter for media events. |
MediaUrl |
Media URL. |
Mention |
Mention information (entity type: "mention"). |
MessageReaction |
Message reaction object. |
MessageReactionTypes |
Defines values for MessageReactionTypes. |
MicrosoftPayMethodData |
W3C Payment Method Data for Microsoft Pay. |
OAuthCard |
OAuthCard ContentType value. |
PagedMembersResult |
Page of members. |
PaymentAddress |
Address within a Payment Request. |
PaymentCurrencyAmount |
Supplies monetary amounts. |
PaymentDetails |
Provides information about the requested transaction. |
PaymentDetailsModifier |
Provides details that modify the PaymentDetails based on payment method identifier. |
PaymentItem |
Indicates what the payment request is for and the value asked for. |
PaymentMethodData |
Indicates a set of supported payment methods and any associated payment method specific data for those methods. |
PaymentOperations |
Names for invocable operations in the payment callback protocol. |
PaymentOptions |
Provides information about the options desired for the payment request. |
PaymentRequest |
A request to make a payment. |
PaymentRequestComplete |
Payload delivered when completing a payment request. |
PaymentRequestCompleteResult |
Result from a completed payment request. |
PaymentRequestUpdate |
An update to a payment request. |
PaymentRequestUpdateResult |
A result object from a Payment Request Update invoke operation. |
PaymentResponse |
A PaymentResponse is returned when a user has selected a payment method and approved a payment request. |
PaymentShippingOption |
Describes a shipping option. |
PaymentShippingTypes |
Different shipping types. See http://www.w3.org/TR/payment-request/#dom-paymentoptions-shippingtype for more information. |
Place |
Place (entity type: "https://schema.org/Place"). |
ReceiptCard |
ReceiptCard ContentType value. |
ReceiptItem |
An item on a receipt card. |
ResourceResponse |
A response containing a resource ID. |
RoleTypes |
Defines values for RoleTypes. |
SearchInvokeOptions |
Defines the query options in the SearchInvokeValue for Invoke activity with Name of 'application/search'. |
SearchInvokeResponse |
Defines the structure that is returned as the result of an Invoke activity with Name of 'application/search'. |
SearchInvokeTypes |
Defines values for SearchInvokeTypes. See SearchInvokeValue. |
SearchInvokeValue |
Defines the structure that arrives in the Activity.Value for Invoke activity with Name of 'application/search'. |
SemanticAction |
Represents a reference to a programmatic action. |
SemanticActionStates |
Indicates whether the semantic action is starting, continuing, or done. |
SigninCard |
SigninCard ContentType value. |
SignInConstants |
Names for signin invoke operations in the token protocol. |
SignInResource |
A type containing information for single sign-on. |
SpeechConstants |
Defines constants that can be used in the processing of speech interactions. |
SuggestedActions |
SuggestedActions that can be performed. |
TextFormatTypes |
Defines values for TextFormatTypes. |
TextHighlight |
Refers to a substring of content within another field. |
Thing |
Thing (entity type: "https://schema.org/Thing"). |
ThumbnailCard |
ThumbnailCard ContentType value. |
ThumbnailUrl |
Thumbnail URL. |
TokenExchangeInvokeRequest |
A request to exchange a token. |
TokenExchangeInvokeResponse |
The response object of a token exchange invoke. |
TokenExchangeRequest |
Request payload to be sent to the Bot Framework Token Service for Single Sign On. If the URI is set to a custom scope, then Token Service will exchange the token in its cache for a token targeting the custom scope and return it in the response. If a Token is sent in the payload, then Token Service will exchange the token for a token targetting the scopes specified in the corresponding OAauth connection. |
TokenExchangeResource |
Response schema sent back from Bot Framework Token Service required to initiate a user single sign on. |
TokenExchangeState |
State object passed to the bot token service. |
TokenPollingSettings |
Helps provide polling for token details. |
TokenPostResource |
Response schema sent back from Bot Framework Token Service required to initiate a user token direct post. |
TokenRequest |
A request to receive a user token. |
TokenResponse |
Response schema sent back from Bot Framework Token Service, in response to a request to get or exchange a token for a user. |
TokenStatus |
The status of a particular token. |
Transcript |
Transcript. |
VideoCard |
VideoCard ContentType value. |
Interfaces
IActivity |
Shared properties for all activities. |
ICommandActivity |
Asynchronous external command. |
ICommandResultActivity |
Asynchronous external command result. |
IContactRelationUpdateActivity |
A user has added a bot to their contact list, removed the bot from their contact list, or otherwise changed the relationship between user and bot. |
IConversationUpdateActivity |
The referenced conversation has been updated. |
IEndOfConversationActivity |
Conversation is ending, or a request to end the conversation. |
IEventActivity |
Asynchronous external event. |
IHandoffActivity |
Control of the conversation has been transferred, or a request to transfer control of the conversation. |
IInstallationUpdateActivity |
A bot was installed or removed from a channel. |
IInvokeActivity |
Synchronous request to invoke an operation. |
IMessageActivity |
A message in a conversation. |
IMessageDeleteActivity |
Represents a request to delete a previous message activity in a conversation. |
IMessageReactionActivity |
A reaction to a Message Activity. |
IMessageUpdateActivity |
Represents a request to update a previous message activity in a conversation. |
ISuggestionActivity |
Represents a private suggestion to the Recipient about another activity. |
ITraceActivity |
Represents a point in a bot's logic, to help with bot debugging. |
ITypingActivity |
The From address is typing. |