Microsoft.Agents.Protocols.Primitives Namespace

Classes

AadResourceUrls	The AadResourceUrls.
ActionTypes	Defines values for CardAction Types.
Activity
ActivityEventNames	Define values for common event names used by activities of type Event.
ActivityImportance	Defines values for ActivityImportance.
ActivityTypes	Defines values for ActivityTypes.
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 card action represents a clickable or interactive button for use within cards or as suggested actions. They are used to solicit input from users.Despite their name, card actions are not limited to use solely on cards. Card actions are meaningful only when sent to channels. Channels decide how each action manifests in their user experience.In most cases, the cards are clickable. In others, they may be selected by speech input.In cases where the channel does not offer an interactive activation experience (e.g., when interacting over SMS), the channel may not support activation whatsoever.The decision about how to render actions is controlled by normative requirements elsewhere in this document (e.g.within the card format, or within the suggested actions definition).
CardImage	An image on a card.
ChannelAccount	Channel account information needed to route a message.
Channels
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 accounts represent the identity of conversations within a channel. In channels that support only a single conversation between two accounts (e.g. SMS), the conversation account is persistent and does not have a predetermined start or end. In channels that support multiple parallel conversations (e.g. email), each conversation will likely have a unique ID.
ConversationMembers	Conversation and its members.
ConversationParameters	Parameters for creating a new conversation.
ConversationReference	The conversationReference type contains a reference into another conversation. In its most minimal form, this reference may only contain the IDs of the target conversation. Implementers may wish to carry additional information in the conversationReference, such as the identity and roles of participants, and the ID of a specific activity within the conversation. Consumers of the conversationReference type are not provided any de facto guarantees about the validity or consistency of the IDs within the object; this is instead conferred by the sender who created the object. The conversationReference type is frequently used to store a reference to a conversation so it can be later retrieved and used to continue a conversation.
ConversationResourceResponse	A response containing a resource.
ConversationsResult	Conversations result.
DeliveryModes	Defines values for DeliveryModes.
EndOfConversationCodes	Defines values for EndOfConversationCodes.
Entity	Entities carry metadata about an activity or conversation. Each entity's meaning and shape is defined by the type field. Additional type-specific fields sit as peers to the type field. Some non-Bot-Framework entities may have a preexisting field called type.Parties integrating these entities into the activity entity format are advised to define field-level mapping to resolve conflicts with the type field name and other incompatibilities with serialization requirement A2001 as part of the IRI defining the entity type. Frequently, entities used within Activity Protocol are also expressed elsewhere using JSON-LD[17]. The entity format is designed to be compatible with JSON-LD contexts, but does not require senders or receivers to implement JSON-LD to successfully process an entity.
Error	Object representing error information.
ErrorResponse	An HTTP API Error response.
ExpectedReplies	Contents of the reply to an operation which returns expected Activity replies.
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").
HeroCard	A Hero card (card with a single, large image).
IActivityExtensions	Public Extensions for IActivity. type
InnerHttpError	Object representing inner http error.
InputHints	Defines values for InputHints.
InstallationUpdateActionTypes	Defines values for InstallationUpdateActionTypes.
InvokeResponse	A tuple class containing an HTTP status code and a JSON-serializable object.
InvokeResponse<T>	A tuple class containing an HTTP status code and a JSON-serializable object. The HTTP status code is, in the invoke activity scenario, what will be set in the resulting POST. The body of the resulting POST will be the JSON-serialized content from the Body property.
MediaCard	Media card.
MediaEventValue	Supplementary parameter for media events.
MediaUrl	Media URL.
Mention	Mention information (entity type: "mention").
MessageFactory	Contains utility methods for various message types a bot can return.
MessageReaction	Message reaction object.
MessageReactionTypes	Defines values for MessageReactionTypes.
OAuthCard	A card representing a request to perform a sign in via OAuth.
PagedMembersResult	Page of members.
Place	Place (entity type: "https://schema.org/Place").
ReceiptCard	A receipt card.
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 'adaptiveCard/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	A card representing a request to sign in.
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	A thumbnail card (card with a single, small thumbnail image).
ThumbnailUrl	Thumbnail URL.
TokenExchangeInvokeRequest	A request to exchange a token.
TokenExchangeInvokeResponse	The response object of a token exchange invoke.
TokenExchangeRequest	The TokenExchangeRequest.
TokenExchangeResource	Record for a token exchange request that is sent as part of Authentication.
TokenExchangeState	State object passed to the bot token service.
TokenPollingSettings	Helps provide polling for token details.
TokenPostResource	Response schema sent back from Azure Bot Service Token Service required to initiate a user token direct post.
TokenRequest	A request to receive a user token.
TokenResponse	A response that includes a user token.
TokenStatus	The status of a particular token.
Transcript	Transcript.
TurnContextStateCollection	Values persisted for the lifetime of the turn as part of the ITurnContext.
VideoCard	Video card.

Interfaces

IActivity	An Activity is the basic communication type for the Azure Bot Service 3.0 protocol.
IAttachments	Attachments operations.
IBot	Represents a bot that can operate on incoming activities.
IBotAdapter	Represents a bot adapter that can connect a bot to a service endpoint. This class is abstract.
IChannelServiceClientFactory	Handles creation of IConnectorClient and IUserTokenClient objects for use when handling incoming Activities.
ICommandActivity	Asynchronous external command.
ICommandResultActivity	Asynchronous external command result.
IConnectorClient	The Bot Connector API allows communicating back to the incoming request. Typically to the Activity.ServiceUrl property.
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.
IConversations	Conversations operations.
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.
IMiddleware	Represents middleware that can operate on incoming activities.
IMiddlewareSet
IStorage	Defines the interface for a storage layer.
IStoreItem	Exposes an ETag for concurrency control.
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.
ITurnContext	Provides context for a turn of a bot.
ITurnContext<T>	Provides context for a turn of a bot, where the context's Activity property is strongly typed.
ITypingActivity	The From address is typing.
IUserTokenClient	Client for access user token service.

Delegates

BotCallbackHandler	The callback delegate for application code.
DeleteActivityHandler	A method that can participate in delete activity events for the current turn.
NextDelegate	Encapsulates an asynchronous method that calls the next IMiddleware.OnTurnAsync(ITurnContext, NextDelegate, CancellationToken) or IBot.OnTurnAsync(ITurnContext, CancellationToken) method in the middleware pipeline.
SendActivitiesHandler	A method that can participate in send activity events for the current turn.
UpdateActivityHandler	A method that can participate in update activity events for the current turn.