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
30 changes: 24 additions & 6 deletions nodejs/docs-ref-autogen/@microsoft/teams.api/$Activity.yml
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,10 @@ methods:
package: '@microsoft/teams.api'
summary: Add the `Generated By AI` label.
remarks: ''
isDeprecated: false
isDeprecated: true
customDeprecatedMessage: >-
Use ActivityInput/MessageActivityInput/TypingActivityInput when
constructing outbound activities.
syntax:
content: 'function addAiGenerated(): Activity<T>'
return:
Expand All @@ -294,7 +297,10 @@ methods:
package: '@microsoft/teams.api'
summary: Add citations
remarks: ''
isDeprecated: false
isDeprecated: true
customDeprecatedMessage: >-
Use ActivityInput/MessageActivityInput/TypingActivityInput when
constructing outbound activities.
syntax:
content: >-
function addCitation(position: number, appearance: CitationAppearance):
Expand Down Expand Up @@ -344,7 +350,10 @@ methods:
package: '@microsoft/teams.api'
summary: Enable message feedback.
remarks: ''
isDeprecated: false
isDeprecated: true
customDeprecatedMessage: >-
Use ActivityInput/MessageActivityInput/TypingActivityInput when
constructing outbound activities.
syntax:
content: 'function addFeedback(mode?: "default" | "custom"): Activity<T>'
parameters:
Expand Down Expand Up @@ -372,7 +381,10 @@ methods:

while still delivering the message.
remarks: ''
isDeprecated: false
isDeprecated: true
customDeprecatedMessage: >-
Use ActivityInput/MessageActivityInput/TypingActivityInput when
constructing outbound activities.
syntax:
content: 'function addTargetedMessageInfo(messageId: string): Activity<T>'
parameters:
Expand Down Expand Up @@ -448,7 +460,10 @@ methods:
package: '@microsoft/teams.api'
summary: ''
remarks: ''
isDeprecated: false
isDeprecated: true
customDeprecatedMessage: >-
Use ActivityInput/MessageActivityInput/TypingActivityInput when
constructing outbound activities.
syntax:
content: 'function withChannelData(value: ChannelData): Activity<T>'
parameters:
Expand Down Expand Up @@ -558,7 +573,10 @@ methods:
Targeted messages are ephemeral to the specified recipient in a shared
conversation.
remarks: ''
isDeprecated: false
isDeprecated: true
customDeprecatedMessage: >-
Use ActivityInput/MessageActivityInput/TypingActivityInput when
constructing outbound activities.
syntax:
content: >-
function withRecipient(value: Account<any>, isTargeted?: boolean):
Expand Down
278 changes: 278 additions & 0 deletions nodejs/docs-ref-autogen/@microsoft/teams.api/ActivityInput.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,278 @@
### YamlMime:TSType
name: ActivityInput
uid: '@microsoft/teams.api.ActivityInput'
package: '@microsoft/teams.api'
summary: Base builder for outbound activity inputs.
fullName: ActivityInput<T>
remarks: ''
isDeprecated: false
type: class
constructors:
- name: ActivityInput<T>(T, Omit<Partial<IActivityInput<T>>, "type">)
uid: '@microsoft/teams.api.ActivityInput.constructor'
package: '@microsoft/teams.api'
summary: Create an outbound activity input.
remarks: ''
isDeprecated: false
syntax:
content: >-
new ActivityInput(type: T, value?: Omit<Partial<IActivityInput<T>>,
"type">)
parameters:
- id: type
type: T
description: Activity type discriminator.
- id: value
type: >-
Omit&lt;Partial&lt;<xref uid="@microsoft/teams.api.IActivityInput"
/>&lt;T&gt;&gt;, "type"&gt;
description: Initial outbound activity fields.
properties:
- name: channelData
uid: '@microsoft/teams.api.ActivityInput.channelData'
package: '@microsoft/teams.api'
summary: Channel-specific metadata for the outbound activity.
fullName: channelData
remarks: ''
isDeprecated: false
syntax:
content: 'channelData?: ChannelData'
return:
description: ''
type: <xref uid="@microsoft/teams.api.ChannelData" />
- name: entities
uid: '@microsoft/teams.api.ActivityInput.entities'
package: '@microsoft/teams.api'
summary: Entities attached to the outbound activity.
fullName: entities
remarks: ''
isDeprecated: false
syntax:
content: 'entities?: Entity[]'
return:
description: ''
type: <xref uid="@microsoft/teams.api.Entity" />[]
- name: id
uid: '@microsoft/teams.api.ActivityInput.id'
package: '@microsoft/teams.api'
summary: Optional activity ID used when updating an existing sent activity.
fullName: id
remarks: ''
isDeprecated: false
syntax:
content: 'id?: string'
return:
description: ''
type: string
- name: recipient
uid: '@microsoft/teams.api.ActivityInput.recipient'
package: '@microsoft/teams.api'
summary: Optional recipient account.
fullName: recipient
remarks: ''
isDeprecated: false
syntax:
content: 'recipient?: Account<any>'
return:
description: ''
type: <xref uid="@microsoft/teams.api.Account" />&lt;any&gt;
- name: replyToId
uid: '@microsoft/teams.api.ActivityInput.replyToId'
package: '@microsoft/teams.api'
summary: ID of the activity this outbound activity replies to.
fullName: replyToId
remarks: ''
isDeprecated: false
syntax:
content: 'replyToId?: string'
return:
description: ''
type: string
- name: type
uid: '@microsoft/teams.api.ActivityInput.type'
package: '@microsoft/teams.api'
summary: Activity type discriminator.
fullName: type
remarks: ''
isDeprecated: false
syntax:
content: 'type: T'
return:
description: ''
type: T
methods:
- name: addAiGenerated()
uid: '@microsoft/teams.api.ActivityInput.addAiGenerated'
package: '@microsoft/teams.api'
summary: Add the `Generated By AI` label.
remarks: ''
isDeprecated: false
syntax:
content: 'function addAiGenerated(): ActivityInput<T>'
return:
description: ''
type: <xref uid="@microsoft/teams.api.ActivityInput" />&lt;T&gt;
- name: addCitation(number, CitationAppearance)
uid: '@microsoft/teams.api.ActivityInput.addCitation'
package: '@microsoft/teams.api'
summary: Add citations
remarks: ''
isDeprecated: false
syntax:
content: >-
function addCitation(position: number, appearance: CitationAppearance):
ActivityInput<T>
parameters:
- id: position
type: number
description: Citation position in the message text.
- id: appearance
type: <xref uid="@microsoft/teams.api.CitationAppearance" />
description: Citation appearance metadata.
return:
description: ''
type: <xref uid="@microsoft/teams.api.ActivityInput" />&lt;T&gt;
- name: addEntities(Entity[])
uid: '@microsoft/teams.api.ActivityInput.addEntities'
package: '@microsoft/teams.api'
summary: Add multiple entities to the outbound activity.
remarks: ''
isDeprecated: false
syntax:
content: 'function addEntities(value: Entity[]): ActivityInput<T>'
parameters:
- id: value
type: <xref uid="@microsoft/teams.api.Entity" />[]
description: Entities to add.
return:
description: ''
type: <xref uid="@microsoft/teams.api.ActivityInput" />&lt;T&gt;
- name: addEntity(Entity)
uid: '@microsoft/teams.api.ActivityInput.addEntity'
package: '@microsoft/teams.api'
summary: Add an entity to the outbound activity.
remarks: ''
isDeprecated: false
syntax:
content: 'function addEntity(value: Entity): ActivityInput<T>'
parameters:
- id: value
type: <xref uid="@microsoft/teams.api.Entity" />
description: Entity to add.
return:
description: ''
type: <xref uid="@microsoft/teams.api.ActivityInput" />&lt;T&gt;
- name: addFeedback("default" | "custom")
uid: '@microsoft/teams.api.ActivityInput.addFeedback'
package: '@microsoft/teams.api'
summary: Enable message feedback.
remarks: ''
isDeprecated: false
syntax:
content: 'function addFeedback(mode?: "default" | "custom"): ActivityInput<T>'
parameters:
- id: mode
type: '"default" | "custom"'
description: |-
`'default'` shows Teams' built-in thumbs up/down UI.
`'custom'` triggers a `message/fetchTask` invoke so the bot can return its own task module dialog.
return:
description: ''
type: <xref uid="@microsoft/teams.api.ActivityInput" />&lt;T&gt;
- name: addTargetedMessageInfo(string)
uid: '@microsoft/teams.api.ActivityInput.addTargetedMessageInfo'
package: '@microsoft/teams.api'
summary: |-
Add a targeted message info entity for prompt preview.
Skips if already present.
remarks: ''
isDeprecated: false
syntax:
content: 'function addTargetedMessageInfo(messageId: string): ActivityInput<T>'
parameters:
- id: messageId
type: string
description: |-
the message ID of the targeted message

This API is in preview and may change in the future.
Diagnostic: ExperimentalTeamsTargeted
return:
description: ''
type: <xref uid="@microsoft/teams.api.ActivityInput" />&lt;T&gt;
- name: isStreaming()
uid: '@microsoft/teams.api.ActivityInput.isStreaming'
package: '@microsoft/teams.api'
summary: Determine whether the activity contains stream metadata.
remarks: ''
isDeprecated: false
syntax:
content: 'function isStreaming(): boolean'
return:
description: ''
type: boolean
- name: withChannelData(ChannelData)
uid: '@microsoft/teams.api.ActivityInput.withChannelData'
package: '@microsoft/teams.api'
summary: Merge channel-specific metadata into the outbound activity.
remarks: ''
isDeprecated: false
syntax:
content: 'function withChannelData(value: ChannelData): ActivityInput<T>'
parameters:
- id: value
type: <xref uid="@microsoft/teams.api.ChannelData" />
description: Channel metadata to merge.
return:
description: ''
type: <xref uid="@microsoft/teams.api.ActivityInput" />&lt;T&gt;
- name: withId(string)
uid: '@microsoft/teams.api.ActivityInput.withId'
package: '@microsoft/teams.api'
summary: Set the activity ID for update scenarios.
remarks: ''
isDeprecated: false
syntax:
content: 'function withId(value: string): ActivityInput<T>'
parameters:
- id: value
type: string
description: Activity ID.
return:
description: ''
type: <xref uid="@microsoft/teams.api.ActivityInput" />&lt;T&gt;
- name: withRecipient(Account<any>, boolean)
uid: '@microsoft/teams.api.ActivityInput.withRecipient'
package: '@microsoft/teams.api'
summary: Set the activity recipient.
remarks: ''
isDeprecated: false
syntax:
content: >-
function withRecipient(value: Account<any>, isTargeted?: boolean):
ActivityInput<T>
parameters:
- id: value
type: <xref uid="@microsoft/teams.api.Account" />&lt;any&gt;
description: Recipient account.
- id: isTargeted
type: boolean
description: Whether the activity is targeted only to this recipient.
return:
description: ''
type: <xref uid="@microsoft/teams.api.ActivityInput" />&lt;T&gt;
- name: withReplyToId(string)
uid: '@microsoft/teams.api.ActivityInput.withReplyToId'
package: '@microsoft/teams.api'
summary: Set the activity ID this outbound activity replies to.
remarks: ''
isDeprecated: false
syntax:
content: 'function withReplyToId(value: string): ActivityInput<T>'
parameters:
- id: value
type: string
description: Activity ID being replied to.
return:
description: ''
type: <xref uid="@microsoft/teams.api.ActivityInput" />&lt;T&gt;
18 changes: 15 additions & 3 deletions nodejs/docs-ref-autogen/@microsoft/teams.api/ActivityLike.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,23 @@
name: ActivityLike
uid: '@microsoft/teams.api.ActivityLike'
package: '@microsoft/teams.api'
summary: |-
summary: >-
represents anything that can be transformed
into an activity in an automated way

into an activity in an automated way.


The structured-activity portion is narrowed to message/typing inputs rather
than

"any partial activity", so `send()`/`reply()`/`quote()` only accept what the
app can send.
fullName: ActivityLike
remarks: ''
isDeprecated: false
syntax: |
type ActivityLike = ActivityParams | string | IAdaptiveCard
type ActivityLike =
| IMessageActivityInput
| ITypingActivityInput
| string
| IAdaptiveCard
11 changes: 9 additions & 2 deletions nodejs/docs-ref-autogen/@microsoft/teams.api/ActivityParams.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,16 @@
name: ActivityParams
uid: '@microsoft/teams.api.ActivityParams'
package: '@microsoft/teams.api'
summary: ''
summary: >-
Payload accepted by the low-level conversation activity client.


The OUTBOUND activity union: an app only sends message or typing activity
inputs.

Kept as a named export for backwards compatibility.
fullName: ActivityParams
remarks: ''
isDeprecated: false
syntax: |
type ActivityParams = Pick<Activity, "type"> & Partial<Activity>
type ActivityParams = IMessageActivityInput | ITypingActivityInput
Loading