diff --git a/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.MessageActivity.yml b/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.MessageActivity.yml index 84b2be1..945fae3 100644 --- a/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.MessageActivity.yml +++ b/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.MessageActivity.yml @@ -26,11 +26,11 @@ constructor: | SensitiveUsageEntity | ProductInfoEntity | QuotedReplyEntity | TargetedMessageInfoEntity | UnknownEntity] | None = None, channelData: ChannelData | None = None, type: Literal[''message''] = ''message'', id: str, recipient: Account, text: str = '''', - summary: str | None = None, textFormat: Literal[''markdown'', ''plain'', ''xml''] - | None = None, attachmentLayout: AttachmentLayout | None = None, attachments: - List[Attachment] | None = None, suggestedActions: SuggestedActions | None = None, - deliveryMode: Literal[''normal'', ''notification'', ''expectReplies'', ''ephemeral''] - | None = None, value: Any | None = None, **extra_data: Any)' + summary: str | None = None, textFormat: Literal[''markdown'', ''plain'', ''xml'', + ''extendedmarkdown''] | None = None, attachmentLayout: AttachmentLayout | None + = None, attachments: List[Attachment] | None = None, suggestedActions: SuggestedActions + | None = None, deliveryMode: Literal[''normal'', ''notification'', ''expectReplies'', + ''ephemeral''] | None = None, value: Any | None = None, **extra_data: Any)' keywordOnlyParameters: - name: serviceUrl defaultValue: None @@ -86,22 +86,7 @@ methods: description: The mention entity if found, None otherwise - uid: microsoft_teams.api.MessageActivity.get_quoted_messages name: get_quoted_messages - summary: 'Get all quoted reply entities from this message. - - - > [!WARNING] - - > Coming Soon - - > - - > This API is coming soon and may change in the future. - - > - - > Diagnostic: ExperimentalTeamsQuotedReplies - - >' + summary: Get all quoted reply entities from this message. signature: get_quoted_messages() -> list[microsoft_teams.api.models.entity.quoted_reply_entity.QuotedReplyEntity] return: description: List of quoted reply entities, empty if none diff --git a/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.MessageActivityInput.yml b/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.MessageActivityInput.yml index 7122c41..7bb0881 100644 --- a/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.MessageActivityInput.yml +++ b/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.MessageActivityInput.yml @@ -27,10 +27,11 @@ constructor: | None = None, channelData: ChannelData | None = None, type: Literal[''message''] = ''message'', id: str | None = None, recipient: Account | None = None, text: str | None = None, summary: str | None = None, textFormat: Literal[''markdown'', - ''plain'', ''xml''] | None = None, attachmentLayout: AttachmentLayout | None = - None, attachments: List[Attachment] | None = None, suggestedActions: SuggestedActions - | None = None, deliveryMode: Literal[''normal'', ''notification'', ''expectReplies'', - ''ephemeral''] | None = None, value: Any | None = None, **extra_data: Any)' + ''plain'', ''xml'', ''extendedmarkdown''] | None = None, attachmentLayout: AttachmentLayout + | None = None, attachments: List[Attachment] | None = None, suggestedActions: + SuggestedActions | None = None, deliveryMode: Literal[''normal'', ''notification'', + ''expectReplies'', ''ephemeral''] | None = None, value: Any | None = None, **extra_data: + Any)' keywordOnlyParameters: - name: serviceUrl defaultValue: None @@ -147,22 +148,7 @@ methods: Teams renders the quoted message as a preview bubble above the response text. - If text is provided, it is appended to the quoted message placeholder. - - - > [!WARNING] - - > Coming Soon - - > - - > This API is coming soon and may change in the future. - - > - - > Diagnostic: ExperimentalTeamsQuotedReplies - - >' + If text is provided, it is appended to the quoted message placeholder.' signature: 'add_quote(message_id: str, text: str | None = None) -> Self' parameters: - name: message_id @@ -231,22 +217,7 @@ methods: name: prepend_quote summary: 'Prepend a quotedReply entity and placeholder before existing text. - Used by reply()/quote() for quote-above-response. - - - > [!WARNING] - - > Coming Soon - - > - - > This API is coming soon and may change in the future. - - > - - > Diagnostic: ExperimentalTeamsQuotedReplies - - >' + Used by reply()/quote() for quote-above-response.' signature: 'prepend_quote(message_id: str) -> Self' parameters: - name: message_id @@ -325,11 +296,11 @@ methods: - uid: microsoft_teams.api.MessageActivityInput.with_text_format name: with_text_format summary: Set the format of text fields. - signature: 'with_text_format(text_format: Literal[''markdown'', ''plain'', ''xml'']) - -> Self' + signature: 'with_text_format(text_format: Literal[''markdown'', ''plain'', ''xml'', + ''extendedmarkdown'']) -> Self' parameters: - name: text_format - description: Text format (markdown, plain, xml) + description: Text format (markdown, plain, xml, extendedmarkdown) isRequired: true return: description: Self for method chaining diff --git a/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.MessageUpdateActivity.yml b/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.MessageUpdateActivity.yml index 13d6e88..0e02e89 100644 --- a/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.MessageUpdateActivity.yml +++ b/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.MessageUpdateActivity.yml @@ -26,8 +26,9 @@ constructor: | SensitiveUsageEntity | ProductInfoEntity | QuotedReplyEntity | TargetedMessageInfoEntity | UnknownEntity] | None = None, channelData: MessageUpdateChannelData, type: Literal[''messageUpdate''] = ''messageUpdate'', id: str, recipient: Account, text: str = '''', speak: str - | None = None, summary: str | None = None, expiration: datetime | None = None, - value: Any | None = None, **extra_data: Any)' + | None = None, summary: str | None = None, attachmentLayout: AttachmentLayout + | None = None, attachments: List[Attachment] | None = None, expiration: datetime + | None = None, value: Any | None = None, **extra_data: Any)' keywordOnlyParameters: - name: serviceUrl defaultValue: None @@ -60,6 +61,10 @@ constructor: defaultValue: None - name: summary defaultValue: None + - name: attachmentLayout + defaultValue: None + - name: attachments + defaultValue: None - name: expiration defaultValue: None - name: value diff --git a/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.QuotedReplyData.yml b/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.QuotedReplyData.yml index 5a3115e..3d42a5c 100644 --- a/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.QuotedReplyData.yml +++ b/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.QuotedReplyData.yml @@ -6,21 +6,6 @@ module: microsoft_teams.api summary: 'Data for a quoted reply entity - > [!WARNING] - - > Coming Soon - - > - - > This API is coming soon and may change in the future. - - > - - > Diagnostic: ExperimentalTeamsQuotedReplies - - > - - Create a new model by parsing and validating input data from keyword arguments. diff --git a/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.QuotedReplyEntity.yml b/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.QuotedReplyEntity.yml index 411ad6e..d3ba6fd 100644 --- a/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.QuotedReplyEntity.yml +++ b/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.QuotedReplyEntity.yml @@ -6,21 +6,6 @@ module: microsoft_teams.api summary: 'Entity containing quoted reply information - > [!WARNING] - - > Coming Soon - - > - - > This API is coming soon and may change in the future. - - > - - > Diagnostic: ExperimentalTeamsQuotedReplies - - > - - Create a new model by parsing and validating input data from keyword arguments. diff --git a/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.TeamDetails.yml b/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.TeamDetails.yml index 1b64ff5..17b8b49 100644 --- a/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.TeamDetails.yml +++ b/python/docs-ref-autogen/microsoft-teams-api/microsoft_teams.api.TeamDetails.yml @@ -18,16 +18,16 @@ summary: 'Details related to a team. *self* is explicitly positional-only to allow *self* as a field name.' constructor: syntax: 'TeamDetails(*, id: str, name: str | None = None, type: Literal[''standard'', - ''sharedChannel'', ''privateChannel''], aadGroupId: str | None = None, channelCount: - int | None = None, memberCount: int | None = None, tenantId: str | None = None, - **extra_data: Any)' + ''sharedChannel'', ''privateChannel''] | None = None, aadGroupId: str | None = + None, channelCount: int | None = None, memberCount: int | None = None, tenantId: + str | None = None, **extra_data: Any)' keywordOnlyParameters: - name: id isRequired: true - name: name defaultValue: None - name: type - isRequired: true + defaultValue: None - name: aadGroupId defaultValue: None - name: channelCount @@ -73,4 +73,5 @@ attributes: - uid: microsoft_teams.api.TeamDetails.type name: type summary: The type of the team. Valid values are standard, sharedChannel and privateChannel. - signature: 'type: Literal[''standard'', ''sharedChannel'', ''privateChannel'']' + signature: 'type: Literal[''standard'', ''sharedChannel'', ''privateChannel''] | + None' diff --git a/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.ActivityContext.yml b/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.ActivityContext.yml index 4ff77ac..7411bc7 100644 --- a/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.ActivityContext.yml +++ b/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.ActivityContext.yml @@ -49,22 +49,7 @@ methods: summary: 'Send a message to the conversation with a quoted message reference prepended to the text. - Teams renders the quoted message as a preview bubble above the response text. - - - > [!WARNING] - - > Coming Soon - - > - - > This API is coming soon and may change in the future. - - > - - > Diagnostic: ExperimentalTeamsQuotedReplies - - >' + Teams renders the quoted message as a preview bubble above the response text.' signature: 'async quote(message_id: str, input: str | MessageActivityInput | MessageReactionActivityInput | TypingActivityInput) -> SentActivity' parameters: diff --git a/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.HttpStream.yml b/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.HttpStream.yml index 827c63c..be4f2b8 100644 --- a/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.HttpStream.yml +++ b/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.HttpStream.yml @@ -61,6 +61,14 @@ methods: signature: clear_text() -> None - uid: microsoft_teams.apps.HttpStream.close name: close + summary: 'Finalize the current streamed message. + + + Closing is idempotent until the next emit or update. Emitting or + + updating after close starts a new streamed message using the same + + stream instance.' signature: async close() -> SentActivity | None - uid: microsoft_teams.apps.HttpStream.emit name: emit @@ -96,14 +104,18 @@ attributes: name: canceled summary: 'Whether the stream has been canceled. - For example when the user pressed the Stop button or the 2-minute timeout has - exceeded.' + For example when the user pressed the Stop button.' - uid: microsoft_teams.apps.HttpStream.closed name: closed - summary: Whether the final stream message has been sent. + summary: Whether the current streamed message has been finalized. - uid: microsoft_teams.apps.HttpStream.count name: count summary: The total number of chunks queued to be sent. - uid: microsoft_teams.apps.HttpStream.sequence name: sequence summary: The sequence number, representing the number of stream activities sent. +- uid: microsoft_teams.apps.HttpStream.timed_out + name: timed_out + summary: 'Whether the stream has timed out. + + For example when the streaming has exceeded two minutes.' diff --git a/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.StreamNotAllowedError.yml b/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.StreamNotAllowedError.yml new file mode 100644 index 0000000..8401fd2 --- /dev/null +++ b/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.StreamNotAllowedError.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonClass +uid: microsoft_teams.apps.StreamNotAllowedError +name: StreamNotAllowedError +fullName: microsoft_teams.apps.StreamNotAllowedError +module: microsoft_teams.apps +summary: Raised when streaming is not allowed for this user or bot. +constructor: + syntax: StreamNotAllowedError() diff --git a/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.StreamTimedOutError.yml b/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.StreamTimedOutError.yml new file mode 100644 index 0000000..71edf3f --- /dev/null +++ b/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.StreamTimedOutError.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonClass +uid: microsoft_teams.apps.StreamTimedOutError +name: StreamTimedOutError +fullName: microsoft_teams.apps.StreamTimedOutError +module: microsoft_teams.apps +summary: Raised when the bot failed to complete streaming within the two-minute limit. +constructor: + syntax: StreamTimedOutError() diff --git a/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.StreamerProtocol.yml b/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.StreamerProtocol.yml deleted file mode 100644 index 9bb5c2c..0000000 --- a/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.StreamerProtocol.yml +++ /dev/null @@ -1,70 +0,0 @@ -### YamlMime:PythonClass -uid: microsoft_teams.apps.StreamerProtocol -name: StreamerProtocol -fullName: microsoft_teams.apps.StreamerProtocol -module: microsoft_teams.apps -summary: Component that can send streamed chunks of an activity. -constructor: - syntax: StreamerProtocol(*args, **kwargs) -methods: -- uid: microsoft_teams.apps.StreamerProtocol.clear_text - name: clear_text - summary: Discard any text accumulated so far so the final activity is card-only. - signature: clear_text() -> None -- uid: microsoft_teams.apps.StreamerProtocol.close - name: close - summary: Close the stream. - signature: async close() -> SentActivity | None -- uid: microsoft_teams.apps.StreamerProtocol.emit - name: emit - summary: Emit an activity chunk. - signature: 'emit(activity: MessageActivityInput | TypingActivityInput | str) -> - None' - parameters: - - name: activity - isRequired: true -- uid: microsoft_teams.apps.StreamerProtocol.on_chunk - name: on_chunk - summary: Register a handler for chunk events. - signature: 'on_chunk(handler: Callable[[SentActivity], Awaitable[None]]) -> None' - parameters: - - name: handler - description: Async function that will be called for each chunk activity - isRequired: true -- uid: microsoft_teams.apps.StreamerProtocol.on_close - name: on_close - summary: Register a handler for close events. - signature: 'on_close(handler: Callable[[SentActivity], Awaitable[None]]) -> None' - parameters: - - name: handler - description: Async function that will be called when the stream closes - isRequired: true -- uid: microsoft_teams.apps.StreamerProtocol.update - name: update - summary: Send status updates before emitting (ex. "Thinking..."). - signature: 'update(text: str) -> None' - parameters: - - name: text - description: The status text to send. - isRequired: true -attributes: -- uid: microsoft_teams.apps.StreamerProtocol.canceled - name: canceled - summary: 'Whether the stream has been canceled. - - For example when the user pressed the Stop button or the 2-minute timeout has - exceeded.' -- uid: microsoft_teams.apps.StreamerProtocol.closed - name: closed - summary: Whether the final stream message has been sent. -- uid: microsoft_teams.apps.StreamerProtocol.count - name: count - summary: The total number of chunks queued to be sent. -- uid: microsoft_teams.apps.StreamerProtocol.sequence - name: sequence - summary: 'The sequence number, representing the number of stream activities sent. - - - Several chunks can be aggregated into one stream activity - - due to differences in Api rate limits.' diff --git a/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.TerminalStreamError.yml b/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.TerminalStreamError.yml new file mode 100644 index 0000000..c9f928e --- /dev/null +++ b/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.TerminalStreamError.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonClass +uid: microsoft_teams.apps.TerminalStreamError +name: TerminalStreamError +fullName: microsoft_teams.apps.TerminalStreamError +module: microsoft_teams.apps +summary: 'Base class for terminal streaming errors (HTTP 403) + + that should not be retried.' +constructor: + syntax: TerminalStreamError() diff --git a/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.yml b/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.yml index 020f0c0..d14c639 100644 --- a/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.yml +++ b/python/docs-ref-autogen/microsoft-teams-apps/microsoft_teams.apps.yml @@ -115,5 +115,7 @@ classes: - microsoft_teams.apps.StartEvent - microsoft_teams.apps.StopEvent - microsoft_teams.apps.StreamCancelledError -- microsoft_teams.apps.StreamerProtocol +- microsoft_teams.apps.StreamNotAllowedError +- microsoft_teams.apps.StreamTimedOutError +- microsoft_teams.apps.TerminalStreamError - microsoft_teams.apps.TokenValidator diff --git a/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.BotBuilderAdapter.yml b/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.BotBuilderAdapter.yml new file mode 100644 index 0000000..22c5c36 --- /dev/null +++ b/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.BotBuilderAdapter.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonClass +uid: microsoft_teams.botbuilder.BotBuilderAdapter +name: BotBuilderAdapter +fullName: microsoft_teams.botbuilder.BotBuilderAdapter +module: microsoft_teams.botbuilder +summary: HTTP server adapter that runs BotBuilder before the Teams SDK handler. +constructor: + syntax: 'BotBuilderAdapter(**options: Unpack[BotBuilderAdapterOptions])' +methods: +- uid: microsoft_teams.botbuilder.BotBuilderAdapter.register_route + name: register_route + signature: 'register_route(method: Literal[''POST''], path: str, handler: HttpRouteHandler) + -> None' + parameters: + - name: method + isRequired: true + - name: path + isRequired: true + - name: handler + isRequired: true +- uid: microsoft_teams.botbuilder.BotBuilderAdapter.serve_static + name: serve_static + signature: 'serve_static(path: str, directory: str) -> None' + parameters: + - name: path + isRequired: true + - name: directory + isRequired: true +- uid: microsoft_teams.botbuilder.BotBuilderAdapter.start + name: start + signature: 'async start(port: int) -> None' + parameters: + - name: port + isRequired: true +- uid: microsoft_teams.botbuilder.BotBuilderAdapter.stop + name: stop + signature: async stop() -> None diff --git a/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.BotBuilderAdapterOptions.yml b/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.BotBuilderAdapterOptions.yml new file mode 100644 index 0000000..6b00032 --- /dev/null +++ b/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.BotBuilderAdapterOptions.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonClass +uid: microsoft_teams.botbuilder.BotBuilderAdapterOptions +name: BotBuilderAdapterOptions +fullName: microsoft_teams.botbuilder.BotBuilderAdapterOptions +module: microsoft_teams.botbuilder +summary: Options for configuring the BotBuilder HTTP adapter. +constructor: + syntax: BotBuilderAdapterOptions() +attributes: +- uid: microsoft_teams.botbuilder.BotBuilderAdapterOptions.cloud_adapter + name: cloud_adapter + signature: 'cloud_adapter: CloudAdapter' +- uid: microsoft_teams.botbuilder.BotBuilderAdapterOptions.credentials + name: credentials + signature: 'credentials: ClientCredentials | TokenCredentials | ManagedIdentityCredentials + | FederatedIdentityCredentials' +- uid: microsoft_teams.botbuilder.BotBuilderAdapterOptions.handler + name: handler + signature: 'handler: ActivityHandler' +- uid: microsoft_teams.botbuilder.BotBuilderAdapterOptions.http_server_adapter + name: http_server_adapter + signature: 'http_server_adapter: HttpServerAdapter' diff --git a/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.BotBuilderPlugin.yml b/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.BotBuilderPlugin.yml deleted file mode 100644 index 3aef5a1..0000000 --- a/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.BotBuilderPlugin.yml +++ /dev/null @@ -1,28 +0,0 @@ -### YamlMime:PythonClass -uid: microsoft_teams.botbuilder.BotBuilderPlugin -name: BotBuilderPlugin -fullName: microsoft_teams.botbuilder.BotBuilderPlugin -module: microsoft_teams.botbuilder -summary: 'BotBuilder plugin that provides Microsoft Bot Framework integration. - - - Initialize the BotBuilder plugin.' -constructor: - syntax: 'BotBuilderPlugin(**options: Unpack[BotBuilderPluginOptions])' - parameters: - - name: options - description: Configuration options for the plugin - isRequired: true -methods: -- uid: microsoft_teams.botbuilder.BotBuilderPlugin.on_init - name: on_init - summary: Initialize the plugin when the app starts. - signature: async on_init() -> None -attributes: -- uid: microsoft_teams.botbuilder.BotBuilderPlugin.credentials - name: credentials - signature: 'credentials: ClientCredentials | TokenCredentials | ManagedIdentityCredentials - | FederatedIdentityCredentials | None' -- uid: microsoft_teams.botbuilder.BotBuilderPlugin.http_server - name: http_server - signature: 'http_server: HttpServer' diff --git a/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.BotBuilderPluginOptions.yml b/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.BotBuilderPluginOptions.yml deleted file mode 100644 index 09aa9e7..0000000 --- a/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.BotBuilderPluginOptions.yml +++ /dev/null @@ -1,15 +0,0 @@ -### YamlMime:PythonClass -uid: microsoft_teams.botbuilder.BotBuilderPluginOptions -name: BotBuilderPluginOptions -fullName: microsoft_teams.botbuilder.BotBuilderPluginOptions -module: microsoft_teams.botbuilder -summary: Options for configuring the BotBuilder plugin. -constructor: - syntax: BotBuilderPluginOptions() -attributes: -- uid: microsoft_teams.botbuilder.BotBuilderPluginOptions.adapter - name: adapter - signature: 'adapter: CloudAdapter' -- uid: microsoft_teams.botbuilder.BotBuilderPluginOptions.handler - name: handler - signature: 'handler: ActivityHandler' diff --git a/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.adapter.BotBuilderAdapter.yml b/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.adapter.BotBuilderAdapter.yml new file mode 100644 index 0000000..be4389a --- /dev/null +++ b/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.adapter.BotBuilderAdapter.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonClass +uid: microsoft_teams.botbuilder.adapter.BotBuilderAdapter +name: BotBuilderAdapter +fullName: microsoft_teams.botbuilder.adapter.BotBuilderAdapter +module: microsoft_teams.botbuilder.adapter +summary: HTTP server adapter that runs BotBuilder before the Teams SDK handler. +constructor: + syntax: 'BotBuilderAdapter(**options: Unpack[BotBuilderAdapterOptions])' +methods: +- uid: microsoft_teams.botbuilder.adapter.BotBuilderAdapter.register_route + name: register_route + signature: 'register_route(method: Literal[''POST''], path: str, handler: HttpRouteHandler) + -> None' + parameters: + - name: method + isRequired: true + - name: path + isRequired: true + - name: handler + isRequired: true +- uid: microsoft_teams.botbuilder.adapter.BotBuilderAdapter.serve_static + name: serve_static + signature: 'serve_static(path: str, directory: str) -> None' + parameters: + - name: path + isRequired: true + - name: directory + isRequired: true +- uid: microsoft_teams.botbuilder.adapter.BotBuilderAdapter.start + name: start + signature: 'async start(port: int) -> None' + parameters: + - name: port + isRequired: true +- uid: microsoft_teams.botbuilder.adapter.BotBuilderAdapter.stop + name: stop + signature: async stop() -> None diff --git a/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.adapter.BotBuilderAdapterOptions.yml b/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.adapter.BotBuilderAdapterOptions.yml new file mode 100644 index 0000000..d748881 --- /dev/null +++ b/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.adapter.BotBuilderAdapterOptions.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonClass +uid: microsoft_teams.botbuilder.adapter.BotBuilderAdapterOptions +name: BotBuilderAdapterOptions +fullName: microsoft_teams.botbuilder.adapter.BotBuilderAdapterOptions +module: microsoft_teams.botbuilder.adapter +summary: Options for configuring the BotBuilder HTTP adapter. +constructor: + syntax: BotBuilderAdapterOptions() +attributes: +- uid: microsoft_teams.botbuilder.adapter.BotBuilderAdapterOptions.cloud_adapter + name: cloud_adapter + signature: 'cloud_adapter: CloudAdapter' +- uid: microsoft_teams.botbuilder.adapter.BotBuilderAdapterOptions.credentials + name: credentials + signature: 'credentials: ClientCredentials | TokenCredentials | ManagedIdentityCredentials + | FederatedIdentityCredentials' +- uid: microsoft_teams.botbuilder.adapter.BotBuilderAdapterOptions.handler + name: handler + signature: 'handler: ActivityHandler' +- uid: microsoft_teams.botbuilder.adapter.BotBuilderAdapterOptions.http_server_adapter + name: http_server_adapter + signature: 'http_server_adapter: HttpServerAdapter' diff --git a/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.adapter.yml b/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.adapter.yml new file mode 100644 index 0000000..e9d9959 --- /dev/null +++ b/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.adapter.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonModule +uid: microsoft_teams.botbuilder.adapter +name: adapter +fullName: microsoft_teams.botbuilder.adapter +summary: 'Copyright (c) Microsoft Corporation. All rights reserved. + + Licensed under the MIT License.' +classes: +- microsoft_teams.botbuilder.adapter.BotBuilderAdapter +- microsoft_teams.botbuilder.adapter.BotBuilderAdapterOptions diff --git a/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.yml b/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.yml index 80fcc81..af965e1 100644 --- a/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.yml +++ b/python/docs-ref-autogen/microsoft-teams-botbuilder/microsoft_teams.botbuilder.yml @@ -7,5 +7,7 @@ summary: 'Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License.' type: rootImport classes: -- microsoft_teams.botbuilder.BotBuilderPlugin -- microsoft_teams.botbuilder.BotBuilderPluginOptions +- microsoft_teams.botbuilder.BotBuilderAdapter +- microsoft_teams.botbuilder.BotBuilderAdapterOptions +modules: +- microsoft_teams.botbuilder.adapter diff --git a/python/docs-ref-autogen/toc.yml b/python/docs-ref-autogen/toc.yml index a5c4ef6..c353fda 100644 --- a/python/docs-ref-autogen/toc.yml +++ b/python/docs-ref-autogen/toc.yml @@ -113,10 +113,18 @@ no-loc: - StreamCancelledError uid: microsoft_teams.apps.StreamCancelledError - - name: StreamerProtocol + - name: StreamNotAllowedError no-loc: - - StreamerProtocol - uid: microsoft_teams.apps.StreamerProtocol + - StreamNotAllowedError + uid: microsoft_teams.apps.StreamNotAllowedError + - name: StreamTimedOutError + no-loc: + - StreamTimedOutError + uid: microsoft_teams.apps.StreamTimedOutError + - name: TerminalStreamError + no-loc: + - TerminalStreamError + uid: microsoft_teams.apps.TerminalStreamError - name: TokenValidator no-loc: - TokenValidator @@ -1155,14 +1163,28 @@ - items: - name: Overview uid: microsoft_teams.botbuilder - - name: BotBuilderPlugin - no-loc: - - BotBuilderPlugin - uid: microsoft_teams.botbuilder.BotBuilderPlugin - - name: BotBuilderPluginOptions - no-loc: - - BotBuilderPluginOptions - uid: microsoft_teams.botbuilder.BotBuilderPluginOptions + - items: + - name: Overview + uid: microsoft_teams.botbuilder.adapter + - name: BotBuilderAdapter + no-loc: + - BotBuilderAdapter + uid: microsoft_teams.botbuilder.adapter.BotBuilderAdapter + - name: BotBuilderAdapterOptions + no-loc: + - BotBuilderAdapterOptions + uid: microsoft_teams.botbuilder.adapter.BotBuilderAdapterOptions + name: adapter + no-loc: + - adapter + - name: BotBuilderAdapter + no-loc: + - BotBuilderAdapter + uid: microsoft_teams.botbuilder.BotBuilderAdapter + - name: BotBuilderAdapterOptions + no-loc: + - BotBuilderAdapterOptions + uid: microsoft_teams.botbuilder.BotBuilderAdapterOptions name: microsoft_teams.botbuilder no-loc: - microsoft_teams.botbuilder diff --git a/xrefmap.yml b/xrefmap.yml index ffb7566..959f9f6 100644 --- a/xrefmap.yml +++ b/xrefmap.yml @@ -487,6 +487,10 @@ references: href: https://docs.python.org/3/library/curses.html#curses.error name: error uid: curses.error +- fullName: curses.panel.error + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.error + name: error + uid: curses.panel.error - fullName: dataclasses.FrozenInstanceError href: https://docs.python.org/3/library/dataclasses.html#dataclasses.FrozenInstanceError name: FrozenInstanceError @@ -3227,10 +3231,22 @@ references: href: https://docs.python.org/3/library/http.server.html#http.server.CGIHTTPRequestHandler.cgi_directories name: cgi_directories uid: http.server.CGIHTTPRequestHandler.cgi_directories +- fullName: http.server.HTTPServer.server_name + href: https://docs.python.org/3/library/http.server.html#http.server.HTTPServer.server_name + name: server_name + uid: http.server.HTTPServer.server_name +- fullName: http.server.HTTPServer.server_port + href: https://docs.python.org/3/library/http.server.html#http.server.HTTPServer.server_port + name: server_port + uid: http.server.HTTPServer.server_port - fullName: http.server.SimpleHTTPRequestHandler.extensions_map href: https://docs.python.org/3/library/http.server.html#http.server.SimpleHTTPRequestHandler.extensions_map name: extensions_map uid: http.server.SimpleHTTPRequestHandler.extensions_map +- fullName: http.server.SimpleHTTPRequestHandler.index_pages + href: https://docs.python.org/3/library/http.server.html#http.server.SimpleHTTPRequestHandler.index_pages + name: index_pages + uid: http.server.SimpleHTTPRequestHandler.index_pages - fullName: http.server.SimpleHTTPRequestHandler.server_version href: https://docs.python.org/3/library/http.server.html#http.server.SimpleHTTPRequestHandler.server_version name: server_version @@ -9315,54 +9331,54 @@ references: href: https://docs.python.org/3/library/ctypes.html#ctypes._CData.in_dll name: in_dll uid: ctypes._CData.in_dll -- fullName: curses.panel.Panel.above - href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.above +- fullName: curses.panel.panel.above + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.panel.above name: above - uid: curses.panel.Panel.above -- fullName: curses.panel.Panel.below - href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.below + uid: curses.panel.panel.above +- fullName: curses.panel.panel.below + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.panel.below name: below - uid: curses.panel.Panel.below -- fullName: curses.panel.Panel.bottom - href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.bottom + uid: curses.panel.panel.below +- fullName: curses.panel.panel.bottom + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.panel.bottom name: bottom - uid: curses.panel.Panel.bottom -- fullName: curses.panel.Panel.hidden - href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.hidden + uid: curses.panel.panel.bottom +- fullName: curses.panel.panel.hidden + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.panel.hidden name: hidden - uid: curses.panel.Panel.hidden -- fullName: curses.panel.Panel.hide - href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.hide + uid: curses.panel.panel.hidden +- fullName: curses.panel.panel.hide + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.panel.hide name: hide - uid: curses.panel.Panel.hide -- fullName: curses.panel.Panel.move - href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.move + uid: curses.panel.panel.hide +- fullName: curses.panel.panel.move + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.panel.move name: move - uid: curses.panel.Panel.move -- fullName: curses.panel.Panel.replace - href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.replace + uid: curses.panel.panel.move +- fullName: curses.panel.panel.replace + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.panel.replace name: replace - uid: curses.panel.Panel.replace -- fullName: curses.panel.Panel.set_userptr - href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.set_userptr + uid: curses.panel.panel.replace +- fullName: curses.panel.panel.set_userptr + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.panel.set_userptr name: set_userptr - uid: curses.panel.Panel.set_userptr -- fullName: curses.panel.Panel.show - href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.show + uid: curses.panel.panel.set_userptr +- fullName: curses.panel.panel.show + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.panel.show name: show - uid: curses.panel.Panel.show -- fullName: curses.panel.Panel.top - href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.top + uid: curses.panel.panel.show +- fullName: curses.panel.panel.top + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.panel.top name: top - uid: curses.panel.Panel.top -- fullName: curses.panel.Panel.userptr - href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.userptr + uid: curses.panel.panel.top +- fullName: curses.panel.panel.userptr + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.panel.userptr name: userptr - uid: curses.panel.Panel.userptr -- fullName: curses.panel.Panel.window - href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.window + uid: curses.panel.panel.userptr +- fullName: curses.panel.panel.window + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.panel.window name: window - uid: curses.panel.Panel.window + uid: curses.panel.panel.window - fullName: curses.textpad.Textbox.do_command href: https://docs.python.org/3/library/curses.html#curses.textpad.Textbox.do_command name: do_command @@ -12051,6 +12067,14 @@ references: href: https://docs.python.org/3/library/http.server.html#http.server.SimpleHTTPRequestHandler.do_HEAD name: do_HEAD uid: http.server.SimpleHTTPRequestHandler.do_HEAD +- fullName: http.server.SimpleHTTPRequestHandler.guess_type + href: https://docs.python.org/3/library/http.server.html#http.server.SimpleHTTPRequestHandler.guess_type + name: guess_type + uid: http.server.SimpleHTTPRequestHandler.guess_type +- fullName: http.server.SimpleHTTPRequestHandler.list_directory + href: https://docs.python.org/3/library/http.server.html#http.server.SimpleHTTPRequestHandler.list_directory + name: list_directory + uid: http.server.SimpleHTTPRequestHandler.list_directory - fullName: imaplib.IMAP4.Idler.burst href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.Idler.burst name: burst @@ -28579,70 +28603,6 @@ references: href: https://docs.python.org/3/library/token.html#token.tok_name name: tok_name uid: token.tok_name -- fullName: types.AsyncGeneratorType - href: https://docs.python.org/3/library/types.html#types.AsyncGeneratorType - name: AsyncGeneratorType - uid: types.AsyncGeneratorType -- fullName: types.BuiltinFunctionType - href: https://docs.python.org/3/library/types.html#types.BuiltinFunctionType - name: BuiltinFunctionType - uid: types.BuiltinFunctionType -- fullName: types.BuiltinMethodType - href: https://docs.python.org/3/library/types.html#types.BuiltinMethodType - name: BuiltinMethodType - uid: types.BuiltinMethodType -- fullName: types.CellType - href: https://docs.python.org/3/library/types.html#types.CellType - name: CellType - uid: types.CellType -- fullName: types.ClassMethodDescriptorType - href: https://docs.python.org/3/library/types.html#types.ClassMethodDescriptorType - name: ClassMethodDescriptorType - uid: types.ClassMethodDescriptorType -- fullName: types.CoroutineType - href: https://docs.python.org/3/library/types.html#types.CoroutineType - name: CoroutineType - uid: types.CoroutineType -- fullName: types.FrameType - href: https://docs.python.org/3/library/types.html#types.FrameType - name: FrameType - uid: types.FrameType -- fullName: types.FunctionType - href: https://docs.python.org/3/library/types.html#types.FunctionType - name: FunctionType - uid: types.FunctionType -- fullName: types.GeneratorType - href: https://docs.python.org/3/library/types.html#types.GeneratorType - name: GeneratorType - uid: types.GeneratorType -- fullName: types.GetSetDescriptorType - href: https://docs.python.org/3/library/types.html#types.GetSetDescriptorType - name: GetSetDescriptorType - uid: types.GetSetDescriptorType -- fullName: types.LambdaType - href: https://docs.python.org/3/library/types.html#types.LambdaType - name: LambdaType - uid: types.LambdaType -- fullName: types.MemberDescriptorType - href: https://docs.python.org/3/library/types.html#types.MemberDescriptorType - name: MemberDescriptorType - uid: types.MemberDescriptorType -- fullName: types.MethodDescriptorType - href: https://docs.python.org/3/library/types.html#types.MethodDescriptorType - name: MethodDescriptorType - uid: types.MethodDescriptorType -- fullName: types.MethodType - href: https://docs.python.org/3/library/types.html#types.MethodType - name: MethodType - uid: types.MethodType -- fullName: types.MethodWrapperType - href: https://docs.python.org/3/library/types.html#types.MethodWrapperType - name: MethodWrapperType - uid: types.MethodWrapperType -- fullName: types.WrapperDescriptorType - href: https://docs.python.org/3/library/types.html#types.WrapperDescriptorType - name: WrapperDescriptorType - uid: types.WrapperDescriptorType - fullName: typing.Annotated href: https://docs.python.org/3/library/typing.html#typing.Annotated name: Annotated @@ -31967,6 +31927,10 @@ references: href: https://docs.python.org/3/library/ctypes.html#ctypes.py_object name: py_object uid: ctypes.py_object +- fullName: curses.panel.panel + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.panel + name: panel + uid: curses.panel.panel - fullName: curses.textpad.Textbox href: https://docs.python.org/3/library/curses.html#curses.textpad.Textbox name: Textbox @@ -33999,26 +33963,86 @@ references: href: https://docs.python.org/3/library/functions.html#type name: type uid: type +- fullName: types.AsyncGeneratorType + href: https://docs.python.org/3/library/types.html#types.AsyncGeneratorType + name: AsyncGeneratorType + uid: types.AsyncGeneratorType +- fullName: types.BuiltinFunctionType + href: https://docs.python.org/3/library/types.html#types.BuiltinFunctionType + name: BuiltinFunctionType + uid: types.BuiltinFunctionType +- fullName: types.BuiltinMethodType + href: https://docs.python.org/3/library/types.html#types.BuiltinMethodType + name: BuiltinMethodType + uid: types.BuiltinMethodType - fullName: types.CapsuleType href: https://docs.python.org/3/library/types.html#types.CapsuleType name: CapsuleType uid: types.CapsuleType +- fullName: types.CellType + href: https://docs.python.org/3/library/types.html#types.CellType + name: CellType + uid: types.CellType +- fullName: types.ClassMethodDescriptorType + href: https://docs.python.org/3/library/types.html#types.ClassMethodDescriptorType + name: ClassMethodDescriptorType + uid: types.ClassMethodDescriptorType - fullName: types.CodeType href: https://docs.python.org/3/library/types.html#types.CodeType name: CodeType uid: types.CodeType +- fullName: types.CoroutineType + href: https://docs.python.org/3/library/types.html#types.CoroutineType + name: CoroutineType + uid: types.CoroutineType - fullName: types.EllipsisType href: https://docs.python.org/3/library/types.html#types.EllipsisType name: EllipsisType uid: types.EllipsisType +- fullName: types.FrameType + href: https://docs.python.org/3/library/types.html#types.FrameType + name: FrameType + uid: types.FrameType +- fullName: types.FunctionType + href: https://docs.python.org/3/library/types.html#types.FunctionType + name: FunctionType + uid: types.FunctionType +- fullName: types.GeneratorType + href: https://docs.python.org/3/library/types.html#types.GeneratorType + name: GeneratorType + uid: types.GeneratorType - fullName: types.GenericAlias href: https://docs.python.org/3/library/types.html#types.GenericAlias name: GenericAlias uid: types.GenericAlias +- fullName: types.GetSetDescriptorType + href: https://docs.python.org/3/library/types.html#types.GetSetDescriptorType + name: GetSetDescriptorType + uid: types.GetSetDescriptorType +- fullName: types.LambdaType + href: https://docs.python.org/3/library/types.html#types.LambdaType + name: LambdaType + uid: types.LambdaType - fullName: types.MappingProxyType href: https://docs.python.org/3/library/types.html#types.MappingProxyType name: MappingProxyType uid: types.MappingProxyType +- fullName: types.MemberDescriptorType + href: https://docs.python.org/3/library/types.html#types.MemberDescriptorType + name: MemberDescriptorType + uid: types.MemberDescriptorType +- fullName: types.MethodDescriptorType + href: https://docs.python.org/3/library/types.html#types.MethodDescriptorType + name: MethodDescriptorType + uid: types.MethodDescriptorType +- fullName: types.MethodType + href: https://docs.python.org/3/library/types.html#types.MethodType + name: MethodType + uid: types.MethodType +- fullName: types.MethodWrapperType + href: https://docs.python.org/3/library/types.html#types.MethodWrapperType + name: MethodWrapperType + uid: types.MethodWrapperType - fullName: types.ModuleType href: https://docs.python.org/3/library/types.html#types.ModuleType name: ModuleType @@ -34043,6 +34067,10 @@ references: href: https://docs.python.org/3/library/types.html#types.UnionType name: UnionType uid: types.UnionType +- fullName: types.WrapperDescriptorType + href: https://docs.python.org/3/library/types.html#types.WrapperDescriptorType + name: WrapperDescriptorType + uid: types.WrapperDescriptorType - fullName: typing.AbstractSet href: https://docs.python.org/3/library/typing.html#typing.AbstractSet name: AbstractSet