Share via


activity Package

Packages

entity
teams

Modules

action_types
activity
activity_event_names
activity_importance
activity_types
adaptive_card_invoke_action
adaptive_card_invoke_response
adaptive_card_invoke_value
agents_model
animation_card
attachment
attachment_data
attachment_info
attachment_layout_types
attachment_view
audio_card
basic_card
caller_id_constants
card_action
card_image
channel_account
channel_adapter_protocol
channel_id
channels
contact_relation_update_action_types
conversation_account
conversation_members
conversation_parameters
conversation_reference
conversation_resource_response
conversation_update_types
conversations_result
delivery_modes
end_of_conversation_codes
error
error_response
expected_replies
fact
hero_card
inner_http_error
input_hints
installation_update_action_types
invoke_response
media_card
media_event_value
media_url
message_reaction
message_reaction_types
message_update_types
oauth_card
paged_members_result
receipt_card
receipt_item
resource_response
role_types
semantic_action
semantic_actions_states
sign_in_constants
sign_in_resource
signin_card
suggested_actions
text_format_types
text_highlight
thumbnail_card
thumbnail_url
token_exchange_invoke_request
token_exchange_invoke_response
token_exchange_resource
token_exchange_state
token_or_sign_in_resource_response
token_post_resource
token_request
token_response
token_status

Models for token status operations.

transcript
turn_context_protocol
video_card

Classes

AIEntity

Entity indicating AI-generated content.

Activity

An Activity is the basic communication type for the protocol.

AdaptiveCardInvokeAction

AdaptiveCardInvokeAction.

Defines the structure that arrives in the Activity.Value.Action for Invoke activity with name of 'adaptiveCard/action'.

AdaptiveCardInvokeResponse

AdaptiveCardInvokeResponse.

Defines the structure that is returned as the result of an Invoke activity with Name of 'adaptiveCard/action'.

AdaptiveCardInvokeValue

AdaptiveCardInvokeResponse.

Defines the structure that arrives in the Activity.Value for Invoke activity with Name of 'adaptiveCard/action'.

AgentsModel
AnimationCard

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

Attachment

An attachment within an activity.

AttachmentData

Attachment data.

AttachmentInfo

Metadata for an attachment.

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.

ChannelAdapterProtocol
ChannelId

A ChannelId represents a channel and optional sub-channel in the format 'channel:sub_channel'.

ClientCitation

Represents a Teams client citation to be included in a message. See Bot messages with AI-generated content for more details. https://learn.microsoft.com/en-us/microsoftteams/platform/bots/how-to/bot-messages-ai-generated-content?tabs=before%2Cbotmessage

ClientCitationAppearance

Appearance information for a client citation.

ClientCitationImage

Information about the citation's icon.

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.

Entity

Metadata object pertaining to an activity.

Error

Object representing error information.

ErrorResponse

An HTTP API response.

ExpectedReplies

ExpectedReplies.

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

InnerHttpError

Object representing inner http error.

InvokeResponse

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 JSON serialized content.

The body content is defined by the producer. The caller must know what the content is and deserialize as needed.

MediaCard

Media card.

MediaEventValue

Supplementary parameter for media events.

MediaUrl

Media URL.

Mention

Mention information (entity type: "mention").

MessageReaction

Message reaction object.

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

ProductInfo

Product information (entity type: "productInfo").

ReceiptCard

A receipt card.

ReceiptItem

An item on a receipt card.

ResourceResponse

A response containing a resource ID.

SemanticAction

Represents a reference to a programmatic action.

SensitivityPattern

Pattern information for sensitivity usage info.

SensitivityUsageInfo

Sensitivity usage info for content sent to the user. This is used to provide information about the content to the user.

SignInResource

A type containing information for single sign-on.

SigninCard

A card representing a request to sign in.

SuggestedActions

SuggestedActions that can be performed.

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

TokenExchangeInvokeRequest.

TokenExchangeInvokeResponse

TokenExchangeInvokeResponse.

TokenExchangeResource

A type containing information for token exchange.

TokenExchangeState

TokenExchangeState

TokenOrSignInResourceResponse

Represents the response containing either a token or a sign-in resource.

One of the two properties should be set (if returned from the 'getTokenOrSignInResource' endpoint), not both.

TokenPostResource

A type containing information for token posting.

TokenRequest

A request to receive a user token.

TokenResponse

A response that includes a user token.

TokenStatus

The status of a user token.

Transcript

Transcript.

TurnContextProtocol
VideoCard

Video card.

Enums

ActionTypes
ActivityEventNames
ActivityImportance
ActivityTypes
AttachmentLayoutTypes
CallerIdConstants
Channels

Ids of channels supported by ABS.

ClientCitationIconName

Enumeration of supported citation icon names.

ContactRelationUpdateActionTypes
ConversationUpdateTypes
DeliveryModes
EndOfConversationCodes
InputHints
InstallationUpdateActionTypes
MessageReactionTypes

MessageReactionType

Enum for message reaction types.

MessageUpdateTypes
RoleTypes
SemanticActionsStates
SignInConstants
TextFormatTypes

Functions

load_configuration_from_env

Parses environment variables and returns a dictionary with the relevant configuration.

load_configuration_from_env(env_vars: dict[str, Any]) -> dict

Parameters

Name Description
env_vars
Required

Returns

Type Description