Microsoft.Bot.Schema Namespace

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.

Defines values for ActionTypes.

An Activity is the basic communication type for the Bot Framework 3.0 protocol.

Define values for common event names used by activities of type Event.

Helper functions for Message Activities.

Defines values for ActivityImportance.

Defines values for ActivityTypes.

Additional values for ActivityTypes beyond the auto-generated ActivityTypes class.

An animation card (Ex: gif or short video clip)

An attachment within an activity

Attachment data

Metadata for an attachment

Defines values for AttachmentLayoutTypes.

Attachment View name and size

Audio card

A basic card

Constants used to populate the CallerId property.

A clickable action

An image on a card

Channel account information needed to route a message

Defines values for ContactRelationUpdateActionTypes.

Conversation account represents the identity of the conversation within a channel

Conversation and its members

Parameters for creating a new conversation

An object relating to a particular point in a conversation

A response containing a resource

Conversations result

Defines values for DeliveryModes.

Defines values for EndOfConversationCodes.

Metadata object pertaining to an activity

Object representing error information

Error codes to communicate when throwing an APIException.

An HTTP API response

Exception thrown for an invalid response with ErrorResponse information.

Replies in response to ExpectReplies

Extension methods for converting strongly typed Card objects to Attachment.

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 (entity type: "https://schema.org/GeoCoordinates")

Defines values for handoff event names.

Defines the structure that is returned as the result of a health check on the bot. The health check is sent to the bot as an Activity of type "invoke" and this class along with HealthResults defines the structure of the body of the response. The name of the invoke Activity is "healthCheck".

Defines the structure that is returned as the result of a health check on the bot. The health check is sent to the bot as an InvokeActivity and this class along with HealthCheckResponse defines the structure of the body of the response.

HeroCard ContentType value.

Provides additional methods to work with IActivity.

Object representing inner http error

Defines values for InputHints.

Defines values for InstallationUpdateActionTypes.

Media card

Supplementary parameter for media events

Media URL

Mention information (entity type: "mention")

Message reaction object

Defines values for MessageReactionTypes.

W3C Payment Method Data for Microsoft Pay

OAuthCard ContentType value.

Page of members.

Address within a Payment Request

Supplies monetary amounts

Provides information about the requested transaction

Provides details that modify the PaymentDetails based on payment method identifier

Indicates what the payment request is for and the value asked for

Indicates a set of supported payment methods and any associated payment method specific data for those methods

Names for invocable operations in the payment callback protocol.

Provides information about the options desired for the payment request

A request to make a payment

Payload delivered when completing a payment request

Result from a completed payment request

An update to a payment request

A result object from a Payment Request Update invoke operation

A PaymentResponse is returned when a user has selected a payment method and approved a payment request

Describes a shipping option

Different shipping types. See http://www.w3.org/TR/payment-request/#dom-paymentoptions-shippingtype for more information.

Place (entity type: "https://schema.org/Place")

ReceiptCard ContentType value.

An item on a receipt card

A response containing a resource ID

Defines values for RoleTypes.

Represents a reference to a programmatic action

Indicates whether the semantic action is starting, continuing, or done.

SigninCard ContentType value.

Names for signin invoke operations in the token protocol.

A type containing information for single sign-on.

Defines constants that can be used in the processing of speech interactions.

SuggestedActions that can be performed

Defines values for TextFormatTypes.

Refers to a substring of content within another field

Thing (entity type: "https://schema.org/Thing")

ThumbnailCard ContentType value.

Thumbnail URL

A request to exchange a token.

The response object of a token exchange invoke.

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.

Response schema sent back from Bot Framework Token Service required to initiate a user single sign on.

State object passed to the bot token service.

Helps provide polling for token details.

A request to receive a user token

Response schema sent back from Bot Framework Token Service, in response to a request to get or exchange a token for a user.

The status of a particular token

Transcript

VideoCard ContentType value.

Shared properties for all activities.

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.

The referenced conversation has been updated.

Conversation is ending, or a request to end the conversation.

Asynchronous external event.

Control of the conversation has been transferred, or a request to transfer control of the conversation.

A bot was installed or removed from a channel.

Synchronous request to invoke an operation.

A message in a conversation.

Represents a request to delete a previous message activity in a conversation.

A reaction to a Message Activity.

Represents a request to update a previous message activity in a conversation.

Represents a private suggestion to the Recipient about another activity.

Represents a point in a bot's logic, to help with bot debugging.

The From address is typing.