api Package
Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License.
Classes
| AIMessageEntity |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| Account |
Represents a Teams account/user. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AdaptiveCardActionCardResponse |
The request was successfully processed, and the response includes an Adaptive Card that the client should display in place of the current one Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AdaptiveCardActionErrorResponse |
400: The incoming request was invalid 500: An unexpected error occurred Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AdaptiveCardActionIncorrectAuthCodeResponse |
The authentication state passed by the client was incorrect and authentication failed Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AdaptiveCardActionLoginResponse |
The client needs to prompt the user to authenticate Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AdaptiveCardActionMessageResponse |
The request was successfully processed, and the response includes a message that the client should display Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AdaptiveCardActionPreconditionFailedResponse |
The SSO authentication flow failed Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AdaptiveCardAttachment |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AdaptiveCardInvokeAction |
Defines the structure that arrives in the Activity.Value.Action for Invoke activity with Name of 'adaptiveCard/action'. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AdaptiveCardInvokeActivity |
Represents an activity that is sent when an adaptive card action is invoked. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AdaptiveCardInvokeValue |
Defines the structure that arrives in the Activity.Value for Invoke activity with Name of 'adaptiveCard/action'. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgentLifecycleEventActivityBase |
Base for Agent 365 These activities arrive from the Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgentLifecycleManager |
Manager profile carried by the Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgentLifecycleManagerRef |
Manager reference carried by the Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgentLifecycleUpdatedProperty |
A single property change carried by the Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgentLifecycleValueBase |
Fields shared by every agentLifecycle event payload. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgenticAppTokenProviderProtocol |
Optional named capability for acquiring agentic app-scoped tokens. |
| AgenticIdentity |
Identifies the Agent 365 identity scope used for SDK operations. AgenticIdentity is the SDK operation/request scope for the Agent 365 program. It encompasses an agentic app blueprint, which can instantiate agentic apps, and each app can optionally have associated agentic users. |
| AgenticUserDeletedActivity |
Fired when an agentic user is deleted. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgenticUserDeletedValue |
Payload for the Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgenticUserDisabledActivity |
Fired when an agentic user is disabled. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgenticUserDisabledValue |
Payload for the Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgenticUserEnabledActivity |
Fired when an agentic user is enabled. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgenticUserEnabledValue |
Payload for the Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgenticUserIdentityCreatedActivity |
Fired when an agentic user identity is created. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgenticUserIdentityCreatedValue |
Payload for the Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgenticUserIdentityUpdatedActivity |
Fired when an agentic user identity property changes. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgenticUserIdentityUpdatedValue |
Payload for the Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgenticUserManagerUpdatedActivity |
Fired when an agentic user's manager changes. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgenticUserManagerUpdatedValue |
Payload for the Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgenticUserTokenProviderProtocol |
Optional named capability for acquiring agentic user-scoped tokens. |
| AgenticUserUndeletedActivity |
Fired when a previously deleted agentic user is restored. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgenticUserUndeletedValue |
Payload for the Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgenticUserWorkloadOnboardingUpdatedActivity |
Fired when a workload onboarding state changes for an agentic user. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AgenticUserWorkloadOnboardingUpdatedValue |
Payload for the Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AnimationCard |
An animation card (Ex: gif or short video clip) This card type has the same structure as MediaCard but represents specific animation content like gifs or short video clips. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AnimationCardAttachment |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ApiClient |
Unified client for Microsoft Teams API operations. Initialize the unified Teams API client. |
| ApiClientSettings |
Settings for API clients. |
| AppBasedLinkQuery |
An interface representing AppBasedLinkQuery. Invoke request body type for app-based link query. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AppInfo |
Describes an app Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| Appearance |
Appearance options for a citation Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| Attachment |
A model representing an attachment. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AudioCard |
Audio card This card type has the same structure as MediaCard but represents audio content specifically. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| AudioCardAttachment |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| BaseTaskModuleTaskInfo |
Base class for task module task info. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| BasicCard |
A basic card Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| BotClient |
Client for managing bot operations. Initialize the BotClient. |
| BotSignInClient |
Client for managing bot sign-in. Initialize the bot sign-in client. |
| BotTokenClient |
Deprecated client for managing bot tokens. Token minting for Teams apps now happens through the MSAL-backed TokenManager in microsoft-teams-apps. Initialize the bot token client. |
| CacheInfo |
A cache info object which notifies Teams how long an object should be cached for. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| CallToolRequest |
A request from a widget to call a tool on the bot. Sent as the value of an htmlwidget/calltool invoke activity. Diagnostic: ExperimentalTeamsHtmlWidget Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| CardAction |
Represents a card action with button properties. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| CardImage |
An image on a card Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| CardTaskModuleTaskInfo |
Task module info for card type. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ChannelData |
Channel data specific to messages received in Microsoft Teams Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ChannelDataSettings |
Settings within teams channel data specific to messages received in Microsoft Teams. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ChannelInfo |
A channel info object which describes the channel. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| CitationAppearance |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| CitationEntity |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| CitationUsageInfo |
Sensitivity content information Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| Claim |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ClientCredentials |
Credentials for authentication of an app via clientId and clientSecret. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ClientInfoEntity |
Client information entity Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| CloudEnvironment |
Bundles all cloud-specific service endpoints for a given Azure environment. Use predefined instances (PUBLIC, US_GOV, US_GOV_DOD, CHINA) or construct a custom one via with_overrides(). |
| CommandResultActivity |
Output model for received command result activities with required fields and read-only properties. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| CommandResultValue |
The value field of a CommandResultActivity contains metadata related to a command result. An optional extensible data payload may be included if defined by the command activity name. The presence of an error field indicates that the original command failed to complete. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| CommandSendActivity |
Output model for received command send activities with required fields and read-only properties. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| CommandSendValue |
The value field of a CommandActivity contains metadata related to a command. An optional extensible data payload may be included if defined by the command activity name. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ConfigAuth |
The bot's authentication config for SuggestedActions Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ConfigFetchInvokeActivity |
Represents the config fetch invoke activity. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ConfigResponse |
A container for the Config response payload Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ConfigSubmitInvokeActivity |
Represents the config submit invoke activity. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| Conversation |
Represents a Teams conversation. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ConversationAccount |
Represents a Teams conversation account. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ConversationActivityClient |
Client for managing activities in a Teams conversation. Initialize the conversation activity client. |
| ConversationChannelData |
Extended ChannelData with event type. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ConversationClient |
Client for managing Teams conversations. Initialize the client. |
| ConversationMemberClient |
Client for managing members in a Teams conversation. Initialize the conversation member client. |
| ConversationReference |
An object relating to a particular point in a conversation Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ConversationResource |
A response containing a resource Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ConversationUpdateActivity |
Output model for received conversation update activities with read-only properties. Note: channel_data may be absent for some conversationUpdate payloads (e.g. Direct Line activities) and should be treated as optional. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| CreateConversationParams |
Parameters for creating a conversation. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| CustomBaseModel |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| EntityBase |
Base entity for entity types. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ErrorResponse |
An HTTP API response. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ExchangeUserTokenParams |
Parameters for exchanging a user token. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ExecuteActionInvokeActivity |
Execute action invoke activity for actionableMessage/executeAction invokes. Represents an invoke activity when a user clicks on an action button in an O365 connector card message. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| FederatedIdentityCredentials |
Credentials for authentication using Federated Identity Credentials with Managed Identity. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| FeedbackLoop |
Configuration for a custom feedback loop on a message. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| FileConsentCard |
File consent card attachment. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| FileConsentCardResponse |
Represents the value of the invoke activity sent when the user acts on a file consent card Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| FileConsentInvokeActivity |
File consent invoke activity for fileConsent/invoke invokes. Represents an invoke activity when a user acts on a file consent card (either accepting or declining file upload). Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| FileDownloadInfo |
The content of a file.download.info attachment, describing an uploaded file received in a personal (1:1) chat. The file is fetched from the short-lived, pre-authorized download_url with a plain GET (no bearer token). Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| FileInfoCard |
File info card. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| FileUploadInfo |
Information about the file to be uploaded. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| GetBotSignInResourceParams |
Parameters for getting a bot sign-in resource. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| GetBotSignInUrlParams |
Parameters for getting a bot sign-in URL. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| GetTeamConversationsResponse |
Response model for getting team conversations. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| GetUserAADTokenParams |
Parameters for getting AAD tokens for a user. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| GetUserTokenParams |
Parameters for getting a user token. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| GetUserTokenStatusParams |
Parameters for getting token status for a user. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| HandoffActionInvokeActivity |
Handoff action invoke activity for handoff/action invokes. Represents an invoke activity when a handoff action occurs, typically used for transferring conversation control. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| HeroCard |
A Hero card (card with a single, large image) This card type has the same structure as BasicCard but is specifically meant to display cards with a single, large image. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| HeroCardAttachment |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| HtmlWidgetCallToolInvokeActivity |
Represents an activity that is sent when a widget calls a tool on the bot. Diagnostic: ExperimentalTeamsHtmlWidget Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| HtmlWidgetCallToolResponse |
The wire-format response body for an htmlwidget/calltool invoke. Teams expects this shape (with responseType discriminator) rather than a bare McpUiCallToolResult. Diagnostic: ExperimentalTeamsHtmlWidget Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| HtmlWidgetPayload |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| HtmlWidgetPermissions |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| HtmlWidgetSecurityPolicy |
The security policy for an HTML widget, controlling allowed origins for network requests, static resources, nested iframes, and base URIs. Diagnostic: ExperimentalTeamsHtmlWidget Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| HttpError |
Object representing error information. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| Image |
Information about the citation's icon Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| InnerHttpError |
Object representing inner http error. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| InstalledActivity |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| InstalledUpgradeActivity |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| InvokeResponse |
Represents a response returned by a bot when it receives an invoke activity. This class supports the framework and is not intended to be called directly for your code. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| JsonWebToken |
JSON Web Token implementation for Teams authentication. Initialize a typed accessor over an already-validated JWT payload. This constructor performs no signature verification, no issuer/audience checks, and no expiry enforcement. Constructing it from an untrusted token does NOT establish trust in the contained claims. Signature verification happens at the HTTP trust boundary via
Callers must not construct this class from raw network input. |
| JsonWebTokenPayload |
JWT payload with additional Teams-specific fields. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ManagedIdentityCredentials |
Credentials for authentication using Azure User-Assigned Managed Identity. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| McpUiAudioContent |
Audio content item in an MCP call tool result. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| McpUiCallToolResult |
The result of a widget's tools/call request, returned by the bot in response to an htmlwidget/calltool invoke activity. Diagnostic: ExperimentalTeamsHtmlWidget Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| McpUiImageContent |
Image content item in an MCP call tool result. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| McpUiResourceContent |
Embedded resource content item in an MCP call tool result. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| McpUiTextContent |
Text content item in an MCP call tool result. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| McpUiUpdateModelContextParams |
The parameters of an MCP UI ui/update-model-context request. Diagnostic: ExperimentalTeamsHtmlWidget Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| McpUiUpdateModelContextRequest |
A widget's request to update the model context, delivered on the value of a message activity (reusing the messageBack mechanism, fire-and-forget). Defined by the MCP Apps (ext-apps) specification. Diagnostic: ExperimentalTeamsHtmlWidget Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MediaCard |
Media card Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MediaUrl |
Media URL Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| Meeting |
A participant's meeting-specific details, including their role and current presence status within the meeting. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MeetingClient |
Client for managing Teams meetings. Initialize the MeetingClient. |
| MeetingDetails |
Meeting details including IDs and scheduling information. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MeetingEndEventActivity |
Represents a meeting end event activity in Microsoft Teams. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MeetingInfo |
General information about a Teams meeting. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MeetingNotificationParams |
Parameters for sending a meeting notification. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MeetingNotificationRecipientFailure |
Information about a recipient that failed to receive a meeting notification. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MeetingNotificationResponse |
Response from a meeting notification request when some or all recipients failed (HTTP 207). None is returned when all notifications were sent successfully (HTTP 202). Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MeetingNotificationSurface |
A surface target for a meeting notification. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MeetingNotificationValue |
The value of a targeted meeting notification. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MeetingParticipant |
Teams meeting participant detailing user Azure Active Directory details. Meeting participant details pertain to the user's info within the context of a Teams meeting, such as their role and presence status in the meeting. This is separate from their general user information, which is represented by the TeamsChannelAccount. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MeetingParticipantEventActivity |
Represents a meeting participant event activity in Microsoft Teams. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MeetingParticipantJoinEventActivity |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MeetingParticipantLeaveEventActivity |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MeetingStartEventActivity |
Represents a meeting start event activity in Microsoft Teams. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MentionEntity |
Entity representing a mention of a user Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| Message |
Represents the individual message within a chat or channel where a message actions is taken. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageActivity |
Output model for received message activities with required fields and read-only properties. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageActivityInput |
Input model for creating message activities with builder methods. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageApp |
Represents an application entity. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageBody |
Plaintext/HTML representation of the content of the message. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageConversation |
Represents a team or channel entity. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageDeleteActivity |
Output model for received message delete activities with required fields and read-only properties. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageDeleteChannelData |
Channel data specific to message delete activities. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageEntity |
Base message entity following schema.org Message schema Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageExtensionAnonQueryLinkInvokeActivity |
Message extension anonymous query link invoke activity for composeExtension/anonymousQueryLink invokes. Represents an invoke activity when an anonymous user queries a link in a messaging extension. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageExtensionCardButtonClickedInvokeActivity |
Message extension card button clicked invoke activity for composeExtension/onCardButtonClicked invokes. Represents an invoke activity when a user clicks a button on a card within a messaging extension. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageExtensionFetchTaskInvokeActivity |
Message extension fetch task invoke activity for composeExtension/fetchTask invokes. Represents an invoke activity when a messaging extension needs to fetch a task module for user interaction. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageExtensionQueryInvokeActivity |
Message extension query invoke activity for composeExtension/query invokes. Represents an invoke activity when a user performs a search query in a messaging extension. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageExtensionQueryLinkInvokeActivity |
Message extension query link invoke activity for composeExtension/queryLink invokes. Represents an invoke activity when a user queries a link in a messaging extension. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageExtensionQuerySettingUrlInvokeActivity |
Message extension query setting URL invoke activity for composeExtension/querySettingUrl invokes. Represents an invoke activity when a messaging extension needs to query for setting URL configuration. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageExtensionSelectItemInvokeActivity |
Message extension select item invoke activity for composeExtension/selectItem invokes. Represents an invoke activity when a user selects an item from a messaging extension search result. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageExtensionSettingInvokeActivity |
Message extension setting invoke activity for composeExtension/setting invokes. Represents an invoke activity when a messaging extension processes setting-related operations. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageExtensionSubmitActionInvokeActivity |
Message extension submit action invoke activity for composeExtension/submitAction invokes. Represents an invoke activity when a user submits an action in a messaging extension. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageFetchTaskActionValue |
The nested action value containing the user's reaction. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageFetchTaskData |
The data payload nested inside the fetch task value. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageFetchTaskInvokeActivity |
Represents an activity sent when a message has a custom feedback loop and the user clicks a feedback button. The bot should respond with a task module (dialog) to collect feedback. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageFetchTaskInvokeValue |
Represents the value associated with a message fetch task. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageFrom |
Represents a user, application, or conversation type that either sent or was referenced in a message. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageMention |
Represents the entity that was mentioned in the message. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageReaction |
Represents a reaction to a message. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageReactionActivity |
Output model for received message reaction activities with required fields and read-only properties. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageReactionActivityInput |
Input model for creating message reaction activities with builder methods. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageSubmitActionInvokeActivity |
Represents an activity that is sent when a message submit action is invoked. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageUpdateActivity |
Output model for received message update activities with required fields and read-only properties. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageUpdateChannelData |
Channel data specific to message update activities. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessageUser |
Represents a user entity. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessagingExtensionAction |
Messaging extension action Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessagingExtensionActionResponse |
Response of messaging extension action Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessagingExtensionAttachment |
Messaging extension attachment. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessagingExtensionParameter |
Messaging extension query parameters Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessagingExtensionQuery |
Messaging extension query Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessagingExtensionQueryOptions |
Messaging extension query options Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessagingExtensionResponse |
An interface representing MessagingExtensionResponse. Messaging extension response Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessagingExtensionResult |
Messaging extension result Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| MessagingExtensionSuggestedAction |
Messaging extension Actions (Only when type is auth or config) Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| NotificationInfo |
Specifies if a notification is to be sent for the mentions. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| O365ConnectorCardActionQuery |
An interface representing O365ConnectorCardActionQuery. O365 connector card HttpPOST invoke query Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| OAuthCardAttachment |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| PagedMembersResult |
Result of a paged members request. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ProductInfoEntity |
Product information entity Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| QuotedReplyData |
Data for a quoted reply entity Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| QuotedReplyEntity |
Entity containing quoted reply information Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ReactionClient |
Client for working with app message reactions for a given conversation/activity. Initialize the reaction client. |
| ReadReceiptEventActivity |
Represents a read receipt event activity in Microsoft Teams. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SearchInvokeActivity |
Represents an activity that is sent when an Adaptive Card dynamic typeahead 'Input.ChoiceSet' (via 'choices.data' / 'Data.Query') requests choices. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SearchInvokeOptions |
Defines the query options for an Invoke activity with Name of 'application/search'. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SearchInvokeResponseValue |
The value payload of a SearchResponse. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SearchInvokeResult |
A single result returned in a SearchResponse. For Adaptive Card dynamic typeahead 'Input.ChoiceSet', 'title' is the display text and 'value' is the submitted value. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SearchInvokeValue |
Defines the structure that arrives in the Activity.Value for an Invoke activity with Name of 'application/search'. Sent by Adaptive Card dynamic typeahead 'Input.ChoiceSet' inputs (via 'choices.data' / 'Data.Query'). Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SearchResponse |
Defines the structure returned as the result of an Invoke activity with Name of 'application/search'. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SensitiveUsage |
Sensitive usage information Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SensitiveUsageEntity |
Sensitive usage entity extending MessageEntity Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SensitiveUsagePattern |
Pattern information for sensitive usage Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SentActivity |
Represents an activity that was sent. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SignInCard |
A card representing a request to sign in Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SignInExchangeToken |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SignInFailure |
Sign-in failure information. Represents the details of a sign-in failure including an error code and message. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SignInFailureInvokeActivity |
Sign-in failure invoke activity for signin/failure invokes. Represents an invoke activity when a sign-in operation fails during the authentication process. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SignInStateVerifyQuery |
An interface representing SigninStateVerificationQuery. Signin state (part of signin action auth flow) verification invoke query Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SignInTokenExchangeInvokeActivity |
Sign-in token exchange invoke activity for signin/tokenExchange invokes. Represents an invoke activity when a token exchange occurs during the sign-in process. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SignInUrlResponse |
Response model for sign-in URL requests. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SignInVerifyStateInvokeActivity |
Sign-in verify state invoke activity for signin/verifyState invokes. Represents an invoke activity when state verification occurs during the sign-in process. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SignOutUserParams |
Parameters for signing out a user. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SigninCardAttachment |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| StreamInfoEntity |
Entity containing streaming information Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SuggestedActionSubmitInvokeActivity |
Sent when the user clicks a suggested action of type Action.Submit. The structured payload authored on the suggested action is delivered via value. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| SuggestedActions |
Actions that can be suggested to users. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TabContext |
Current tab request context, i.e., the current theme. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TabEntityContext |
Current TabRequest entity context, or 'tabEntityId'. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TabFetchInvokeActivity |
Tab fetch invoke activity for tab/fetch invokes. Represents an invoke activity when a tab needs to fetch content or configuration for display. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TabRequest |
Invoke ('tab/fetch') request value payload. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TabResponse |
Envelope for Card Tab Response Payload. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TabResponseCard |
Envelope for cards for a Tab request. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TabResponseCards |
Envelope for cards for a TabResponse. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TabResponsePayload |
Payload for Tab Response. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TabSubmit |
Invoke ('tab/submit') request value payload. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TabSubmitInvokeActivity |
Tab submit invoke activity for tab/submit invokes. Represents an invoke activity when a tab submits data or handles user interaction. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TabSuggestedActions |
Tab SuggestedActions (Only when type is 'auth' or 'silentAuth'). Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TargetedMessageInfoEntity |
Entity containing targeted message information for prompt preview. Warning Preview This class is in preview and may change in the future. Diagnostic: ExperimentalTeamsTargeted Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TaskFetchInvokeActivity |
Task fetch invoke activity for task/fetch invokes. Represents an invoke activity when a task module needs to fetch configuration or content for display. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TaskModuleCardResponse |
Tab response to 'task/submit'. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TaskModuleContinueResponse |
Task Module Response with continue action. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TaskModuleMessageResponse |
Task Module response with message action. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TaskModuleRequest |
Task module invoke request value payload. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TaskModuleRequestContext |
Current user context, i.e., the current theme. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TaskModuleResponse |
Envelope for Task Module Response. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TaskModuleResponseBase |
Base class for Task Module responses. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TaskSubmitInvokeActivity |
Task submit invoke activity for task/submit invokes. Represents an invoke activity when a task module handles user submission or interaction. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TeamClient |
Client for managing Teams teams. Initialize the TeamClient. |
| TeamDetails |
Details related to a team. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TeamInfo |
An interface representing TeamInfo. Describes a team Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TeamsApiTelemetry |
OpenTelemetry source names for the Teams API package. |
| TeamsChannelAccount |
Represents a Teams channel account, extending the basic channel account with Teams-specific properties. This is used to represent a user or bot in Microsoft Teams conversations. https://learn.microsoft.com/en-us/dotnet/api/microsoft.bot.schema.teams.teamschannelaccount Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TenantInfo |
Describes a tenant Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ThumbnailCard |
A thumbnail card (card with a single, small thumbnail image) This card type has the same structure as BasicCard but is specifically meant to display cards with a single, small thumbnail image. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ThumbnailCardAttachment |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| ThumbnailUrl |
Thumbnail URL Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TokenCredentials |
Credentials for authentication of an app via any external auth method. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TokenExchangeInvokeRequest |
A request to exchange a token. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TokenExchangeInvokeResponse |
The response object of a token exchange invoke Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TokenExchangeRequest |
Model representing a token exchange request. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TokenExchangeResource |
Model representing a token exchange resource. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TokenExchangeState |
State object passed to the bot token service. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TokenPostResource |
A post resource for a token. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TokenProtocol |
Any authorized token. |
| TokenProviderProtocol |
Named token capabilities for apps that need more than app-only tokens. |
| TokenRequest |
A request to receive a user token. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TokenResponse |
A response that includes a user token. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TokenStatus |
The status of a particular token. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TypingActivity |
Output model for received typing activities with required fields and read-only properties. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| TypingActivityInput |
Input model for creating typing activities with builder methods. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| UninstalledActivity |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| UnknownEntity |
Entity for unknown or forward-compatible types. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| UrlTaskModuleTaskInfo |
Task module info for URL type. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| UserClient |
Client for managing Teams users. Initialize the UserClient. |
| UserTokenClient |
Client for managing user tokens in Teams. Initialize the UserTokenClient. |
| VideoCard |
Video card This card type has the same structure as MediaCard but represents video content specifically. Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
| VideoCardAttachment |
Create a new model by parsing and validating input data from keyword arguments. Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model. self is explicitly positional-only to allow self as a field name. |
Enums
| Action |
Enum for the actions that can be taken on a file consent card. |
| ApplicationIdentityType |
Enum for application identity types. |
| AttachmentLayout |
Enum for attachment layout types. |
| CallerIds |
Enum for caller ID types. |
| CardActionType |
Available card action types. |
| CardAttachmentType | |
| CardAttachmentTypes | |
| CitationIconName | |
| Importance |
Enum for user identity types. |
| MessagingExtensionAttachmentLayout |
Enum for messaging extension attachment layout types. |
| MessagingExtensionResultType |
Enum representing the type of result for a messaging extension. |
| UserIdentityType |
Enum for user identity types. |
Functions
card_attachment
Create a card attachment of the specified type
card_attachment(attachment: AdaptiveCardAttachment | AnimationCardAttachment | AudioCardAttachment | HeroCardAttachment | OAuthCardAttachment | SigninCardAttachment | ThumbnailCardAttachment | VideoCardAttachment) -> Attachment
Parameters
| Name | Description |
|---|---|
|
type
Required
|
The type of card attachment to create |
|
content
Required
|
The content for the card attachment (specific type based on card type) |
|
attachment
Required
|
|
Returns
| Type | Description |
|---|---|
|
A card attachment of the specified type with the given content |
config_from_cloud_name
Resolve a cloud environment name (case-insensitive) to its corresponding instance. Valid names: "Public", "USGov", "USGovDoD", "China".
config_from_cloud_name(name: str) -> CloudEnvironment
Parameters
| Name | Description |
|---|---|
|
name
Required
|
|
is_invoke_response
Type guard to check if a value is an InvokeResponse.
is_invoke_response(value: Any) -> bool
Parameters
| Name | Description |
|---|---|
|
value
Required
|
Value to compare |
Returns
| Type | Description |
|---|---|
|
True if value is type of InvokeResponse |
merge_api_client_settings
Merge API client settings with environment variables and defaults.
merge_api_client_settings(api_client_settings: ApiClientSettings | None = None, cloud: CloudEnvironment = CloudEnvironment(login_endpoint='https://login.microsoftonline.com', login_tenant='botframework.com', bot_scope='https://api.botframework.com/.default', agent_bot_scope='https://botapi.skype.com/.default', token_service_url='https://token.botframework.com', openid_metadata_url='https://login.botframework.com/v1/.well-known/openidconfiguration', token_issuer='https://api.botframework.com', graph_scope='https://graph.microsoft.com/.default')) -> ApiClientSettings
Parameters
| Name | Description |
|---|---|
|
api_client_settings
|
Optional API client settings to merge. Default value: None
|
|
cloud
|
Cloud environment for default oauth_url. Defaults to PUBLIC. Default value: CloudEnvironment(login_endpoint='https://login.microsoftonline.com', login_tenant='botframework.com', bot_scope='https://api.botframework.com/.default', agent_bot_scope='https://botapi.skype.com/.default', token_service_url='https://token.botframework.com', openid_metadata_url='https://login.botframework.com/v1/.well-known/openidconfiguration', token_issuer='https://api.botframework.com', graph_scope='https://graph.microsoft.com/.default')
|
Returns
| Type | Description |
|---|---|
|
Merged API client settings. |
with_overrides
Create a new CloudEnvironment by applying non-None overrides on top of a base. Returns the same instance if all overrides are None (no allocation).
with_overrides(base: CloudEnvironment, **overrides: str | None) -> CloudEnvironment
Parameters
| Name | Description |
|---|---|
|
base
Required
|
|