Microsoft.Bot.Schema Namespace

Classes

AadResourceUrls

A collection of Azure Active Directory resource URLs

ActionTypes

Defines values for ActionTypes.

Activity

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

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.

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

CardAction

A clickable action

CardImage

An image on a card

ChannelAccount

Channel account information needed to route a message

ContactRelationUpdateActionTypes

Defines values for ContactRelationUpdateActionTypes.

ConversationAccount

Channel account information for a conversation

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

Object of schema.org types

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.

Extensions

Extension methods for converting strongly typed Card objects to Attachement

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")

HeroCard

HeroCard ContentType value

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.

SemanticAction

Represents a reference to a programmatic action

SigninCard

SigninCard ContentType value

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

TokenExchangeState

State object passed to the bot token service.

TokenRequest

A request to receive a user token

TokenResponse

A response that includes a user token

TokenStatus

The status of a particular token

Transcript

Conversation Transcript

VideoCard

VideoCard ContentType value

Interfaces

IActivity

Shared properties for all activities

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

An activity by which a bot can log internal information into a logged conversation transcript.

ITypingActivity

The From address is typing