Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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'
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.'
Original file line number Diff line number Diff line change
@@ -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()
Original file line number Diff line number Diff line change
@@ -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()

This file was deleted.

Original file line number Diff line number Diff line change
@@ -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()
Original file line number Diff line number Diff line change
Expand Up @@ -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
Loading