diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/$Activity.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/$Activity.yml index 44be450..97438ce 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.api/$Activity.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/$Activity.yml @@ -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' return: @@ -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): @@ -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' parameters: @@ -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' parameters: @@ -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' parameters: @@ -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, isTargeted?: boolean): diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/ActivityInput.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/ActivityInput.yml new file mode 100644 index 0000000..f046ba8 --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/ActivityInput.yml @@ -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 +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ActivityInput(T, Omit>, "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>, + "type">) + parameters: + - id: type + type: T + description: Activity type discriminator. + - id: value + type: >- + Omit<Partial<<T>>, "type"> + 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: + - 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: [] + - 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' + return: + description: '' + type: <any> + - 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' + return: + description: '' + type: <T> + - 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 + parameters: + - id: position + type: number + description: Citation position in the message text. + - id: appearance + type: + description: Citation appearance metadata. + return: + description: '' + type: <T> + - 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' + parameters: + - id: value + type: [] + description: Entities to add. + return: + description: '' + type: <T> + - 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' + parameters: + - id: value + type: + description: Entity to add. + return: + description: '' + type: <T> + - 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' + 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: <T> + - 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' + 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: <T> + - 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' + parameters: + - id: value + type: + description: Channel metadata to merge. + return: + description: '' + type: <T> + - 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' + parameters: + - id: value + type: string + description: Activity ID. + return: + description: '' + type: <T> + - name: withRecipient(Account, 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, isTargeted?: boolean): + ActivityInput + parameters: + - id: value + type: <any> + description: Recipient account. + - id: isTargeted + type: boolean + description: Whether the activity is targeted only to this recipient. + return: + description: '' + type: <T> + - 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' + parameters: + - id: value + type: string + description: Activity ID being replied to. + return: + description: '' + type: <T> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/ActivityLike.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/ActivityLike.yml index eb3fbcd..739cb94 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.api/ActivityLike.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/ActivityLike.yml @@ -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 diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/ActivityParams.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/ActivityParams.yml index a76d7e4..2d6c108 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.api/ActivityParams.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/ActivityParams.yml @@ -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 & Partial + type ActivityParams = IMessageActivityInput | ITypingActivityInput diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/BotClient.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/BotClient.yml index eb3aaab..ef0bedf 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.api/BotClient.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/BotClient.yml @@ -5,7 +5,8 @@ package: '@microsoft/teams.api' summary: '' fullName: BotClient remarks: '' -isDeprecated: false +isDeprecated: true +customDeprecatedMessage: The bot client is deprecated and will be removed in a future release. type: class constructors: - name: BotClient(Client | ClientOptions, Partial) diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/Client.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/Client.yml index b453d0f..d47b9da 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.api/Client.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/Client.yml @@ -45,7 +45,7 @@ properties: remarks: '' isDeprecated: false syntax: - content: 'bots: BotClient' + content: BotClient bots return: description: '' type: @@ -93,7 +93,7 @@ properties: remarks: '' isDeprecated: false syntax: - content: 'reactions: ReactionClient' + content: ReactionClient reactions return: description: '' type: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/ConversationActivityClient.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/ConversationActivityClient.yml index 0c61df3..048de32 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.api/ConversationActivityClient.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/ConversationActivityClient.yml @@ -59,7 +59,7 @@ properties: type: string methods: - name: create(string, ActivityParams) - uid: '@microsoft/teams.api.ConversationActivityClient.create' + uid: '@microsoft/teams.api.ConversationActivityClient.create_1' package: '@microsoft/teams.api' summary: '' remarks: '' @@ -78,8 +78,49 @@ methods: return: description: '' type: Promise<> + - name: create(string, ActivityParamsLike) + uid: '@microsoft/teams.api.ConversationActivityClient.create_2' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function create(conversationId: string, params: ActivityParamsLike): + Promise + parameters: + - id: conversationId + type: string + description: '' + - id: params + type: ActivityParamsLike + description: '' + return: + description: '' + type: Promise<> + - name: create(string, DeprecatedInputActivity) + uid: '@microsoft/teams.api.ConversationActivityClient.create' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function create(conversationId: string, params: + DeprecatedInputActivity): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> - name: createTargeted(string, ActivityParams) - uid: '@microsoft/teams.api.ConversationActivityClient.createTargeted' + uid: '@microsoft/teams.api.ConversationActivityClient.createTargeted_1' package: '@microsoft/teams.api' summary: '' remarks: '' @@ -98,6 +139,47 @@ methods: return: description: '' type: Promise<> + - name: createTargeted(string, ActivityParamsLike) + uid: '@microsoft/teams.api.ConversationActivityClient.createTargeted_2' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function createTargeted(conversationId: string, params: + ActivityParamsLike): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: params + type: ActivityParamsLike + description: '' + return: + description: '' + type: Promise<> + - name: createTargeted(string, DeprecatedInputActivity) + uid: '@microsoft/teams.api.ConversationActivityClient.createTargeted' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function createTargeted(conversationId: string, params: + DeprecatedInputActivity): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> - name: delete(string, string) uid: '@microsoft/teams.api.ConversationActivityClient.delete' package: '@microsoft/teams.api' @@ -159,7 +241,7 @@ methods: Promise<<any>[]> - name: reply(string, string, ActivityParams) - uid: '@microsoft/teams.api.ConversationActivityClient.reply' + uid: '@microsoft/teams.api.ConversationActivityClient.reply_1' package: '@microsoft/teams.api' summary: '' remarks: '' @@ -181,8 +263,55 @@ methods: return: description: '' type: Promise<> + - name: reply(string, string, ActivityParamsLike) + uid: '@microsoft/teams.api.ConversationActivityClient.reply_2' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function reply(conversationId: string, id: string, params: + ActivityParamsLike): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: id + type: string + description: '' + - id: params + type: ActivityParamsLike + description: '' + return: + description: '' + type: Promise<> + - name: reply(string, string, DeprecatedInputActivity) + uid: '@microsoft/teams.api.ConversationActivityClient.reply' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function reply(conversationId: string, id: string, params: + DeprecatedInputActivity): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: id + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> - name: update(string, string, ActivityParams) - uid: '@microsoft/teams.api.ConversationActivityClient.update' + uid: '@microsoft/teams.api.ConversationActivityClient.update_1' package: '@microsoft/teams.api' summary: '' remarks: '' @@ -204,8 +333,55 @@ methods: return: description: '' type: Promise<> + - name: update(string, string, ActivityParamsLike) + uid: '@microsoft/teams.api.ConversationActivityClient.update_2' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function update(conversationId: string, id: string, params: + ActivityParamsLike): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: id + type: string + description: '' + - id: params + type: ActivityParamsLike + description: '' + return: + description: '' + type: Promise<> + - name: update(string, string, DeprecatedInputActivity) + uid: '@microsoft/teams.api.ConversationActivityClient.update' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function update(conversationId: string, id: string, params: + DeprecatedInputActivity): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: id + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> - name: updateTargeted(string, string, ActivityParams) - uid: '@microsoft/teams.api.ConversationActivityClient.updateTargeted' + uid: '@microsoft/teams.api.ConversationActivityClient.updateTargeted_1' package: '@microsoft/teams.api' summary: '' remarks: '' @@ -227,3 +403,50 @@ methods: return: description: '' type: Promise<> + - name: updateTargeted(string, string, ActivityParamsLike) + uid: '@microsoft/teams.api.ConversationActivityClient.updateTargeted_2' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function updateTargeted(conversationId: string, id: string, params: + ActivityParamsLike): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: id + type: string + description: '' + - id: params + type: ActivityParamsLike + description: '' + return: + description: '' + type: Promise<> + - name: updateTargeted(string, string, DeprecatedInputActivity) + uid: '@microsoft/teams.api.ConversationActivityClient.updateTargeted' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function updateTargeted(conversationId: string, id: string, params: + DeprecatedInputActivity): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: id + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/ConversationClient.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/ConversationClient.yml index 3d85667..b665236 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.api/ConversationClient.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/ConversationClient.yml @@ -63,34 +63,45 @@ methods: package: '@microsoft/teams.api' summary: '' remarks: '' + isDeprecated: true + customDeprecatedMessage: |- + Use the flattened activity methods on `ConversationClient` + instead (e.g. `conversations.createActivity(conversationId, ...)`). This + grouped accessor will be removed in a future release. + syntax: + content: >- + function activities(conversationId: string): + IConversationActivityOperations + parameters: + - id: conversationId + type: string + description: '' + return: + description: '' + type: + - name: addReaction(string, string, MessageReactionType) + uid: '@microsoft/teams.api.ConversationClient.addReaction' + package: '@microsoft/teams.api' + summary: Add a reaction to an activity in a conversation. + remarks: '' isDeprecated: false syntax: content: >- - function activities(conversationId: string): { create: (params: - ActivityParams) => Promise, createTargeted: (params: - ActivityParams) => Promise, delete: (id: string) => - Promise, deleteTargeted: (id: string) => Promise, members: - (activityId: string) => Promise[]>, reply: (id: - string, params: ActivityParams) => Promise, update: (id: - string, params: ActivityParams) => Promise, updateTargeted: - (id: string, params: ActivityParams) => Promise } + function addReaction(conversationId: string, activityId: string, + reactionType: MessageReactionType): Promise parameters: - id: conversationId type: string description: '' + - id: activityId + type: string + description: '' + - id: reactionType + type: + description: '' return: description: '' - type: >- - { create: (params: ActivityParams) => Promise<Resource>, - createTargeted: (params: ActivityParams) => - Promise<Resource>, delete: (id: string) => - Promise<void>, deleteTargeted: (id: string) => - Promise<void>, members: (activityId: string) => - Promise<TeamsChannelAccount<any>[]>, reply: (id: string, - params: ActivityParams) => Promise<Resource>, update: (id: - string, params: ActivityParams) => Promise<Resource>, - updateTargeted: (id: string, params: ActivityParams) => - Promise<Resource> } + type: Promise<void> - name: create(CreateConversationParams) uid: '@microsoft/teams.api.ConversationClient.create' package: '@microsoft/teams.api' @@ -110,6 +121,151 @@ methods: type: >- Promise<> + - name: createActivity(string, ActivityParams) + uid: '@microsoft/teams.api.ConversationClient.createActivity_1' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function createActivity(conversationId: string, params: ActivityParams): + Promise + parameters: + - id: conversationId + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: createActivity(string, DeprecatedInputActivity) + uid: '@microsoft/teams.api.ConversationClient.createActivity' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function createActivity(conversationId: string, params: + DeprecatedInputActivity): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: createTargetedActivity(string, ActivityParams) + uid: '@microsoft/teams.api.ConversationClient.createTargetedActivity_1' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function createTargetedActivity(conversationId: string, params: + ActivityParams): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: createTargetedActivity(string, DeprecatedInputActivity) + uid: '@microsoft/teams.api.ConversationClient.createTargetedActivity' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function createTargetedActivity(conversationId: string, params: + DeprecatedInputActivity): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: deleteActivity(string, string) + uid: '@microsoft/teams.api.ConversationClient.deleteActivity' + package: '@microsoft/teams.api' + summary: Delete an activity in a conversation. + remarks: '' + isDeprecated: false + syntax: + content: >- + function deleteActivity(conversationId: string, id: string): + Promise + parameters: + - id: conversationId + type: string + description: '' + - id: id + type: string + description: '' + return: + description: '' + type: Promise<void> + - name: deleteReaction(string, string, MessageReactionType) + uid: '@microsoft/teams.api.ConversationClient.deleteReaction' + package: '@microsoft/teams.api' + summary: Delete a reaction from an activity in a conversation. + remarks: '' + isDeprecated: false + syntax: + content: >- + function deleteReaction(conversationId: string, activityId: string, + reactionType: MessageReactionType): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: activityId + type: string + description: '' + - id: reactionType + type: + description: '' + return: + description: '' + type: Promise<void> + - name: deleteTargetedActivity(string, string) + uid: '@microsoft/teams.api.ConversationClient.deleteTargetedActivity' + package: '@microsoft/teams.api' + summary: Delete a targeted activity in a conversation. + remarks: '' + isDeprecated: false + syntax: + content: >- + function deleteTargetedActivity(conversationId: string, id: string): + Promise + parameters: + - id: conversationId + type: string + description: '' + - id: id + type: string + description: '' + return: + description: '' + type: Promise<void> - name: get(GetConversationsParams) uid: '@microsoft/teams.api.ConversationClient.get' package: '@microsoft/teams.api' @@ -130,12 +286,102 @@ methods: type: >- Promise<> + - name: getActivityMembers(string, string) + uid: '@microsoft/teams.api.ConversationClient.getActivityMembers' + package: '@microsoft/teams.api' + summary: Get the members of an activity in a conversation. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getActivityMembers(conversationId: string, id: string): + Promise[]> + parameters: + - id: conversationId + type: string + description: '' + - id: id + type: string + description: '' + return: + description: '' + type: >- + Promise<<any>[]> + - name: getMemberById(string, string) + uid: '@microsoft/teams.api.ConversationClient.getMemberById' + package: '@microsoft/teams.api' + summary: Get a member of a conversation by id. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getMemberById(conversationId: string, id: string): + Promise> + parameters: + - id: conversationId + type: string + description: '' + - id: id + type: string + description: '' + return: + description: '' + type: >- + Promise<<any>> + - name: getMembers(string) + uid: '@microsoft/teams.api.ConversationClient.getMembers' + package: '@microsoft/teams.api' + summary: Get the members of a conversation. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getMembers(conversationId: string): + Promise[]> + parameters: + - id: conversationId + type: string + description: '' + return: + description: '' + type: >- + Promise<<any>[]> + - name: getPagedMembers(string, number, string) + uid: '@microsoft/teams.api.ConversationClient.getPagedMembers' + package: '@microsoft/teams.api' + summary: Get paged members of a conversation. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getPagedMembers(conversationId: string, pageSize?: number, + continuationToken?: string): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: pageSize + type: number + description: '' + - id: continuationToken + type: string + description: '' + return: + description: '' + type: Promise<> - name: members(string) uid: '@microsoft/teams.api.ConversationClient.members' package: '@microsoft/teams.api' summary: '' remarks: '' - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: |- + Use the flattened member methods on `ConversationClient` + instead (e.g. `conversations.getMembers(conversationId)`). This grouped + accessor will be removed in a future release. syntax: content: >- function members(conversationId: string): { delete: (id: string) => @@ -154,3 +400,144 @@ methods: => Promise<TeamsChannelAccount<any>>, getPaged: (pageSize?: number, continuationToken?: string) => Promise<PagedMembersResult> } + - name: replyToActivity(string, string, ActivityParams) + uid: '@microsoft/teams.api.ConversationClient.replyToActivity_1' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function replyToActivity(conversationId: string, id: string, params: + ActivityParams): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: id + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: replyToActivity(string, string, DeprecatedInputActivity) + uid: '@microsoft/teams.api.ConversationClient.replyToActivity' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function replyToActivity(conversationId: string, id: string, params: + DeprecatedInputActivity): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: id + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: updateActivity(string, string, ActivityParams) + uid: '@microsoft/teams.api.ConversationClient.updateActivity_1' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function updateActivity(conversationId: string, id: string, params: + ActivityParams): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: id + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: updateActivity(string, string, DeprecatedInputActivity) + uid: '@microsoft/teams.api.ConversationClient.updateActivity' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function updateActivity(conversationId: string, id: string, params: + DeprecatedInputActivity): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: id + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: updateTargetedActivity(string, string, ActivityParams) + uid: '@microsoft/teams.api.ConversationClient.updateTargetedActivity_1' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function updateTargetedActivity(conversationId: string, id: string, + params: ActivityParams): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: id + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: updateTargetedActivity(string, string, DeprecatedInputActivity) + uid: '@microsoft/teams.api.ConversationClient.updateTargetedActivity' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function updateTargetedActivity(conversationId: string, id: string, + params: DeprecatedInputActivity): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: id + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/DeprecatedInputActivity.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/DeprecatedInputActivity.yml new file mode 100644 index 0000000..f43400d --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/DeprecatedInputActivity.yml @@ -0,0 +1,18 @@ +### YamlMime:TSTypeAlias +name: DeprecatedInputActivity +uid: '@microsoft/teams.api.DeprecatedInputActivity' +package: '@microsoft/teams.api' +summary: >- + Legacy full activity builders that are still accepted as send input while + callers + + migrate to the outbound input builders. +fullName: DeprecatedInputActivity +remarks: '' +isDeprecated: true +customDeprecatedMessage: >- + Use [IMessageActivityInput](xref:@microsoft/teams.api.IMessageActivityInput) + or [ITypingActivityInput](xref:@microsoft/teams.api.ITypingActivityInput) + instead. +syntax: | + type DeprecatedInputActivity = MessageActivity | TypingActivity diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/IActivityInput.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/IActivityInput.yml new file mode 100644 index 0000000..34a629f --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/IActivityInput.yml @@ -0,0 +1,96 @@ +### YamlMime:TSType +name: IActivityInput +uid: '@microsoft/teams.api.IActivityInput' +package: '@microsoft/teams.api' +summary: >- + Base shape for an OUTBOUND activity the app constructs and sends. + + + This is intentionally not derived from all of + [IActivity](xref:@microsoft/teams.api.IActivity): inbound/server-filled + + fields such as `from`, `conversation`, `channelId`, `serviceUrl`, and + timestamps are + + filled by the sender or service, not by callers constructing outbound input. +fullName: IActivityInput +remarks: '' +isDeprecated: false +type: interface +properties: + - name: channelData + uid: '@microsoft/teams.api.IActivityInput.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: + - name: entities + uid: '@microsoft/teams.api.IActivityInput.entities' + package: '@microsoft/teams.api' + summary: Entities attached to the outbound activity. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + - name: id + uid: '@microsoft/teams.api.IActivityInput.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.IActivityInput.recipient' + package: '@microsoft/teams.api' + summary: >- + Optional recipient account. Set `isTargeted` through + [withRecipient](xref:@microsoft/teams.api.ActivityInput.withRecipient) + + when sending a targeted message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient?: Account' + return: + description: '' + type: <any> + - name: replyToId + uid: '@microsoft/teams.api.IActivityInput.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.IActivityInput.type' + package: '@microsoft/teams.api' + summary: Activity type discriminator. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: T' + return: + description: '' + type: T diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/IConversationActivityOperations.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/IConversationActivityOperations.yml new file mode 100644 index 0000000..f05ca85 --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/IConversationActivityOperations.yml @@ -0,0 +1,242 @@ +### YamlMime:TSType +name: IConversationActivityOperations +uid: '@microsoft/teams.api.IConversationActivityOperations' +package: '@microsoft/teams.api' +summary: '' +fullName: IConversationActivityOperations +remarks: '' +isDeprecated: false +type: interface +methods: + - name: create(ActivityParams) + uid: '@microsoft/teams.api.IConversationActivityOperations.create_1' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function create(params: ActivityParams): Promise' + parameters: + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: create(DeprecatedInputActivity) + uid: '@microsoft/teams.api.IConversationActivityOperations.create' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: 'function create(params: DeprecatedInputActivity): Promise' + parameters: + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: createTargeted(ActivityParams) + uid: '@microsoft/teams.api.IConversationActivityOperations.createTargeted_1' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function createTargeted(params: ActivityParams): Promise' + parameters: + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: createTargeted(DeprecatedInputActivity) + uid: '@microsoft/teams.api.IConversationActivityOperations.createTargeted' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function createTargeted(params: DeprecatedInputActivity): + Promise + parameters: + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: delete(string) + uid: '@microsoft/teams.api.IConversationActivityOperations.delete' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function delete(id: string): Promise' + parameters: + - id: id + type: string + description: '' + return: + description: '' + type: Promise<void> + - name: deleteTargeted(string) + uid: '@microsoft/teams.api.IConversationActivityOperations.deleteTargeted' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function deleteTargeted(id: string): Promise' + parameters: + - id: id + type: string + description: '' + return: + description: '' + type: Promise<void> + - name: members(string) + uid: '@microsoft/teams.api.IConversationActivityOperations.members' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function members(activityId: string): + Promise[]> + parameters: + - id: activityId + type: string + description: '' + return: + description: '' + type: >- + Promise<<any>[]> + - name: reply(string, ActivityParams) + uid: '@microsoft/teams.api.IConversationActivityOperations.reply_1' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function reply(id: string, params: ActivityParams): Promise' + parameters: + - id: id + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: reply(string, DeprecatedInputActivity) + uid: '@microsoft/teams.api.IConversationActivityOperations.reply' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function reply(id: string, params: DeprecatedInputActivity): + Promise + parameters: + - id: id + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: update(string, ActivityParams) + uid: '@microsoft/teams.api.IConversationActivityOperations.update_1' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function update(id: string, params: ActivityParams): Promise' + parameters: + - id: id + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: update(string, DeprecatedInputActivity) + uid: '@microsoft/teams.api.IConversationActivityOperations.update' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function update(id: string, params: DeprecatedInputActivity): + Promise + parameters: + - id: id + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: updateTargeted(string, ActivityParams) + uid: '@microsoft/teams.api.IConversationActivityOperations.updateTargeted_1' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function updateTargeted(id: string, params: ActivityParams): + Promise + parameters: + - id: id + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: updateTargeted(string, DeprecatedInputActivity) + uid: '@microsoft/teams.api.IConversationActivityOperations.updateTargeted' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function updateTargeted(id: string, params: DeprecatedInputActivity): + Promise + parameters: + - id: id + type: string + description: '' + - id: params + type: + description: '' + return: + description: '' + type: Promise<> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/IMessageActivity.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/IMessageActivity.yml index 4faca0b..120b9ec 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.api/IMessageActivity.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/IMessageActivity.yml @@ -206,7 +206,8 @@ properties: package: '@microsoft/teams.api' summary: >- Format of text fields Default:markdown. Possible values include: - 'markdown', 'plain', 'xml' + 'markdown', 'plain', 'xml', 'extendedmarkdown'. See + [TextFormat](xref:@microsoft/teams.api.TextFormat) for all values fullName: textFormat remarks: '' isDeprecated: false @@ -493,11 +494,7 @@ methods: - name: getQuotedMessages() uid: '@microsoft/teams.api.IMessageActivity.getQuotedMessages' package: '@microsoft/teams.api' - summary: |- - get all quoted reply entities from this message - - This API is coming soon and may change in the future. - Diagnostic: ExperimentalTeamsQuotedReplies + summary: get all quoted reply entities from this message remarks: '' isDeprecated: false syntax: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/IMessageActivityInput.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/IMessageActivityInput.yml new file mode 100644 index 0000000..f30c682 --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/IMessageActivityInput.yml @@ -0,0 +1,188 @@ +### YamlMime:TSType +name: IMessageActivityInput +uid: '@microsoft/teams.api.IMessageActivityInput' +package: '@microsoft/teams.api' +summary: >- + OUTBOUND message activity — what the app SENDS. + + + All server-populated base fields optional (via + [IActivityInput](xref:@microsoft/teams.api.IActivityInput)) and the + + message-specific fields optional too, so both a plain `{ type: 'message', text + }` + + literal and a + [MessageActivityInput](xref:@microsoft/teams.api.MessageActivityInput) builder + instance are assignable. The message + + fields are copied here instead of derived from + [IMessageActivity](xref:@microsoft/teams.api.IMessageActivity), keeping the + + outbound input shape independent from the inbound activity interface. Use + + [MessageActivityInputOptions](xref:@microsoft/teams.api.MessageActivityInputOptions) + to include unmodeled extension fields when constructing + + a [MessageActivityInput](xref:@microsoft/teams.api.MessageActivityInput). +fullName: IMessageActivityInput +remarks: '' +isDeprecated: false +type: interface +properties: + - name: attachmentLayout + uid: '@microsoft/teams.api.IMessageActivityInput.attachmentLayout' + package: '@microsoft/teams.api' + summary: Layout hint for multiple attachments. + fullName: attachmentLayout + remarks: '' + isDeprecated: false + syntax: + content: 'attachmentLayout?: AttachmentLayout' + return: + description: '' + type: + - name: attachments + uid: '@microsoft/teams.api.IMessageActivityInput.attachments' + package: '@microsoft/teams.api' + summary: Attachments sent with the message. + fullName: attachments + remarks: '' + isDeprecated: false + syntax: + content: 'attachments?: Attachment[]' + return: + description: '' + type: [] + - name: suggestedActions + uid: '@microsoft/teams.api.IMessageActivityInput.suggestedActions' + package: '@microsoft/teams.api' + summary: Suggested actions presented with the message. + fullName: suggestedActions + remarks: '' + isDeprecated: false + syntax: + content: 'suggestedActions?: SuggestedActions' + return: + description: '' + type: + - name: text + uid: '@microsoft/teams.api.IMessageActivityInput.text' + package: '@microsoft/teams.api' + summary: Message text. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text?: string' + return: + description: '' + type: string + - name: textFormat + uid: '@microsoft/teams.api.IMessageActivityInput.textFormat' + package: '@microsoft/teams.api' + summary: Format of the message text. + fullName: textFormat + remarks: '' + isDeprecated: false + syntax: + content: 'textFormat?: TextFormat' + return: + description: '' + type: +inheritedProperties: + - name: channelData + uid: '@microsoft/teams.api.IMessageActivityInput.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: + inheritanceDescription: >- + Inherited From + [IActivityInput.channelData](xref:@microsoft/teams.api.IActivityInput.channelData) + - name: entities + uid: '@microsoft/teams.api.IMessageActivityInput.entities' + package: '@microsoft/teams.api' + summary: Entities attached to the outbound activity. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivityInput.entities](xref:@microsoft/teams.api.IActivityInput.entities) + - name: id + uid: '@microsoft/teams.api.IMessageActivityInput.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 + inheritanceDescription: >- + Inherited From + [IActivityInput.id](xref:@microsoft/teams.api.IActivityInput.id) + - name: recipient + uid: '@microsoft/teams.api.IMessageActivityInput.recipient' + package: '@microsoft/teams.api' + summary: >- + Optional recipient account. Set `isTargeted` through + [withRecipient](xref:@microsoft/teams.api.ActivityInput.withRecipient) + + when sending a targeted message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient?: Account' + return: + description: '' + type: <any> + inheritanceDescription: >- + Inherited From + [IActivityInput.recipient](xref:@microsoft/teams.api.IActivityInput.recipient) + - name: replyToId + uid: '@microsoft/teams.api.IMessageActivityInput.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 + inheritanceDescription: >- + Inherited From + [IActivityInput.replyToId](xref:@microsoft/teams.api.IActivityInput.replyToId) + - name: type + uid: '@microsoft/teams.api.IMessageActivityInput.type' + package: '@microsoft/teams.api' + summary: Activity type discriminator. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "message"' + return: + description: '' + type: '"message"' + inheritanceDescription: >- + Inherited From + [IActivityInput.type](xref:@microsoft/teams.api.IActivityInput.type) +extends: <"message"> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/ITypingActivityInput.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/ITypingActivityInput.yml new file mode 100644 index 0000000..1f410f9 --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/ITypingActivityInput.yml @@ -0,0 +1,139 @@ +### YamlMime:TSType +name: ITypingActivityInput +uid: '@microsoft/teams.api.ITypingActivityInput' +package: '@microsoft/teams.api' +summary: >- + OUTBOUND typing activity — the typing indicator the app SENDS. + + + All server-populated base fields optional (via + [IActivityInput](xref:@microsoft/teams.api.IActivityInput)) and the + + typing-specific fields optional too, so both a plain `{ type: 'typing' }` + literal + + and a [TypingActivityInput](xref:@microsoft/teams.api.TypingActivityInput) + builder instance are assignable. The typing fields are + + copied here instead of derived from + [ITypingActivity](xref:@microsoft/teams.api.ITypingActivity), keeping the + outbound input + + shape independent from the inbound activity interface. Use + [TypingActivityInputOptions](xref:@microsoft/teams.api.TypingActivityInputOptions) + + to include unmodeled extension fields when constructing a + [TypingActivityInput](xref:@microsoft/teams.api.TypingActivityInput). +fullName: ITypingActivityInput +remarks: '' +isDeprecated: false +type: interface +properties: + - name: text + uid: '@microsoft/teams.api.ITypingActivityInput.text' + package: '@microsoft/teams.api' + summary: Text used by streaming updates. Ordinary typing indicators can omit this. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text?: string' + return: + description: '' + type: string +inheritedProperties: + - name: channelData + uid: '@microsoft/teams.api.ITypingActivityInput.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: + inheritanceDescription: >- + Inherited From + [IActivityInput.channelData](xref:@microsoft/teams.api.IActivityInput.channelData) + - name: entities + uid: '@microsoft/teams.api.ITypingActivityInput.entities' + package: '@microsoft/teams.api' + summary: Entities attached to the outbound activity. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivityInput.entities](xref:@microsoft/teams.api.IActivityInput.entities) + - name: id + uid: '@microsoft/teams.api.ITypingActivityInput.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 + inheritanceDescription: >- + Inherited From + [IActivityInput.id](xref:@microsoft/teams.api.IActivityInput.id) + - name: recipient + uid: '@microsoft/teams.api.ITypingActivityInput.recipient' + package: '@microsoft/teams.api' + summary: >- + Optional recipient account. Set `isTargeted` through + [withRecipient](xref:@microsoft/teams.api.ActivityInput.withRecipient) + + when sending a targeted message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient?: Account' + return: + description: '' + type: <any> + inheritanceDescription: >- + Inherited From + [IActivityInput.recipient](xref:@microsoft/teams.api.IActivityInput.recipient) + - name: replyToId + uid: '@microsoft/teams.api.ITypingActivityInput.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 + inheritanceDescription: >- + Inherited From + [IActivityInput.replyToId](xref:@microsoft/teams.api.IActivityInput.replyToId) + - name: type + uid: '@microsoft/teams.api.ITypingActivityInput.type' + package: '@microsoft/teams.api' + summary: Activity type discriminator. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "typing"' + return: + description: '' + type: '"typing"' + inheritanceDescription: >- + Inherited From + [IActivityInput.type](xref:@microsoft/teams.api.IActivityInput.type) +extends: <"typing"> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageActivity.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageActivity.yml index 0a57484..c7910b4 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageActivity.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageActivity.yml @@ -238,7 +238,8 @@ properties: package: '@microsoft/teams.api' summary: >- Format of text fields Default:markdown. Possible values include: - 'markdown', 'plain', 'xml' + 'markdown', 'plain', 'xml', 'extendedmarkdown'. See + [TextFormat](xref:@microsoft/teams.api.TextFormat) for all values fullName: textFormat remarks: '' isDeprecated: false @@ -497,7 +498,10 @@ inheritedMethods: 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(): MessageActivity' return: @@ -511,7 +515,10 @@ inheritedMethods: 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): @@ -570,7 +577,10 @@ inheritedMethods: 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"): MessageActivity' parameters: @@ -601,7 +611,10 @@ inheritedMethods: 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): MessageActivity' parameters: @@ -638,7 +651,10 @@ inheritedMethods: 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): MessageActivity' parameters: @@ -893,11 +909,7 @@ methods: type: string description: Optional text, appended to the quoted message placeholder return: - description: |- - this instance for chaining - - This API is coming soon and may change in the future. - Diagnostic: ExperimentalTeamsQuotedReplies + description: this instance for chaining type: - name: addStreamFinal() uid: '@microsoft/teams.api.MessageActivity.addStreamFinal' @@ -979,11 +991,7 @@ methods: - name: getQuotedMessages() uid: '@microsoft/teams.api.MessageActivity.getQuotedMessages' package: '@microsoft/teams.api' - summary: |- - get all quoted reply entities from this message - - This API is coming soon and may change in the future. - Diagnostic: ExperimentalTeamsQuotedReplies + summary: get all quoted reply entities from this message remarks: '' isDeprecated: false syntax: @@ -1015,11 +1023,7 @@ methods: parameters: - id: messageId type: string - description: |- - The IC3 message ID of the message to quote - - This API is coming soon and may change in the future. - Diagnostic: ExperimentalTeamsQuotedReplies + description: The IC3 message ID of the message to quote return: description: '' type: @@ -1178,7 +1182,6 @@ methods: description: |- this instance for chaining - This API is coming soon and may change in the future. Diagnostic: ExperimentalTeamsTargeted type: - name: withSpeak(string) @@ -1247,7 +1250,8 @@ methods: package: '@microsoft/teams.api' summary: >- Format of text fields Default:markdown. Possible values include: - 'markdown', 'plain', 'xml' + 'markdown', 'plain', 'xml', 'extendedmarkdown'. See + [TextFormat](xref:@microsoft/teams.api.TextFormat) for all values remarks: '' isDeprecated: false syntax: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageActivityInput.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageActivityInput.yml new file mode 100644 index 0000000..3f15e29 --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageActivityInput.yml @@ -0,0 +1,632 @@ +### YamlMime:TSType +name: MessageActivityInput +uid: '@microsoft/teams.api.MessageActivityInput' +package: '@microsoft/teams.api' +summary: Builder for outbound message activities. +fullName: MessageActivityInput +remarks: '' +isDeprecated: false +type: class +constructors: + - name: MessageActivityInput(string, MessageActivityInputOptions) + uid: '@microsoft/teams.api.MessageActivityInput.constructor' + package: '@microsoft/teams.api' + summary: Create an outbound message activity input. + remarks: '' + isDeprecated: false + syntax: + content: >- + new MessageActivityInput(text?: string, value?: + MessageActivityInputOptions) + parameters: + - id: text + type: string + description: Initial message text. + - id: value + type: + description: >- + Initial modeled input fields and unmodeled extension fields to + serialize. +properties: + - name: attachmentLayout + uid: '@microsoft/teams.api.MessageActivityInput.attachmentLayout' + package: '@microsoft/teams.api' + summary: Layout hint for multiple attachments. + fullName: attachmentLayout + remarks: '' + isDeprecated: false + syntax: + content: 'attachmentLayout?: AttachmentLayout' + return: + description: '' + type: + - name: attachments + uid: '@microsoft/teams.api.MessageActivityInput.attachments' + package: '@microsoft/teams.api' + summary: Attachments sent with the message. + fullName: attachments + remarks: '' + isDeprecated: false + syntax: + content: 'attachments?: Attachment[]' + return: + description: '' + type: [] + - name: suggestedActions + uid: '@microsoft/teams.api.MessageActivityInput.suggestedActions' + package: '@microsoft/teams.api' + summary: Suggested actions presented with the message. + fullName: suggestedActions + remarks: '' + isDeprecated: false + syntax: + content: 'suggestedActions?: SuggestedActions' + return: + description: '' + type: + - name: text + uid: '@microsoft/teams.api.MessageActivityInput.text' + package: '@microsoft/teams.api' + summary: Message text. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text?: string' + return: + description: '' + type: string + - name: textFormat + uid: '@microsoft/teams.api.MessageActivityInput.textFormat' + package: '@microsoft/teams.api' + summary: Format of the message text. + fullName: textFormat + remarks: '' + isDeprecated: false + syntax: + content: 'textFormat?: TextFormat' + return: + description: '' + type: +inheritedProperties: + - name: channelData + uid: '@microsoft/teams.api.MessageActivityInput.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: + inheritanceDescription: >- + Inherited From + [ActivityInput.channelData](xref:@microsoft/teams.api.ActivityInput.channelData) + - name: entities + uid: '@microsoft/teams.api.MessageActivityInput.entities' + package: '@microsoft/teams.api' + summary: Entities attached to the outbound activity. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [ActivityInput.entities](xref:@microsoft/teams.api.ActivityInput.entities) + - name: id + uid: '@microsoft/teams.api.MessageActivityInput.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 + inheritanceDescription: >- + Inherited From + [ActivityInput.id](xref:@microsoft/teams.api.ActivityInput.id) + - name: recipient + uid: '@microsoft/teams.api.MessageActivityInput.recipient' + package: '@microsoft/teams.api' + summary: Optional recipient account. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient?: Account' + return: + description: '' + type: <any> + inheritanceDescription: >- + Inherited From + [ActivityInput.recipient](xref:@microsoft/teams.api.ActivityInput.recipient) + - name: replyToId + uid: '@microsoft/teams.api.MessageActivityInput.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 + inheritanceDescription: >- + Inherited From + [ActivityInput.replyToId](xref:@microsoft/teams.api.ActivityInput.replyToId) + - name: type + uid: '@microsoft/teams.api.MessageActivityInput.type' + package: '@microsoft/teams.api' + summary: Activity type discriminator. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "message"' + return: + description: '' + type: '"message"' + inheritanceDescription: >- + Inherited From + [ActivityInput.type](xref:@microsoft/teams.api.ActivityInput.type) +inheritedMethods: + - name: addAiGenerated() + uid: '@microsoft/teams.api.MessageActivityInput.addAiGenerated' + package: '@microsoft/teams.api' + summary: Add the `Generated By AI` label. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAiGenerated(): MessageActivityInput' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ActivityInput.addAiGenerated](xref:@microsoft/teams.api.ActivityInput.addAiGenerated) + - name: addCitation(number, CitationAppearance) + uid: '@microsoft/teams.api.MessageActivityInput.addCitation' + package: '@microsoft/teams.api' + summary: Add citations + remarks: '' + isDeprecated: false + syntax: + content: >- + function addCitation(position: number, appearance: CitationAppearance): + MessageActivityInput + parameters: + - id: position + type: number + description: Citation position in the message text. + - id: appearance + type: + description: Citation appearance metadata. + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ActivityInput.addCitation](xref:@microsoft/teams.api.ActivityInput.addCitation) + - name: addEntities(Entity[]) + uid: '@microsoft/teams.api.MessageActivityInput.addEntities' + package: '@microsoft/teams.api' + summary: Add multiple entities to the outbound activity. + remarks: '' + isDeprecated: false + syntax: + content: 'function addEntities(value: Entity[]): MessageActivityInput' + parameters: + - id: value + type: [] + description: Entities to add. + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ActivityInput.addEntities](xref:@microsoft/teams.api.ActivityInput.addEntities) + - name: addEntity(Entity) + uid: '@microsoft/teams.api.MessageActivityInput.addEntity' + package: '@microsoft/teams.api' + summary: Add an entity to the outbound activity. + remarks: '' + isDeprecated: false + syntax: + content: 'function addEntity(value: Entity): MessageActivityInput' + parameters: + - id: value + type: + description: Entity to add. + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ActivityInput.addEntity](xref:@microsoft/teams.api.ActivityInput.addEntity) + - name: addFeedback("default" | "custom") + uid: '@microsoft/teams.api.MessageActivityInput.addFeedback' + package: '@microsoft/teams.api' + summary: Enable message feedback. + remarks: '' + isDeprecated: false + syntax: + content: 'function addFeedback(mode?: "default" | "custom"): MessageActivityInput' + 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: + inheritanceDescription: >- + Inherited From + [ActivityInput.addFeedback](xref:@microsoft/teams.api.ActivityInput.addFeedback) + - name: addTargetedMessageInfo(string) + uid: '@microsoft/teams.api.MessageActivityInput.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): MessageActivityInput' + 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: + inheritanceDescription: >- + Inherited From + [ActivityInput.addTargetedMessageInfo](xref:@microsoft/teams.api.ActivityInput.addTargetedMessageInfo) + - name: isStreaming() + uid: '@microsoft/teams.api.MessageActivityInput.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 + inheritanceDescription: >- + Inherited From + [ActivityInput.isStreaming](xref:@microsoft/teams.api.ActivityInput.isStreaming) + - name: withChannelData(ChannelData) + uid: '@microsoft/teams.api.MessageActivityInput.withChannelData' + package: '@microsoft/teams.api' + summary: Merge channel-specific metadata into the outbound activity. + remarks: '' + isDeprecated: false + syntax: + content: 'function withChannelData(value: ChannelData): MessageActivityInput' + parameters: + - id: value + type: + description: Channel metadata to merge. + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ActivityInput.withChannelData](xref:@microsoft/teams.api.ActivityInput.withChannelData) + - name: withId(string) + uid: '@microsoft/teams.api.MessageActivityInput.withId' + package: '@microsoft/teams.api' + summary: Set the activity ID for update scenarios. + remarks: '' + isDeprecated: false + syntax: + content: 'function withId(value: string): MessageActivityInput' + parameters: + - id: value + type: string + description: Activity ID. + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ActivityInput.withId](xref:@microsoft/teams.api.ActivityInput.withId) + - name: withRecipient(Account, boolean) + uid: '@microsoft/teams.api.MessageActivityInput.withRecipient' + package: '@microsoft/teams.api' + summary: Set the activity recipient. + remarks: '' + isDeprecated: false + syntax: + content: >- + function withRecipient(value: Account, isTargeted?: boolean): + MessageActivityInput + parameters: + - id: value + type: <any> + description: Recipient account. + - id: isTargeted + type: boolean + description: Whether the activity is targeted only to this recipient. + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ActivityInput.withRecipient](xref:@microsoft/teams.api.ActivityInput.withRecipient) + - name: withReplyToId(string) + uid: '@microsoft/teams.api.MessageActivityInput.withReplyToId' + package: '@microsoft/teams.api' + summary: Set the activity ID this outbound activity replies to. + remarks: '' + isDeprecated: false + syntax: + content: 'function withReplyToId(value: string): MessageActivityInput' + parameters: + - id: value + type: string + description: Activity ID being replied to. + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ActivityInput.withReplyToId](xref:@microsoft/teams.api.ActivityInput.withReplyToId) +methods: + - name: addAttachments(Attachment[]) + uid: '@microsoft/teams.api.MessageActivityInput.addAttachments' + package: '@microsoft/teams.api' + summary: Add attachments to the message. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAttachments(value: Attachment[]): MessageActivityInput' + parameters: + - id: value + type: [] + description: Attachments to add. + return: + description: '' + type: + - name: addCard(T, CardAttachmentTypes[T]["content"]) + uid: '@microsoft/teams.api.MessageActivityInput.addCard' + package: '@microsoft/teams.api' + summary: Add a card attachment to the message. + remarks: '' + isDeprecated: false + syntax: + content: >- + function addCard(type: T, content: + CardAttachmentTypes[T]["content"]): MessageActivityInput + parameters: + - id: type + type: T + description: Card attachment type. + - id: content + type: CardAttachmentTypes[T]["content"] + description: Card content. + return: + description: '' + type: + - name: addMention(Account, AddMentionOptions) + uid: '@microsoft/teams.api.MessageActivityInput.addMention' + package: '@microsoft/teams.api' + summary: Add a mention entity and optionally append mention text. + remarks: '' + isDeprecated: false + syntax: + content: >- + function addMention(account: Account, options?: AddMentionOptions): + MessageActivityInput + parameters: + - id: account + type: <any> + description: Account being mentioned. + - id: options + type: + description: Mention options. + return: + description: '' + type: + - name: addQuote(string, string) + uid: '@microsoft/teams.api.MessageActivityInput.addQuote' + package: '@microsoft/teams.api' + summary: >- + Add a quoted message reference and append a `` + placeholder to text. + + 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. + remarks: '' + isDeprecated: false + syntax: + content: >- + function addQuote(messageId: string, text?: string): + MessageActivityInput + parameters: + - id: messageId + type: string + description: The ID of the message to quote + - id: text + type: string + description: Optional text, appended to the quoted message placeholder + return: + description: this instance for chaining + type: + - name: addStreamFinal() + uid: '@microsoft/teams.api.MessageActivityInput.addStreamFinal' + package: '@microsoft/teams.api' + summary: Mark the message as the final activity in a stream. + remarks: '' + isDeprecated: false + syntax: + content: 'function addStreamFinal(): MessageActivityInput' + return: + description: '' + type: + - name: addText(string) + uid: '@microsoft/teams.api.MessageActivityInput.addText' + package: '@microsoft/teams.api' + summary: Append text to the message. + remarks: '' + isDeprecated: false + syntax: + content: 'function addText(value: string): MessageActivityInput' + parameters: + - id: value + type: string + description: Text to append. + return: + description: '' + type: + - name: from(IMessageActivity | IMessageActivityInput) + uid: '@microsoft/teams.api.MessageActivityInput.from_2' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function from(activity: IMessageActivity | + IMessageActivityInput): MessageActivityInput + parameters: + - id: activity + type: >- + | + description: '' + return: + description: '' + type: + - name: from(IMessageActivity) + uid: '@microsoft/teams.api.MessageActivityInput.from' + package: '@microsoft/teams.api' + summary: Copy outbound-safe fields from a message-like activity input. + remarks: '' + isDeprecated: false + syntax: + content: 'static function from(activity: IMessageActivity): MessageActivityInput' + parameters: + - id: activity + type: + description: Message input to copy. + return: + description: '' + type: + - name: from(IMessageActivityInput) + uid: '@microsoft/teams.api.MessageActivityInput.from_1' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function from(activity: IMessageActivityInput): + MessageActivityInput + parameters: + - id: activity + type: + description: '' + return: + description: '' + type: + - name: prependQuote(string) + uid: '@microsoft/teams.api.MessageActivityInput.prependQuote' + package: '@microsoft/teams.api' + summary: |- + Prepend a quotedReply entity and `` placeholder + before existing text. Used by reply()/quote() for quote-above-response. + remarks: '' + isDeprecated: false + syntax: + content: 'function prependQuote(messageId: string): MessageActivityInput' + parameters: + - id: messageId + type: string + description: The IC3 message ID of the message to quote + return: + description: '' + type: + - name: withAttachmentLayout(AttachmentLayout) + uid: '@microsoft/teams.api.MessageActivityInput.withAttachmentLayout' + package: '@microsoft/teams.api' + summary: Set the attachment layout. + remarks: '' + isDeprecated: false + syntax: + content: >- + function withAttachmentLayout(value: AttachmentLayout): + MessageActivityInput + parameters: + - id: value + type: + description: Attachment layout. + return: + description: '' + type: + - name: withSuggestedActions(SuggestedActions) + uid: '@microsoft/teams.api.MessageActivityInput.withSuggestedActions' + package: '@microsoft/teams.api' + summary: Set suggested actions for the message. + remarks: '' + isDeprecated: false + syntax: + content: >- + function withSuggestedActions(value: SuggestedActions): + MessageActivityInput + parameters: + - id: value + type: + description: Suggested actions. + return: + description: '' + type: + - name: withText(string) + uid: '@microsoft/teams.api.MessageActivityInput.withText' + package: '@microsoft/teams.api' + summary: Set the message text. + remarks: '' + isDeprecated: false + syntax: + content: 'function withText(value: string): MessageActivityInput' + parameters: + - id: value + type: string + description: Message text. + return: + description: '' + type: + - name: withTextFormat(TextFormat) + uid: '@microsoft/teams.api.MessageActivityInput.withTextFormat' + package: '@microsoft/teams.api' + summary: Set the message text format. + remarks: '' + isDeprecated: false + syntax: + content: 'function withTextFormat(value: TextFormat): MessageActivityInput' + parameters: + - id: value + type: + description: Text format. + return: + description: '' + type: +extends: <"message"> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageActivityInputOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageActivityInputOptions.yml new file mode 100644 index 0000000..e1f0801 --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageActivityInputOptions.yml @@ -0,0 +1,29 @@ +### YamlMime:TSTypeAlias +name: MessageActivityInputOptions +uid: '@microsoft/teams.api.MessageActivityInputOptions' +package: '@microsoft/teams.api' +summary: >- + Constructor fields for + [MessageActivityInput](xref:@microsoft/teams.api.MessageActivityInput). + + + This accepts modeled outbound message fields plus channel/service extension + fields that + + should serialize at the top level of the outbound activity payload. The + constructor owns + + the `type` discriminator and message `text`; pass text as the first + constructor argument + + or set it with + [withText](xref:@microsoft/teams.api.MessageActivityInput.withText). +fullName: MessageActivityInputOptions +remarks: '' +isDeprecated: false +syntax: | + type MessageActivityInputOptions = Omit< + Partial, + "type" | "text" + > & + Record diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageDeleteActivity.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageDeleteActivity.yml index ad2fcab..3954ae4 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageDeleteActivity.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageDeleteActivity.yml @@ -322,7 +322,10 @@ inheritedMethods: 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(): MessageDeleteActivity' return: @@ -336,7 +339,10 @@ inheritedMethods: 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): @@ -395,7 +401,10 @@ inheritedMethods: 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"): MessageDeleteActivity' parameters: @@ -426,7 +435,10 @@ inheritedMethods: 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): @@ -465,7 +477,10 @@ inheritedMethods: 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): MessageDeleteActivity' parameters: @@ -598,7 +613,10 @@ inheritedMethods: 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, isTargeted?: boolean): diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageReactionActivity.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageReactionActivity.yml index ad9a6d1..4c32f1c 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageReactionActivity.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageReactionActivity.yml @@ -348,7 +348,10 @@ inheritedMethods: 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(): MessageReactionActivity' return: @@ -362,7 +365,10 @@ inheritedMethods: 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): @@ -421,7 +427,10 @@ inheritedMethods: 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"): @@ -454,7 +463,10 @@ inheritedMethods: 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): @@ -493,7 +505,10 @@ inheritedMethods: 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): MessageReactionActivity' parameters: @@ -626,7 +641,10 @@ inheritedMethods: 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, isTargeted?: boolean): @@ -714,7 +732,7 @@ methods: summary: Add a message reaction. remarks: '' isDeprecated: true - customDeprecatedMessage: Use the api.reactions.add instead. + customDeprecatedMessage: Use api.conversations.addReaction instead. syntax: content: 'function addReaction(reaction: MessageReaction): MessageReactionActivity' parameters: @@ -767,7 +785,7 @@ methods: summary: Remove a message reaction. remarks: '' isDeprecated: true - customDeprecatedMessage: Use the api.reactions.delete instead. + customDeprecatedMessage: Use api.conversations.deleteReaction instead. syntax: content: >- function removeReaction(reaction: MessageReaction): diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageUpdateActivity.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageUpdateActivity.yml index b5bd2ad..96888f9 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageUpdateActivity.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/MessageUpdateActivity.yml @@ -395,7 +395,10 @@ inheritedMethods: 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(): MessageUpdateActivity' return: @@ -409,7 +412,10 @@ inheritedMethods: 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): @@ -468,7 +474,10 @@ inheritedMethods: 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"): MessageUpdateActivity' parameters: @@ -499,7 +508,10 @@ inheritedMethods: 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): @@ -538,7 +550,10 @@ inheritedMethods: 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): MessageUpdateActivity' parameters: @@ -671,7 +686,10 @@ inheritedMethods: 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, isTargeted?: boolean): diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/QuotedReplyData.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/QuotedReplyData.yml index f38d21f..8d2b820 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.api/QuotedReplyData.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/QuotedReplyData.yml @@ -2,11 +2,7 @@ name: QuotedReplyData uid: '@microsoft/teams.api.QuotedReplyData' package: '@microsoft/teams.api' -summary: |- - Data for a quoted reply entity. - - This API is coming soon and may change in the future. - Diagnostic: ExperimentalTeamsQuotedReplies +summary: Data for a quoted reply entity. fullName: QuotedReplyData remarks: '' isDeprecated: false diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/QuotedReplyEntity.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/QuotedReplyEntity.yml index 380ff72..de07053 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.api/QuotedReplyEntity.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/QuotedReplyEntity.yml @@ -2,11 +2,7 @@ name: QuotedReplyEntity uid: '@microsoft/teams.api.QuotedReplyEntity' package: '@microsoft/teams.api' -summary: |- - Entity containing quoted reply information. - - This API is coming soon and may change in the future. - Diagnostic: ExperimentalTeamsQuotedReplies +summary: Entity containing quoted reply information. fullName: QuotedReplyEntity remarks: '' isDeprecated: false diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/TeamDetails.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/TeamDetails.yml index 01c9cfe..43f69f4 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.api/TeamDetails.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/TeamDetails.yml @@ -16,5 +16,5 @@ syntax: | memberCount?: number name?: string tenantId?: string - type: "standard" | "sharedChannel" | "privateChannel" + type?: "standard" | "sharedChannel" | "privateChannel" } diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/TextFormat.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/TextFormat.yml index 159aa1d..d7738c4 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.api/TextFormat.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/TextFormat.yml @@ -7,4 +7,4 @@ fullName: TextFormat remarks: '' isDeprecated: false syntax: | - type TextFormat = "markdown" | "plain" | "xml" + type TextFormat = "markdown" | "plain" | "xml" | "extendedmarkdown" diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/TypingActivity.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/TypingActivity.yml index e231ef4..5f98545 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.api/TypingActivity.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/TypingActivity.yml @@ -333,7 +333,10 @@ inheritedMethods: 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(): TypingActivity' return: @@ -347,7 +350,10 @@ inheritedMethods: 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): @@ -406,7 +412,10 @@ inheritedMethods: 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"): TypingActivity' parameters: @@ -437,7 +446,10 @@ inheritedMethods: 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): TypingActivity' parameters: @@ -474,7 +486,10 @@ inheritedMethods: 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): TypingActivity' parameters: @@ -605,7 +620,10 @@ inheritedMethods: 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, isTargeted?: boolean): diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/TypingActivityInput.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/TypingActivityInput.yml new file mode 100644 index 0000000..72ed0fe --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/TypingActivityInput.yml @@ -0,0 +1,435 @@ +### YamlMime:TSType +name: TypingActivityInput +uid: '@microsoft/teams.api.TypingActivityInput' +package: '@microsoft/teams.api' +summary: Builder for outbound typing activities. +fullName: TypingActivityInput +remarks: '' +isDeprecated: false +type: class +constructors: + - name: TypingActivityInput(TypingActivityInputOptions) + uid: '@microsoft/teams.api.TypingActivityInput.constructor' + package: '@microsoft/teams.api' + summary: Create an outbound typing activity input. + remarks: '' + isDeprecated: false + syntax: + content: 'new TypingActivityInput(value?: TypingActivityInputOptions)' + parameters: + - id: value + type: + description: >- + Initial modeled input fields and unmodeled extension fields to + serialize. +properties: + - name: text + uid: '@microsoft/teams.api.TypingActivityInput.text' + package: '@microsoft/teams.api' + summary: Text used by streaming updates. Ordinary typing indicators can omit this. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text?: string' + return: + description: '' + type: string +inheritedProperties: + - name: channelData + uid: '@microsoft/teams.api.TypingActivityInput.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: + inheritanceDescription: >- + Inherited From + [ActivityInput.channelData](xref:@microsoft/teams.api.ActivityInput.channelData) + - name: entities + uid: '@microsoft/teams.api.TypingActivityInput.entities' + package: '@microsoft/teams.api' + summary: Entities attached to the outbound activity. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [ActivityInput.entities](xref:@microsoft/teams.api.ActivityInput.entities) + - name: id + uid: '@microsoft/teams.api.TypingActivityInput.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 + inheritanceDescription: >- + Inherited From + [ActivityInput.id](xref:@microsoft/teams.api.ActivityInput.id) + - name: recipient + uid: '@microsoft/teams.api.TypingActivityInput.recipient' + package: '@microsoft/teams.api' + summary: Optional recipient account. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient?: Account' + return: + description: '' + type: <any> + inheritanceDescription: >- + Inherited From + [ActivityInput.recipient](xref:@microsoft/teams.api.ActivityInput.recipient) + - name: replyToId + uid: '@microsoft/teams.api.TypingActivityInput.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 + inheritanceDescription: >- + Inherited From + [ActivityInput.replyToId](xref:@microsoft/teams.api.ActivityInput.replyToId) + - name: type + uid: '@microsoft/teams.api.TypingActivityInput.type' + package: '@microsoft/teams.api' + summary: Activity type discriminator. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "typing"' + return: + description: '' + type: '"typing"' + inheritanceDescription: >- + Inherited From + [ActivityInput.type](xref:@microsoft/teams.api.ActivityInput.type) +inheritedMethods: + - name: addAiGenerated() + uid: '@microsoft/teams.api.TypingActivityInput.addAiGenerated' + package: '@microsoft/teams.api' + summary: Add the `Generated By AI` label. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAiGenerated(): TypingActivityInput' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ActivityInput.addAiGenerated](xref:@microsoft/teams.api.ActivityInput.addAiGenerated) + - name: addCitation(number, CitationAppearance) + uid: '@microsoft/teams.api.TypingActivityInput.addCitation' + package: '@microsoft/teams.api' + summary: Add citations + remarks: '' + isDeprecated: false + syntax: + content: >- + function addCitation(position: number, appearance: CitationAppearance): + TypingActivityInput + parameters: + - id: position + type: number + description: Citation position in the message text. + - id: appearance + type: + description: Citation appearance metadata. + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ActivityInput.addCitation](xref:@microsoft/teams.api.ActivityInput.addCitation) + - name: addEntities(Entity[]) + uid: '@microsoft/teams.api.TypingActivityInput.addEntities' + package: '@microsoft/teams.api' + summary: Add multiple entities to the outbound activity. + remarks: '' + isDeprecated: false + syntax: + content: 'function addEntities(value: Entity[]): TypingActivityInput' + parameters: + - id: value + type: [] + description: Entities to add. + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ActivityInput.addEntities](xref:@microsoft/teams.api.ActivityInput.addEntities) + - name: addEntity(Entity) + uid: '@microsoft/teams.api.TypingActivityInput.addEntity' + package: '@microsoft/teams.api' + summary: Add an entity to the outbound activity. + remarks: '' + isDeprecated: false + syntax: + content: 'function addEntity(value: Entity): TypingActivityInput' + parameters: + - id: value + type: + description: Entity to add. + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ActivityInput.addEntity](xref:@microsoft/teams.api.ActivityInput.addEntity) + - name: addFeedback("default" | "custom") + uid: '@microsoft/teams.api.TypingActivityInput.addFeedback' + package: '@microsoft/teams.api' + summary: Enable message feedback. + remarks: '' + isDeprecated: false + syntax: + content: 'function addFeedback(mode?: "default" | "custom"): TypingActivityInput' + 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: + inheritanceDescription: >- + Inherited From + [ActivityInput.addFeedback](xref:@microsoft/teams.api.ActivityInput.addFeedback) + - name: addTargetedMessageInfo(string) + uid: '@microsoft/teams.api.TypingActivityInput.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): TypingActivityInput' + 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: + inheritanceDescription: >- + Inherited From + [ActivityInput.addTargetedMessageInfo](xref:@microsoft/teams.api.ActivityInput.addTargetedMessageInfo) + - name: isStreaming() + uid: '@microsoft/teams.api.TypingActivityInput.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 + inheritanceDescription: >- + Inherited From + [ActivityInput.isStreaming](xref:@microsoft/teams.api.ActivityInput.isStreaming) + - name: withChannelData(ChannelData) + uid: '@microsoft/teams.api.TypingActivityInput.withChannelData' + package: '@microsoft/teams.api' + summary: Merge channel-specific metadata into the outbound activity. + remarks: '' + isDeprecated: false + syntax: + content: 'function withChannelData(value: ChannelData): TypingActivityInput' + parameters: + - id: value + type: + description: Channel metadata to merge. + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ActivityInput.withChannelData](xref:@microsoft/teams.api.ActivityInput.withChannelData) + - name: withId(string) + uid: '@microsoft/teams.api.TypingActivityInput.withId' + package: '@microsoft/teams.api' + summary: Set the activity ID for update scenarios. + remarks: '' + isDeprecated: false + syntax: + content: 'function withId(value: string): TypingActivityInput' + parameters: + - id: value + type: string + description: Activity ID. + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ActivityInput.withId](xref:@microsoft/teams.api.ActivityInput.withId) + - name: withRecipient(Account, boolean) + uid: '@microsoft/teams.api.TypingActivityInput.withRecipient' + package: '@microsoft/teams.api' + summary: Set the activity recipient. + remarks: '' + isDeprecated: false + syntax: + content: >- + function withRecipient(value: Account, isTargeted?: boolean): + TypingActivityInput + parameters: + - id: value + type: <any> + description: Recipient account. + - id: isTargeted + type: boolean + description: Whether the activity is targeted only to this recipient. + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ActivityInput.withRecipient](xref:@microsoft/teams.api.ActivityInput.withRecipient) + - name: withReplyToId(string) + uid: '@microsoft/teams.api.TypingActivityInput.withReplyToId' + package: '@microsoft/teams.api' + summary: Set the activity ID this outbound activity replies to. + remarks: '' + isDeprecated: false + syntax: + content: 'function withReplyToId(value: string): TypingActivityInput' + parameters: + - id: value + type: string + description: Activity ID being replied to. + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ActivityInput.withReplyToId](xref:@microsoft/teams.api.ActivityInput.withReplyToId) +methods: + - name: addStreamUpdate(number) + uid: '@microsoft/teams.api.TypingActivityInput.addStreamUpdate' + package: '@microsoft/teams.api' + summary: Add stream metadata to this typing update. + remarks: '' + isDeprecated: false + syntax: + content: 'function addStreamUpdate(sequence?: number): TypingActivityInput' + parameters: + - id: sequence + type: number + description: Sequence number of the stream chunk. + return: + description: '' + type: + - name: addText(string) + uid: '@microsoft/teams.api.TypingActivityInput.addText' + package: '@microsoft/teams.api' + summary: Append streaming update text. + remarks: '' + isDeprecated: false + syntax: + content: 'function addText(text: string): TypingActivityInput' + parameters: + - id: text + type: string + description: Streaming update text to append. + return: + description: '' + type: + - name: from(ITypingActivity | ITypingActivityInput) + uid: '@microsoft/teams.api.TypingActivityInput.from_2' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function from(activity: ITypingActivity | ITypingActivityInput): + TypingActivityInput + parameters: + - id: activity + type: >- + | + description: '' + return: + description: '' + type: + - name: from(ITypingActivity) + uid: '@microsoft/teams.api.TypingActivityInput.from' + package: '@microsoft/teams.api' + summary: Copy outbound-safe fields from a typing-like activity input. + remarks: '' + isDeprecated: false + syntax: + content: 'static function from(activity: ITypingActivity): TypingActivityInput' + parameters: + - id: activity + type: + description: Typing input to copy. + return: + description: '' + type: + - name: from(ITypingActivityInput) + uid: '@microsoft/teams.api.TypingActivityInput.from_1' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function from(activity: ITypingActivityInput): + TypingActivityInput + parameters: + - id: activity + type: + description: '' + return: + description: '' + type: + - name: withText(string) + uid: '@microsoft/teams.api.TypingActivityInput.withText' + package: '@microsoft/teams.api' + summary: Set the streaming update text. + remarks: '' + isDeprecated: false + syntax: + content: 'function withText(value: string): TypingActivityInput' + parameters: + - id: value + type: string + description: Streaming update text. + return: + description: '' + type: +extends: <"typing"> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/TypingActivityInputOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/TypingActivityInputOptions.yml new file mode 100644 index 0000000..7bc4e5e --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/TypingActivityInputOptions.yml @@ -0,0 +1,25 @@ +### YamlMime:TSTypeAlias +name: TypingActivityInputOptions +uid: '@microsoft/teams.api.TypingActivityInputOptions' +package: '@microsoft/teams.api' +summary: >- + Constructor fields for + [TypingActivityInput](xref:@microsoft/teams.api.TypingActivityInput). + + + This accepts modeled outbound typing fields plus channel/service extension + fields that + + should serialize at the top level of the outbound activity payload. The + constructor owns + + the `type` discriminator; set typing text with the `text` field or + + [withText](xref:@microsoft/teams.api.TypingActivityInput.withText). +fullName: TypingActivityInputOptions +remarks: '' +isDeprecated: false +syntax: > + type TypingActivityInputOptions = Omit, "type"> + & + Record diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/UserClient.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/UserClient.yml index b1d3767..8cc38a8 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.api/UserClient.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/UserClient.yml @@ -48,7 +48,91 @@ properties: remarks: '' isDeprecated: false syntax: - content: 'token: UserTokenClient' + content: UserTokenClient token return: description: '' type: +methods: + - name: exchangeToken(ExchangeUserTokenParams) + uid: '@microsoft/teams.api.UserClient.exchangeToken' + package: '@microsoft/teams.api' + summary: Exchange a user token for the given connection. + remarks: '' + isDeprecated: false + syntax: + content: >- + function exchangeToken(params: ExchangeUserTokenParams): + Promise + parameters: + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: getAadTokens(GetUserAADTokenParams) + uid: '@microsoft/teams.api.UserClient.getAadTokens' + package: '@microsoft/teams.api' + summary: Get AAD tokens for the given connection and resource urls. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAadTokens(params: GetUserAADTokenParams): + Promise> + parameters: + - id: params + type: + description: '' + return: + description: '' + type: >- + Promise<Record<string, >> + - name: getToken(GetUserTokenParams) + uid: '@microsoft/teams.api.UserClient.getToken' + package: '@microsoft/teams.api' + summary: Get a user token for the given connection. + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(params: GetUserTokenParams): Promise' + parameters: + - id: params + type: + description: '' + return: + description: '' + type: Promise<> + - name: getTokenStatus(GetUserTokenStatusParams) + uid: '@microsoft/teams.api.UserClient.getTokenStatus' + package: '@microsoft/teams.api' + summary: Get the token status for a user. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getTokenStatus(params: GetUserTokenStatusParams): + Promise + parameters: + - id: params + type: + description: '' + return: + description: '' + type: Promise<[]> + - name: signOut(SignOutUserParams) + uid: '@microsoft/teams.api.UserClient.signOut' + package: '@microsoft/teams.api' + summary: Sign a user out of the given connection. + remarks: '' + isDeprecated: false + syntax: + content: 'function signOut(params: SignOutUserParams): Promise' + parameters: + - id: params + type: + description: '' + return: + description: '' + type: Promise<void> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.api/index.yml b/nodejs/docs-ref-autogen/@microsoft/teams.api/index.yml index 03156e2..cbc0481 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.api/index.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.api/index.yml @@ -5,6 +5,7 @@ summary: '' type: package classes: - '@microsoft/teams.api.$Activity' + - '@microsoft/teams.api.ActivityInput' - '@microsoft/teams.api.BotClient' - '@microsoft/teams.api.BotSignInClient' - '@microsoft/teams.api.Client' @@ -14,21 +15,25 @@ classes: - '@microsoft/teams.api.JsonWebToken' - '@microsoft/teams.api.MeetingClient' - '@microsoft/teams.api.MessageActivity' + - '@microsoft/teams.api.MessageActivityInput' - '@microsoft/teams.api.MessageDeleteActivity' - '@microsoft/teams.api.MessageReactionActivity' - '@microsoft/teams.api.MessageUpdateActivity' - '@microsoft/teams.api.ReactionClient' - '@microsoft/teams.api.TeamClient' - '@microsoft/teams.api.TypingActivity' + - '@microsoft/teams.api.TypingActivityInput' - '@microsoft/teams.api.UserClient' - '@microsoft/teams.api.UserTokenClient' interfaces: - '@microsoft/teams.api.IActivity' + - '@microsoft/teams.api.IActivityInput' - '@microsoft/teams.api.IAdaptiveCardActionInvokeActivity' - '@microsoft/teams.api.ICommandResultActivity' - '@microsoft/teams.api.ICommandSendActivity' - '@microsoft/teams.api.IConfigFetchInvokeActivity' - '@microsoft/teams.api.IConfigSubmitInvokeActivity' + - '@microsoft/teams.api.IConversationActivityOperations' - '@microsoft/teams.api.IConversationUpdateActivity' - '@microsoft/teams.api.IEndOfConversationActivity' - '@microsoft/teams.api.IExecuteActionInvokeActivity' @@ -41,6 +46,7 @@ interfaces: - '@microsoft/teams.api.IMeetingParticipantLeaveEventActivity' - '@microsoft/teams.api.IMeetingStartEventActivity' - '@microsoft/teams.api.IMessageActivity' + - '@microsoft/teams.api.IMessageActivityInput' - '@microsoft/teams.api.IMessageDeleteActivity' - '@microsoft/teams.api.IMessageExtensionAnonQueryLinkInvokeActivity' - '@microsoft/teams.api.IMessageExtensionCardButtonClickedInvokeActivity' @@ -67,6 +73,7 @@ interfaces: - '@microsoft/teams.api.IToken' - '@microsoft/teams.api.ITraceActivity' - '@microsoft/teams.api.ITypingActivity' + - '@microsoft/teams.api.ITypingActivityInput' - '@microsoft/teams.api.IUnInstalledActivity' typeAliases: - '@microsoft/teams.api.$MessageActivity' @@ -129,6 +136,7 @@ typeAliases: - '@microsoft/teams.api.CreateConversationParams' - '@microsoft/teams.api.Credentials' - '@microsoft/teams.api.DeliveryMode' + - '@microsoft/teams.api.DeprecatedInputActivity' - '@microsoft/teams.api.EndOfConversationCode' - '@microsoft/teams.api.Entity' - '@microsoft/teams.api.ErrorResponse' @@ -172,6 +180,7 @@ typeAliases: - '@microsoft/teams.api.MembershipTypes' - '@microsoft/teams.api.MentionEntity' - '@microsoft/teams.api.Message' + - '@microsoft/teams.api.MessageActivityInputOptions' - '@microsoft/teams.api.MessageApp' - '@microsoft/teams.api.MessageBody' - '@microsoft/teams.api.MessageConversation' @@ -254,6 +263,7 @@ typeAliases: - '@microsoft/teams.api.TokenRequest' - '@microsoft/teams.api.TokenResponse' - '@microsoft/teams.api.TokenStatus' + - '@microsoft/teams.api.TypingActivityInputOptions' - '@microsoft/teams.api.UrlTaskModuleTaskInfo' - '@microsoft/teams.api.UserManagedIdentityCredentials' - '@microsoft/teams.api.VideoCard' @@ -447,6 +457,58 @@ functions: return: description: '' type: TActivity["text"] + - name: toActivityParams(DeprecatedInputActivity) + uid: '@microsoft/teams.api.toActivityParams' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function toActivityParams(activity: DeprecatedInputActivity): + ActivityParams + parameters: + - id: activity + type: + description: '' + return: + description: '' + type: + - name: toActivityParams(ActivityLike) + uid: '@microsoft/teams.api.toActivityParams_1' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toActivityParams(activity: ActivityLike): ActivityParams' + parameters: + - id: activity + type: + description: '' + return: + description: '' + type: + - name: toActivityParams(DeprecatedInputActivity | ActivityLike) + uid: '@microsoft/teams.api.toActivityParams_2' + package: '@microsoft/teams.api' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toActivityParams(activity: DeprecatedInputActivity | + ActivityLike): ActivityParams + parameters: + - id: activity + type: >- + | + description: '' + return: + description: '' + type: - name: withOverrides(CloudEnvironment, Partial) uid: '@microsoft/teams.api.withOverrides' package: '@microsoft/teams.api' diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.apps/ActivityContext.yml b/nodejs/docs-ref-autogen/@microsoft/teams.apps/ActivityContext.yml index 414b633..c8c40f4 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.apps/ActivityContext.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.apps/ActivityContext.yml @@ -184,14 +184,9 @@ properties: type: methods: - name: quote(string, ActivityLike) - uid: '@microsoft/teams.apps.ActivityContext.quote' + uid: '@microsoft/teams.apps.ActivityContext.quote_1' package: '@microsoft/teams.apps' - 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. + summary: '' remarks: '' isDeprecated: false syntax: @@ -201,33 +196,60 @@ methods: parameters: - id: messageId type: string - description: The ID of the message to quote + description: '' - id: activity type: - description: >- - The activity to send — a quote placeholder for messageId will be - prepended to its text - - This API is coming soon and may change in the future. - Diagnostic: ExperimentalTeamsQuotedReplies + description: '' + return: + description: '' + type: Promise<> + - name: quote(string, DeprecatedInputActivity | ActivityLike) + uid: '@microsoft/teams.apps.ActivityContext.quote_2' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function quote(messageId: string, activity: DeprecatedInputActivity | + ActivityLike): Promise + parameters: + - id: messageId + type: string + description: '' + - id: activity + type: >- + | + description: '' + return: + description: '' + type: Promise<> + - name: quote(string, DeprecatedInputActivity) + uid: '@microsoft/teams.apps.ActivityContext.quote' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function quote(messageId: string, activity: DeprecatedInputActivity): + Promise + parameters: + - id: messageId + type: string + description: '' + - id: activity + type: + description: '' return: description: '' type: Promise<> - name: reply(ActivityLike) - uid: '@microsoft/teams.apps.ActivityContext.reply' + uid: '@microsoft/teams.apps.ActivityContext.reply_1' package: '@microsoft/teams.apps' - summary: >- - send an activity in the current conversation with a visual quote - - of the inbound message. - - - In channels, sends to the current thread with a quoted reply. - - In other scopes, sends with a quoted reply. - - To send without quoting, use - [send](xref:@microsoft/teams.apps.ActivityContext.send). + summary: '' remarks: '' isDeprecated: false syntax: @@ -235,23 +257,49 @@ methods: parameters: - id: activity type: - description: the activity to send + description: '' + return: + description: '' + type: Promise<> + - name: reply(DeprecatedInputActivity | ActivityLike) + uid: '@microsoft/teams.apps.ActivityContext.reply_2' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function reply(activity: DeprecatedInputActivity | ActivityLike): + Promise + parameters: + - id: activity + type: >- + | + description: '' + return: + description: '' + type: Promise<> + - name: reply(DeprecatedInputActivity) + uid: '@microsoft/teams.apps.ActivityContext.reply' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: 'function reply(activity: DeprecatedInputActivity): Promise' + parameters: + - id: activity + type: + description: '' return: description: '' type: Promise<> - name: send(ActivityLike, ConversationReference) - uid: '@microsoft/teams.apps.ActivityContext.send' + uid: '@microsoft/teams.apps.ActivityContext.send_1' package: '@microsoft/teams.apps' - summary: >- - send an activity in the current conversation without quoting. - - - In channels, sends to the current thread. In scopes that do not - - support threading (group chat, meetings), sends as a normal message. - - To send with a visual quote of the inbound message, use - [reply](xref:@microsoft/teams.apps.ActivityContext.reply). + summary: '' remarks: '' isDeprecated: false syntax: @@ -261,12 +309,53 @@ methods: parameters: - id: activity type: - description: the activity to send + description: '' + - id: conversationRef + type: + description: '' + return: + description: '' + type: Promise<> + - name: send(DeprecatedInputActivity | ActivityLike, ConversationReference) + uid: '@microsoft/teams.apps.ActivityContext.send_2' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function send(activity: DeprecatedInputActivity | ActivityLike, + conversationRef?: ConversationReference): Promise + parameters: + - id: activity + type: >- + | + description: '' - id: conversationRef type: - description: >- - optional conversation reference to send to a different conversation - or thread + description: '' + return: + description: '' + type: Promise<> + - name: send(DeprecatedInputActivity, ConversationReference) + uid: '@microsoft/teams.apps.ActivityContext.send' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function send(activity: DeprecatedInputActivity, conversationRef?: + ConversationReference): Promise + parameters: + - id: activity + type: + description: '' + - id: conversationRef + type: + description: '' return: description: '' type: Promise<> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.apps/App.yml b/nodejs/docs-ref-autogen/@microsoft/teams.apps/App.yml index 0fa0839..6f60e95 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.apps/App.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.apps/App.yml @@ -81,51 +81,6 @@ properties: return: description: '' type: JwtValidator - - name: event - uid: '@microsoft/teams.apps.App.event' - package: '@microsoft/teams.apps' - summary: subscribe to an event - fullName: event - remarks: '' - isDeprecated: false - syntax: - content: >- - event: (this: App, name: Name, cb: - EventHandler[Name]>) => App - return: - description: '' - type: >- - (this: App<TPlugin>, name: Name, cb: - EventHandler<AppEvents<TPlugin>[Name]>) => - App<TPlugin> - - name: function - uid: '@microsoft/teams.apps.App.function' - package: '@microsoft/teams.apps' - summary: add/update a function that can be called remotely - fullName: function - remarks: '' - isDeprecated: false - syntax: - content: >- - function: (this: App, name: string, cb: (context: - IFunctionContext) => any) => App - return: - description: '' - type: >- - (this: App<TPlugin>, name: string, cb: (context: - IFunctionContext<TData>) => any) => App<TPlugin> - - name: getPlugin - uid: '@microsoft/teams.apps.App.getPlugin' - package: '@microsoft/teams.apps' - summary: get a plugin - fullName: getPlugin - remarks: '' - isDeprecated: false - syntax: - content: 'getPlugin: (this: App, name: PluginName) => IPlugin | undefined' - return: - description: '' - type: '(this: App<TPlugin>, name: PluginName) => IPlugin | undefined' - name: graph uid: '@microsoft/teams.apps.App.graph' package: '@microsoft/teams.apps' @@ -195,25 +150,6 @@ properties: return: description: '' type: - - name: message - uid: '@microsoft/teams.apps.App.message' - package: '@microsoft/teams.apps' - summary: subscribe to a message event for a specific pattern - fullName: message - remarks: '' - isDeprecated: false - syntax: - content: >- - message: (this: App, pattern: string | RegExp, cb: - RouteHandler>, void>) => App - return: - description: '' - type: >- - (this: App<TPlugin>, pattern: string | RegExp, cb: - RouteHandler<IActivityContext<IMessageActivity, - PluginAdditionalContext<TPlugin>>, void>) => - App<TPlugin> - name: oauth uid: '@microsoft/teams.apps.App.oauth' package: '@microsoft/teams.apps' @@ -226,24 +162,6 @@ properties: return: description: '' type: '{ defaultConnectionName: string }' - - name: 'on' - uid: '@microsoft/teams.apps.App.on' - package: '@microsoft/teams.apps' - summary: subscribe to an event - fullName: 'on' - remarks: '' - isDeprecated: false - syntax: - content: >- - on: (this: App, name: Name, cb: - Exclude>[Name], undefined>) => - App - return: - description: '' - type: >- - (this: App<TPlugin>, name: Name, cb: - Exclude<IRoutes<PluginAdditionalContext<TPlugin>>[Name], - undefined>) => App<TPlugin> - name: options uid: '@microsoft/teams.apps.App.options' package: '@microsoft/teams.apps' @@ -256,34 +174,6 @@ properties: return: description: '' type: <TPlugin> - - name: plugin - uid: '@microsoft/teams.apps.App.plugin' - package: '@microsoft/teams.apps' - summary: add a plugin - fullName: plugin - remarks: '' - isDeprecated: false - syntax: - content: 'plugin: (this: App, plugin: TPlugin) => App' - return: - description: '' - type: '(this: App<TPlugin>, plugin: TPlugin) => App<TPlugin>' - - name: process - uid: '@microsoft/teams.apps.App.process' - package: '@microsoft/teams.apps' - summary: activity handler called when an inbound activity is received - fullName: process - remarks: '' - isDeprecated: false - syntax: - content: >- - process: (this: App, event: IActivityEvent) => - Promise - return: - description: '' - type: >- - (this: App<TPlugin>, event: IActivityEvent) => - Promise<InvokeResponse> - name: server uid: '@microsoft/teams.apps.App.server' package: '@microsoft/teams.apps' @@ -308,58 +198,86 @@ properties: return: description: '' type: <any, any> - - name: tab - uid: '@microsoft/teams.apps.App.tab' +methods: + - name: event(Name, EventHandler[Name]>) + uid: '@microsoft/teams.apps.App.event' package: '@microsoft/teams.apps' - summary: >- - add/update a static tab. - - the tab will be hosted at - - `http://localhost:{{PORT}}/tabs/{{name}}` or - `https://{{BOT_DOMAIN}}/tabs/{{name}}` - fullName: tab + summary: subscribe to an event remarks: '' isDeprecated: false syntax: - content: 'tab: (this: App, name: string, path: string) => App' + content: >- + function event(name: Name, cb: + EventHandler[Name]>): App + parameters: + - id: name + type: Name + description: the event to subscribe to + - id: cb + type: >- + <AppEvents<TPlugin>[Name]> + description: the callback to invoke return: description: '' - type: >- - (this: App<TPlugin>, name: string, path: string) => - App<TPlugin> - - name: tokenManager - uid: '@microsoft/teams.apps.App.tokenManager' + type: <TPlugin> + - name: 'function(string, (context: IFunctionContext) => any)' + uid: '@microsoft/teams.apps.App.function' package: '@microsoft/teams.apps' - summary: '' - fullName: tokenManager + summary: add/update a function that can be called remotely remarks: '' isDeprecated: false syntax: - content: 'tokenManager: TokenManager' + content: >- + function function(name: string, cb: (context: + IFunctionContext) => any): App + parameters: + - id: name + type: string + description: The unique function name + - id: cb + type: '(context: IFunctionContext<TData>) => any' + description: The callback to handle the function return: description: '' - type: TokenManager - - name: use - uid: '@microsoft/teams.apps.App.use' + type: <TPlugin> + - name: >- + function(string, (context: + IFunctionContext) => any) + uid: '@microsoft/teams.apps.App.function_1' package: '@microsoft/teams.apps' - summary: register a middleware - fullName: use + summary: '' remarks: '' isDeprecated: false syntax: content: >- - use: (this: App, cb: RouteHandler>, void | InvokeResponse>) => - App + function function(name: string, cb: (context: + IFunctionContext) => any): App + parameters: + - id: name + type: string + description: '' + - id: cb + type: '(context: IFunctionContext<TData>) => any' + description: '' return: description: '' - type: >- - (this: App<TPlugin>, cb: - RouteHandler<IActivityContext<Activity, - PluginAdditionalContext<TPlugin>>, void | - InvokeResponse<any>>) => App<TPlugin> -methods: + type: <TPlugin> + - name: getPlugin(PluginName) + uid: '@microsoft/teams.apps.App.getPlugin' + package: '@microsoft/teams.apps' + summary: get a plugin + remarks: '' + isDeprecated: false + syntax: + content: 'function getPlugin(name: PluginName): undefined | IPlugin<{}, {}>' + parameters: + - id: name + type: + description: '' + return: + description: '' + type: undefined | <{}, {}> - name: initialize() uid: '@microsoft/teams.apps.App.initialize' package: '@microsoft/teams.apps' @@ -371,6 +289,58 @@ methods: return: description: '' type: Promise<void> + - name: >- + message(string | RegExp, RouteHandler>, void>) + uid: '@microsoft/teams.apps.App.message' + package: '@microsoft/teams.apps' + summary: subscribe to a message event for a specific pattern + remarks: '' + isDeprecated: false + syntax: + content: >- + function message(pattern: string | RegExp, cb: + RouteHandler>, void>): App + parameters: + - id: pattern + type: string | RegExp + description: pattern to match against message text + - id: cb + type: >- + <<, + PluginAdditionalContext<TPlugin>>, void> + description: callback to invoke + return: + description: '' + type: <TPlugin> + - name: >- + on(Name, Exclude>[Name], + undefined>) + uid: '@microsoft/teams.apps.App.on' + package: '@microsoft/teams.apps' + summary: subscribe to an event + remarks: '' + isDeprecated: false + syntax: + content: >- + function on(name: Name, cb: + Exclude>[Name], undefined>): + App + parameters: + - id: name + type: Name + description: event to subscribe to + - id: cb + type: >- + Exclude<IRoutes<PluginAdditionalContext<TPlugin>>[Name], + undefined> + description: callback to invoke + return: + description: '' + type: <TPlugin> - name: onActivity(IActivityEvent) uid: '@microsoft/teams.apps.App.onActivity' package: '@microsoft/teams.apps' @@ -388,14 +358,42 @@ methods: type: >- Promise<<any>> + - name: plugin(TPlugin) + uid: '@microsoft/teams.apps.App.plugin' + package: '@microsoft/teams.apps' + summary: add a plugin + remarks: '' + isDeprecated: false + syntax: + content: 'function plugin(plugin: TPlugin): App' + parameters: + - id: plugin + type: TPlugin + description: plugin to add + return: + description: '' + type: <TPlugin> + - name: process(IActivityEvent) + uid: '@microsoft/teams.apps.App.process' + package: '@microsoft/teams.apps' + summary: activity handler called when an inbound activity is received + remarks: '' + isDeprecated: false + syntax: + content: 'function process(event: IActivityEvent): Promise>' + parameters: + - id: event + type: + description: the received activity event + return: + description: '' + type: >- + Promise<<any>> - name: reply(string, ActivityLike) - uid: '@microsoft/teams.apps.App.reply_1' + uid: '@microsoft/teams.apps.App.reply_4' package: '@microsoft/teams.apps' - summary: |- - send an activity proactively to a conversation. - - Sends to the exact conversation ID provided - threaded if - it contains `;messageid=`, flat otherwise. + summary: '' remarks: '' isDeprecated: false syntax: @@ -405,29 +403,60 @@ methods: parameters: - id: conversationId type: string - description: the conversation to send to + description: '' - id: activity type: - description: the activity to send + description: '' + return: + description: '' + type: Promise<any> + - name: reply(string, DeprecatedInputActivity | ActivityLike) + uid: '@microsoft/teams.apps.App.reply_5' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function reply(conversationId: string, activity: DeprecatedInputActivity + | ActivityLike): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: activity + type: >- + | + description: '' + return: + description: '' + type: Promise<any> + - name: reply(string, DeprecatedInputActivity) + uid: '@microsoft/teams.apps.App.reply_3' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function reply(conversationId: string, activity: + DeprecatedInputActivity): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: activity + type: + description: '' return: description: '' type: Promise<any> - name: reply(string, string, ActivityLike) - uid: '@microsoft/teams.apps.App.reply' + uid: '@microsoft/teams.apps.App.reply_1' package: '@microsoft/teams.apps' - summary: >- - send an activity proactively as a threaded reply. - - - Constructs a threaded conversation ID from the conversation ID - - and message ID via - [toThreadedConversationId](xref:@microsoft/teams.apps.toThreadedConversationId), - then sends - - to that thread. The service determines whether threading is - - supported for the given conversation type. + summary: '' remarks: '' isDeprecated: false syntax: @@ -437,30 +466,69 @@ methods: parameters: - id: conversationId type: string - description: the conversation ID + description: '' - id: messageId type: string - description: the thread root message ID + description: '' - id: activity type: - description: the activity to send + description: '' + return: + description: '' + type: Promise<any> + - name: reply(string, string, DeprecatedInputActivity | ActivityLike) + uid: '@microsoft/teams.apps.App.reply_2' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function reply(conversationId: string, messageId: string, activity: + DeprecatedInputActivity | ActivityLike): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: messageId + type: string + description: '' + - id: activity + type: >- + | + description: '' + return: + description: '' + type: Promise<any> + - name: reply(string, string, DeprecatedInputActivity) + uid: '@microsoft/teams.apps.App.reply' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function reply(conversationId: string, messageId: string, activity: + DeprecatedInputActivity): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: messageId + type: string + description: '' + - id: activity + type: + description: '' return: description: '' type: Promise<any> - name: send(string, ActivityLike) - uid: '@microsoft/teams.apps.App.send' + uid: '@microsoft/teams.apps.App.send_1' package: '@microsoft/teams.apps' - summary: >- - send an activity proactively to a conversation. - - - Sends to the exact conversation ID provided. For channel threads, - - the conversation ID must include `;messageid=` - use - [toThreadedConversationId](xref:@microsoft/teams.apps.toThreadedConversationId) - - to construct it, or use [reply](xref:@microsoft/teams.apps.App.reply_1) - which handles this automatically. + summary: '' remarks: '' isDeprecated: false syntax: @@ -470,10 +538,53 @@ methods: parameters: - id: conversationId type: string - description: the conversation to send to + description: '' - id: activity type: - description: the activity to send + description: '' + return: + description: '' + type: Promise<> + - name: send(string, DeprecatedInputActivity | ActivityLike) + uid: '@microsoft/teams.apps.App.send_2' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function send(conversationId: string, activity: DeprecatedInputActivity + | ActivityLike): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: activity + type: >- + | + description: '' + return: + description: '' + type: Promise<> + - name: send(string, DeprecatedInputActivity) + uid: '@microsoft/teams.apps.App.send' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function send(conversationId: string, activity: + DeprecatedInputActivity): Promise + parameters: + - id: conversationId + type: string + description: '' + - id: activity + type: + description: '' return: description: '' type: Promise<> @@ -503,3 +614,52 @@ methods: return: description: '' type: Promise<void> + - name: tab(string, string) + uid: '@microsoft/teams.apps.App.tab' + package: '@microsoft/teams.apps' + summary: >- + add/update a static tab. + + the tab will be hosted at + + `http://localhost:{{PORT}}/tabs/{{name}}` or + `https://{{BOT_DOMAIN}}/tabs/{{name}}` + remarks: '' + isDeprecated: false + syntax: + content: 'function tab(name: string, path: string): App' + parameters: + - id: name + type: string + description: A unique identifier for the entity which the tab displays. + - id: path + type: string + description: The path to the web `dist` folder. + return: + description: '' + type: <TPlugin> + - name: >- + use(RouteHandler>, void | InvokeResponse>) + uid: '@microsoft/teams.apps.App.use' + package: '@microsoft/teams.apps' + summary: register a middleware + remarks: '' + isDeprecated: false + syntax: + content: >- + function use(cb: RouteHandler>, void | InvokeResponse>): + App + parameters: + - id: cb + type: >- + <<, + PluginAdditionalContext<TPlugin>>, void | <any>> + description: callback to invoke + return: + description: '' + type: <TPlugin> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.apps/FunctionContext.yml b/nodejs/docs-ref-autogen/@microsoft/teams.apps/FunctionContext.yml new file mode 100644 index 0000000..642ad60 --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.apps/FunctionContext.yml @@ -0,0 +1,321 @@ +### YamlMime:TSType +name: FunctionContext +uid: '@microsoft/teams.apps.FunctionContext' +package: '@microsoft/teams.apps' +summary: >- + Context handed to a remotely-callable function (`app.function`). + + + Like [ActivityContext](xref:@microsoft/teams.apps.ActivityContext), this is a + "smart" context: it owns conversation + + resolution and sending rather than having `App` wire those up at registration. + + That keeps `App.function` thin and mirrors the Python SDK's `FunctionContext`. +fullName: FunctionContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: FunctionContext(IFunctionContextOptions) + uid: '@microsoft/teams.apps.FunctionContext.constructor' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new FunctionContext(options: IFunctionContextOptions)' + parameters: + - id: options + type: >- + <T> + description: '' +properties: + - name: api + uid: '@microsoft/teams.apps.FunctionContext.api' + package: '@microsoft/teams.apps' + summary: the api client + fullName: api + remarks: '' + isDeprecated: false + syntax: + content: 'api: Client' + return: + description: '' + type: + - name: appGraph + uid: '@microsoft/teams.apps.FunctionContext.appGraph' + package: '@microsoft/teams.apps' + summary: the app graph client + fullName: appGraph + remarks: '' + isDeprecated: false + syntax: + content: 'appGraph: Client' + return: + description: '' + type: + - name: appId + uid: '@microsoft/teams.apps.FunctionContext.appId' + package: '@microsoft/teams.apps' + summary: >- + This ID is the unique identifier assigned to the app after deployment and + is critical for ensuring the correct app instance is recognized across + hosts. + fullName: appId + remarks: '' + isDeprecated: false + syntax: + content: 'appId?: string' + return: + description: '' + type: string + - name: appSessionId + uid: '@microsoft/teams.apps.FunctionContext.appSessionId' + package: '@microsoft/teams.apps' + summary: >- + Unique ID for the current session for use in correlating telemetry data. A + session corresponds to the lifecycle of an app. A new session begins upon + the creation of a webview (on Teams mobile) or iframe (in Teams desktop) + hosting the app, and ends when it is destroyed. + fullName: appSessionId + remarks: '' + isDeprecated: false + syntax: + content: 'appSessionId: string' + return: + description: '' + type: string + - name: authToken + uid: '@microsoft/teams.apps.FunctionContext.authToken' + package: '@microsoft/teams.apps' + summary: The MSAL entra token. + fullName: authToken + remarks: '' + isDeprecated: false + syntax: + content: 'authToken: string' + return: + description: '' + type: string + - name: channelId + uid: '@microsoft/teams.apps.FunctionContext.channelId' + package: '@microsoft/teams.apps' + summary: >- + The Microsoft Teams ID for the channel with which the content is + associated. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId?: string' + return: + description: '' + type: string + - name: chatId + uid: '@microsoft/teams.apps.FunctionContext.chatId' + package: '@microsoft/teams.apps' + summary: The Microsoft Teams ID for the chat with which the content is associated. + fullName: chatId + remarks: '' + isDeprecated: false + syntax: + content: 'chatId?: string' + return: + description: '' + type: string + - name: data + uid: '@microsoft/teams.apps.FunctionContext.data' + package: '@microsoft/teams.apps' + summary: the function payload + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data: T' + return: + description: '' + type: T + - name: getCurrentConversationId + uid: '@microsoft/teams.apps.FunctionContext.getCurrentConversationId' + package: '@microsoft/teams.apps' + summary: '' + fullName: getCurrentConversationId + remarks: '' + isDeprecated: false + syntax: + content: 'getCurrentConversationId: () => Promise' + return: + description: '' + type: () => Promise<undefined | string> + - name: log + uid: '@microsoft/teams.apps.FunctionContext.log' + package: '@microsoft/teams.apps' + summary: the app logger instance + fullName: log + remarks: '' + isDeprecated: false + syntax: + content: 'log: ILogger' + return: + description: '' + type: + - name: meetingId + uid: '@microsoft/teams.apps.FunctionContext.meetingId' + package: '@microsoft/teams.apps' + summary: Meeting ID used by tab when running in meeting context + fullName: meetingId + remarks: '' + isDeprecated: false + syntax: + content: 'meetingId?: string' + return: + description: '' + type: string + - name: messageId + uid: '@microsoft/teams.apps.FunctionContext.messageId' + package: '@microsoft/teams.apps' + summary: |- + The ID of the parent message from which this task module was launched. + This is only available in task modules launched from bot cards. + fullName: messageId + remarks: '' + isDeprecated: false + syntax: + content: 'messageId?: string' + return: + description: '' + type: string + - name: pageId + uid: '@microsoft/teams.apps.FunctionContext.pageId' + package: '@microsoft/teams.apps' + summary: The developer-defined unique ID for the page this content points to. + fullName: pageId + remarks: '' + isDeprecated: false + syntax: + content: 'pageId: string' + return: + description: '' + type: string + - name: subPageId + uid: '@microsoft/teams.apps.FunctionContext.subPageId' + package: '@microsoft/teams.apps' + summary: |- + The developer-defined unique ID for the sub-page this content points to. + This field should be used to restore to a specific state within a page, + such as scrolling to or activating a specific piece of content. + fullName: subPageId + remarks: '' + isDeprecated: false + syntax: + content: 'subPageId?: string' + return: + description: '' + type: string + - name: teamId + uid: '@microsoft/teams.apps.FunctionContext.teamId' + package: '@microsoft/teams.apps' + summary: The Microsoft Teams ID for the team with which the content is associated. + fullName: teamId + remarks: '' + isDeprecated: false + syntax: + content: 'teamId?: string' + return: + description: '' + type: string + - name: tenantId + uid: '@microsoft/teams.apps.FunctionContext.tenantId' + package: '@microsoft/teams.apps' + summary: >- + The Microsoft Entra tenant ID of the current user, extracted from request + auth token. + fullName: tenantId + remarks: '' + isDeprecated: false + syntax: + content: 'tenantId: string' + return: + description: '' + type: string + - name: userId + uid: '@microsoft/teams.apps.FunctionContext.userId' + package: '@microsoft/teams.apps' + summary: >- + The Microsoft Entra object id of the current user, extracted from the + request auth token. + fullName: userId + remarks: '' + isDeprecated: false + syntax: + content: 'userId: string' + return: + description: '' + type: string + - name: userName + uid: '@microsoft/teams.apps.FunctionContext.userName' + package: '@microsoft/teams.apps' + summary: The name of the current user, extracted from the request auth token. + fullName: userName + remarks: '' + isDeprecated: false + syntax: + content: 'userName: string' + return: + description: '' + type: string +methods: + - name: send(ActivityLike) + uid: '@microsoft/teams.apps.FunctionContext.send_1' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function send(activity: ActivityLike): Promise' + parameters: + - id: activity + type: + description: '' + return: + description: '' + type: Promise<null | > + - name: send(DeprecatedInputActivity | ActivityLike) + uid: '@microsoft/teams.apps.FunctionContext.send_2' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function send(activity: DeprecatedInputActivity | ActivityLike): + Promise + parameters: + - id: activity + type: >- + | + description: '' + return: + description: '' + type: Promise<null | > + - name: send(DeprecatedInputActivity) + uid: '@microsoft/teams.apps.FunctionContext.send' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function send(activity: DeprecatedInputActivity): Promise + parameters: + - id: activity + type: + description: '' + return: + description: '' + type: Promise<null | > diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.apps/IActivityErrorContext.yml b/nodejs/docs-ref-autogen/@microsoft/teams.apps/IActivityErrorContext.yml index 604d371..403c05b 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.apps/IActivityErrorContext.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.apps/IActivityErrorContext.yml @@ -135,23 +135,6 @@ inheritedProperties: InvokeResponse<any> | Promise<void | InvokeResponse<any>> inheritanceDescription: Inherited From IActivityContext.next - - name: quote - uid: '@microsoft/teams.apps.IActivityErrorContext.quote' - package: '@microsoft/teams.apps' - summary: send a reply quoting a specific message by ID - fullName: quote - remarks: '' - isDeprecated: false - syntax: - content: >- - quote: (messageId: string, activity: ActivityLike) => - Promise - return: - description: '' - type: >- - (messageId: string, activity: ActivityLike) => - Promise<SentActivity> - inheritanceDescription: Inherited From IActivityContext.quote - name: ref uid: '@microsoft/teams.apps.IActivityErrorContext.ref' package: '@microsoft/teams.apps' @@ -165,36 +148,6 @@ inheritedProperties: description: '' type: inheritanceDescription: Inherited From IActivityContext.ref - - name: reply - uid: '@microsoft/teams.apps.IActivityErrorContext.reply' - package: '@microsoft/teams.apps' - summary: reply to the inbound activity, automatically quoting the inbound message - fullName: reply - remarks: '' - isDeprecated: false - syntax: - content: 'reply: (activity: ActivityLike) => Promise' - return: - description: '' - type: '(activity: ActivityLike) => Promise<SentActivity>' - inheritanceDescription: Inherited From IActivityContext.reply - - name: send - uid: '@microsoft/teams.apps.IActivityErrorContext.send' - package: '@microsoft/teams.apps' - summary: send an activity to the conversation - fullName: send - remarks: '' - isDeprecated: false - syntax: - content: >- - send: (activity: ActivityLike, conversationRef?: ConversationReference) - => Promise - return: - description: '' - type: >- - (activity: ActivityLike, conversationRef?: ConversationReference) - => Promise<SentActivity> - inheritanceDescription: Inherited From IActivityContext.send - name: signin uid: '@microsoft/teams.apps.IActivityErrorContext.signin' package: '@microsoft/teams.apps' @@ -277,4 +230,190 @@ inheritedProperties: description: '' type: string inheritanceDescription: Inherited From IActivityContext.userToken +inheritedMethods: + - name: quote(string, ActivityLike) + uid: '@microsoft/teams.apps.IActivityErrorContext.quote_1' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function quote(messageId: string, activity: ActivityLike): + Promise + parameters: + - id: messageId + type: string + description: '' + - id: activity + type: + description: '' + return: + description: '' + type: Promise<> + inheritanceDescription: Inherited From IActivityContext.quote + - name: quote(string, DeprecatedInputActivity | ActivityLike) + uid: '@microsoft/teams.apps.IActivityErrorContext.quote_2' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function quote(messageId: string, activity: DeprecatedInputActivity | + ActivityLike): Promise + parameters: + - id: messageId + type: string + description: '' + - id: activity + type: >- + | + description: '' + return: + description: '' + type: Promise<> + inheritanceDescription: Inherited From IActivityContext.quote + - name: quote(string, DeprecatedInputActivity) + uid: '@microsoft/teams.apps.IActivityErrorContext.quote' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function quote(messageId: string, activity: DeprecatedInputActivity): + Promise + parameters: + - id: messageId + type: string + description: '' + - id: activity + type: + description: '' + return: + description: '' + type: Promise<> + inheritanceDescription: Inherited From IActivityContext.quote + - name: reply(ActivityLike) + uid: '@microsoft/teams.apps.IActivityErrorContext.reply_1' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function reply(activity: ActivityLike): Promise' + parameters: + - id: activity + type: + description: '' + return: + description: '' + type: Promise<> + inheritanceDescription: Inherited From IActivityContext.reply + - name: reply(DeprecatedInputActivity | ActivityLike) + uid: '@microsoft/teams.apps.IActivityErrorContext.reply_2' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function reply(activity: DeprecatedInputActivity | ActivityLike): + Promise + parameters: + - id: activity + type: >- + | + description: '' + return: + description: '' + type: Promise<> + inheritanceDescription: Inherited From IActivityContext.reply + - name: reply(DeprecatedInputActivity) + uid: '@microsoft/teams.apps.IActivityErrorContext.reply' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: 'function reply(activity: DeprecatedInputActivity): Promise' + parameters: + - id: activity + type: + description: '' + return: + description: '' + type: Promise<> + inheritanceDescription: Inherited From IActivityContext.reply + - name: send(ActivityLike, ConversationReference) + uid: '@microsoft/teams.apps.IActivityErrorContext.send_1' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function send(activity: ActivityLike, conversationRef?: + ConversationReference): Promise + parameters: + - id: activity + type: + description: '' + - id: conversationRef + type: + description: '' + return: + description: '' + type: Promise<> + inheritanceDescription: Inherited From IActivityContext.send + - name: send(DeprecatedInputActivity | ActivityLike, ConversationReference) + uid: '@microsoft/teams.apps.IActivityErrorContext.send_2' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function send(activity: DeprecatedInputActivity | ActivityLike, + conversationRef?: ConversationReference): Promise + parameters: + - id: activity + type: >- + | + description: '' + - id: conversationRef + type: + description: '' + return: + description: '' + type: Promise<> + inheritanceDescription: Inherited From IActivityContext.send + - name: send(DeprecatedInputActivity, ConversationReference) + uid: '@microsoft/teams.apps.IActivityErrorContext.send' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function send(activity: DeprecatedInputActivity, conversationRef?: + ConversationReference): Promise + parameters: + - id: activity + type: + description: '' + - id: conversationRef + type: + description: '' + return: + description: '' + type: Promise<> + inheritanceDescription: Inherited From IActivityContext.send extends: <T> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.apps/IActivitySender.yml b/nodejs/docs-ref-autogen/@microsoft/teams.apps/IActivitySender.yml index b23b235..80beabb 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.apps/IActivitySender.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.apps/IActivitySender.yml @@ -26,7 +26,7 @@ methods: description: '' type: - name: send(ActivityParams, ConversationReference) - uid: '@microsoft/teams.apps.IActivitySender.send' + uid: '@microsoft/teams.apps.IActivitySender.send_1' package: '@microsoft/teams.apps' summary: Send an activity remarks: '' @@ -45,3 +45,46 @@ methods: return: description: '' type: Promise<> + - name: send(DeprecatedInputActivity | ActivityParams, ConversationReference) + uid: '@microsoft/teams.apps.IActivitySender.send_2' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function send(activity: DeprecatedInputActivity | ActivityParams, ref: + ConversationReference): Promise + parameters: + - id: activity + type: >- + | + description: '' + - id: ref + type: + description: '' + return: + description: '' + type: Promise<> + - name: send(DeprecatedInputActivity, ConversationReference) + uid: '@microsoft/teams.apps.IActivitySender.send' + package: '@microsoft/teams.apps' + summary: Send an activity + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function send(activity: DeprecatedInputActivity, ref: + ConversationReference): Promise + parameters: + - id: activity + type: + description: '' + - id: ref + type: + description: '' + return: + description: '' + type: Promise<> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.apps/IBaseActivityContext.yml b/nodejs/docs-ref-autogen/@microsoft/teams.apps/IBaseActivityContext.yml index 0ade626..8dc2b39 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.apps/IBaseActivityContext.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.apps/IBaseActivityContext.yml @@ -28,50 +28,6 @@ properties: (context?: IBaseActivityContext<Activity, Record<string, any>> & TExtraCtx) => void | InvokeResponse<any> | Promise<void | InvokeResponse<any>> - - name: quote - uid: '@microsoft/teams.apps.IBaseActivityContext.quote' - package: '@microsoft/teams.apps' - summary: send a reply quoting a specific message by ID - fullName: quote - remarks: '' - isDeprecated: false - syntax: - content: >- - quote: (messageId: string, activity: ActivityLike) => - Promise - return: - description: '' - type: >- - (messageId: string, activity: ActivityLike) => - Promise<SentActivity> - - name: reply - uid: '@microsoft/teams.apps.IBaseActivityContext.reply' - package: '@microsoft/teams.apps' - summary: reply to the inbound activity, automatically quoting the inbound message - fullName: reply - remarks: '' - isDeprecated: false - syntax: - content: 'reply: (activity: ActivityLike) => Promise' - return: - description: '' - type: '(activity: ActivityLike) => Promise<SentActivity>' - - name: send - uid: '@microsoft/teams.apps.IBaseActivityContext.send' - package: '@microsoft/teams.apps' - summary: send an activity to the conversation - fullName: send - remarks: '' - isDeprecated: false - syntax: - content: >- - send: (activity: ActivityLike, conversationRef?: ConversationReference) - => Promise - return: - description: '' - type: >- - (activity: ActivityLike, conversationRef?: ConversationReference) - => Promise<SentActivity> - name: signin uid: '@microsoft/teams.apps.IBaseActivityContext.signin' package: '@microsoft/teams.apps' @@ -281,4 +237,181 @@ inheritedProperties: inheritanceDescription: >- Inherited From [IBaseActivityContextOptions.userToken](xref:@microsoft/teams.apps.IBaseActivityContextOptions.userToken) +methods: + - name: quote(string, ActivityLike) + uid: '@microsoft/teams.apps.IBaseActivityContext.quote_1' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function quote(messageId: string, activity: ActivityLike): + Promise + parameters: + - id: messageId + type: string + description: '' + - id: activity + type: + description: '' + return: + description: '' + type: Promise<> + - name: quote(string, DeprecatedInputActivity | ActivityLike) + uid: '@microsoft/teams.apps.IBaseActivityContext.quote_2' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function quote(messageId: string, activity: DeprecatedInputActivity | + ActivityLike): Promise + parameters: + - id: messageId + type: string + description: '' + - id: activity + type: >- + | + description: '' + return: + description: '' + type: Promise<> + - name: quote(string, DeprecatedInputActivity) + uid: '@microsoft/teams.apps.IBaseActivityContext.quote' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function quote(messageId: string, activity: DeprecatedInputActivity): + Promise + parameters: + - id: messageId + type: string + description: '' + - id: activity + type: + description: '' + return: + description: '' + type: Promise<> + - name: reply(ActivityLike) + uid: '@microsoft/teams.apps.IBaseActivityContext.reply_1' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function reply(activity: ActivityLike): Promise' + parameters: + - id: activity + type: + description: '' + return: + description: '' + type: Promise<> + - name: reply(DeprecatedInputActivity | ActivityLike) + uid: '@microsoft/teams.apps.IBaseActivityContext.reply_2' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function reply(activity: DeprecatedInputActivity | ActivityLike): + Promise + parameters: + - id: activity + type: >- + | + description: '' + return: + description: '' + type: Promise<> + - name: reply(DeprecatedInputActivity) + uid: '@microsoft/teams.apps.IBaseActivityContext.reply' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: 'function reply(activity: DeprecatedInputActivity): Promise' + parameters: + - id: activity + type: + description: '' + return: + description: '' + type: Promise<> + - name: send(ActivityLike, ConversationReference) + uid: '@microsoft/teams.apps.IBaseActivityContext.send_1' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function send(activity: ActivityLike, conversationRef?: + ConversationReference): Promise + parameters: + - id: activity + type: + description: '' + - id: conversationRef + type: + description: '' + return: + description: '' + type: Promise<> + - name: send(DeprecatedInputActivity | ActivityLike, ConversationReference) + uid: '@microsoft/teams.apps.IBaseActivityContext.send_2' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function send(activity: DeprecatedInputActivity | ActivityLike, + conversationRef?: ConversationReference): Promise + parameters: + - id: activity + type: >- + | + description: '' + - id: conversationRef + type: + description: '' + return: + description: '' + type: Promise<> + - name: send(DeprecatedInputActivity, ConversationReference) + uid: '@microsoft/teams.apps.IBaseActivityContext.send' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function send(activity: DeprecatedInputActivity, conversationRef?: + ConversationReference): Promise + parameters: + - id: activity + type: + description: '' + - id: conversationRef + type: + description: '' + return: + description: '' + type: Promise<> extends: <T> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.apps/IFunctionContext.yml b/nodejs/docs-ref-autogen/@microsoft/teams.apps/IFunctionContext.yml index 4cc4ee9..b828f0a 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.apps/IFunctionContext.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.apps/IFunctionContext.yml @@ -81,20 +81,6 @@ properties: return: description: '' type: - - name: send - uid: '@microsoft/teams.apps.IFunctionContext.send' - package: '@microsoft/teams.apps' - summary: |- - send an activity to the current conversation. - Returns null if the conversation ID cannot be determined or is invalid. - fullName: send - remarks: '' - isDeprecated: false - syntax: - content: 'send: (activity: ActivityLike) => Promise' - return: - description: '' - type: '(activity: ActivityLike) => Promise<null | SentActivity>' inheritedProperties: - name: appId uid: '@microsoft/teams.apps.IFunctionContext.appId' @@ -309,4 +295,57 @@ inheritedProperties: inheritanceDescription: >- Inherited From [IClientContext.userName](xref:@microsoft/teams.apps.IClientContext.userName) +methods: + - name: send(ActivityLike) + uid: '@microsoft/teams.apps.IFunctionContext.send_1' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function send(activity: ActivityLike): Promise' + parameters: + - id: activity + type: + description: '' + return: + description: '' + type: Promise<null | > + - name: send(DeprecatedInputActivity | ActivityLike) + uid: '@microsoft/teams.apps.IFunctionContext.send_2' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function send(activity: DeprecatedInputActivity | ActivityLike): + Promise + parameters: + - id: activity + type: >- + | + description: '' + return: + description: '' + type: Promise<null | > + - name: send(DeprecatedInputActivity) + uid: '@microsoft/teams.apps.IFunctionContext.send' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use MessageActivityInput or TypingActivityInput instead. + syntax: + content: >- + function send(activity: DeprecatedInputActivity): Promise + parameters: + - id: activity + type: + description: '' + return: + description: '' + type: Promise<null | > extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.apps/IFunctionContextOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams.apps/IFunctionContextOptions.yml new file mode 100644 index 0000000..c5507af --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.apps/IFunctionContextOptions.yml @@ -0,0 +1,24 @@ +### YamlMime:TSTypeAlias +name: IFunctionContextOptions +uid: '@microsoft/teams.apps.IFunctionContextOptions' +package: '@microsoft/teams.apps' +summary: >- + Options used to construct a + [FunctionContext](xref:@microsoft/teams.apps.FunctionContext). The owning + `App` supplies + + the client context (resolved from the request's auth token) plus the + + collaborators the context needs to resolve a conversation and send activities. +fullName: IFunctionContextOptions +remarks: '' +isDeprecated: false +syntax: | + type IFunctionContextOptions = IClientContext & { + activitySender: IActivitySender + api: ApiClient + appGraph: GraphClient + botId?: string + data: T + log: ILogger + } diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.apps/IPlugin.yml b/nodejs/docs-ref-autogen/@microsoft/teams.apps/IPlugin.yml index 42998d6..6947cb7 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.apps/IPlugin.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.apps/IPlugin.yml @@ -7,6 +7,25 @@ fullName: IPlugin remarks: '' isDeprecated: false type: interface +properties: + - name: send + uid: '@microsoft/teams.apps.IPlugin.send' + package: '@microsoft/teams.apps' + summary: |- + called by the `App` + to send an activity + fullName: send + remarks: '' + isDeprecated: false + syntax: + content: >- + send?: (activity: DeprecatedInputActivity, ref: ConversationReference) + => Promise + return: + description: '' + type: >- + (activity: DeprecatedInputActivity, ref: ConversationReference) => + Promise<SentActivity> methods: - name: createStream(ConversationReference) uid: '@microsoft/teams.apps.IPlugin.createStream' @@ -142,25 +161,3 @@ methods: return: description: '' type: void | Promise<void> - - name: send(ActivityParams, ConversationReference) - uid: '@microsoft/teams.apps.IPlugin.send' - package: '@microsoft/teams.apps' - summary: |- - called by the `App` - to send an activity - remarks: '' - isDeprecated: false - syntax: - content: >- - function send(activity: ActivityParams, ref: ConversationReference): - Promise - parameters: - - id: activity - type: - description: '' - - id: ref - type: - description: '' - return: - description: '' - type: Promise<> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.apps/IStreamer.yml b/nodejs/docs-ref-autogen/@microsoft/teams.apps/IStreamer.yml index 9eb3e24..4e75c93 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.apps/IStreamer.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.apps/IStreamer.yml @@ -11,11 +11,9 @@ properties: - name: canceled uid: '@microsoft/teams.apps.IStreamer.canceled' package: '@microsoft/teams.apps' - summary: >- + 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. fullName: canceled remarks: '' isDeprecated: false @@ -24,6 +22,23 @@ properties: return: description: '' type: boolean + - name: closed + uid: '@microsoft/teams.apps.IStreamer.closed' + package: '@microsoft/teams.apps' + summary: |- + whether the current streamed message has been finalized. + + Closing is idempotent until the next emit or update. Emitting or + updating after close starts a new streamed message using the same + stream instance. + fullName: closed + remarks: '' + isDeprecated: false + syntax: + content: 'closed: boolean' + return: + description: '' + type: boolean - name: events uid: '@microsoft/teams.apps.IStreamer.events' package: '@microsoft/teams.apps' @@ -56,7 +71,12 @@ methods: - name: close() uid: '@microsoft/teams.apps.IStreamer.close' package: '@microsoft/teams.apps' - summary: close the stream + 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. remarks: '' isDeprecated: false syntax: @@ -69,23 +89,37 @@ methods: undefined | | Promise<undefined | > - - name: emit(string | Partial) + - name: emit(IMessageActivity | ITypingActivity) uid: '@microsoft/teams.apps.IStreamer.emit' package: '@microsoft/teams.apps' - summary: emit an activity chunk + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use or instead. + syntax: + content: 'function emit(activity: IMessageActivity | ITypingActivity)' + parameters: + - id: activity + type: >- + | + description: '' + - name: emit(string | IMessageActivityInput | ITypingActivityInput) + uid: '@microsoft/teams.apps.IStreamer.emit_1' + package: '@microsoft/teams.apps' + summary: '' remarks: '' isDeprecated: false syntax: content: >- - function emit(activity: string | Partial) + function emit(activity: string | IMessageActivityInput | + ITypingActivityInput) parameters: - id: activity type: >- - string | Partial< | > - description: the activity to send + string | | + + description: '' - name: update(string) uid: '@microsoft/teams.apps.IStreamer.update' package: '@microsoft/teams.apps' diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.apps/StreamNotAllowedError.yml b/nodejs/docs-ref-autogen/@microsoft/teams.apps/StreamNotAllowedError.yml new file mode 100644 index 0000000..69cfed8 --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.apps/StreamNotAllowedError.yml @@ -0,0 +1,213 @@ +### YamlMime:TSType +name: StreamNotAllowedError +uid: '@microsoft/teams.apps.StreamNotAllowedError' +package: '@microsoft/teams.apps' +summary: Raised when streaming is not allowed for this user or bot. +fullName: StreamNotAllowedError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: StreamNotAllowedError(string) + uid: '@microsoft/teams.apps.StreamNotAllowedError.constructor' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new StreamNotAllowedError(message?: string)' + parameters: + - id: message + type: string + description: '' +inheritedProperties: + - name: message + uid: '@microsoft/teams.apps.StreamNotAllowedError.message' + package: '@microsoft/teams.apps' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [TerminalStreamError.message](xref:@microsoft/teams.apps.TerminalStreamError.message) + - name: name + uid: '@microsoft/teams.apps.StreamNotAllowedError.name' + package: '@microsoft/teams.apps' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [TerminalStreamError.name](xref:@microsoft/teams.apps.TerminalStreamError.name) + - name: stack + uid: '@microsoft/teams.apps.StreamNotAllowedError.stack' + package: '@microsoft/teams.apps' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [TerminalStreamError.stack](xref:@microsoft/teams.apps.TerminalStreamError.stack) + - name: stackTraceLimit + uid: '@microsoft/teams.apps.StreamNotAllowedError.stackTraceLimit' + package: '@microsoft/teams.apps' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [TerminalStreamError.stackTraceLimit](xref:@microsoft/teams.apps.TerminalStreamError.stackTraceLimit) +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@microsoft/teams.apps.StreamNotAllowedError.captureStackTrace' + package: '@microsoft/teams.apps' + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: >- + Inherited From + [TerminalStreamError.captureStackTrace](xref:@microsoft/teams.apps.TerminalStreamError.captureStackTrace) + - name: prepareStackTrace(Error, CallSite[]) + uid: '@microsoft/teams.apps.StreamNotAllowedError.prepareStackTrace' + package: '@microsoft/teams.apps' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [TerminalStreamError.prepareStackTrace](xref:@microsoft/teams.apps.TerminalStreamError.prepareStackTrace) +extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.apps/StreamTimedOutError.yml b/nodejs/docs-ref-autogen/@microsoft/teams.apps/StreamTimedOutError.yml new file mode 100644 index 0000000..10b988f --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.apps/StreamTimedOutError.yml @@ -0,0 +1,213 @@ +### YamlMime:TSType +name: StreamTimedOutError +uid: '@microsoft/teams.apps.StreamTimedOutError' +package: '@microsoft/teams.apps' +summary: Raised when the bot failed to complete streaming within the two-minute limit. +fullName: StreamTimedOutError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: StreamTimedOutError(string) + uid: '@microsoft/teams.apps.StreamTimedOutError.constructor' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new StreamTimedOutError(message?: string)' + parameters: + - id: message + type: string + description: '' +inheritedProperties: + - name: message + uid: '@microsoft/teams.apps.StreamTimedOutError.message' + package: '@microsoft/teams.apps' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [TerminalStreamError.message](xref:@microsoft/teams.apps.TerminalStreamError.message) + - name: name + uid: '@microsoft/teams.apps.StreamTimedOutError.name' + package: '@microsoft/teams.apps' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [TerminalStreamError.name](xref:@microsoft/teams.apps.TerminalStreamError.name) + - name: stack + uid: '@microsoft/teams.apps.StreamTimedOutError.stack' + package: '@microsoft/teams.apps' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [TerminalStreamError.stack](xref:@microsoft/teams.apps.TerminalStreamError.stack) + - name: stackTraceLimit + uid: '@microsoft/teams.apps.StreamTimedOutError.stackTraceLimit' + package: '@microsoft/teams.apps' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [TerminalStreamError.stackTraceLimit](xref:@microsoft/teams.apps.TerminalStreamError.stackTraceLimit) +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@microsoft/teams.apps.StreamTimedOutError.captureStackTrace' + package: '@microsoft/teams.apps' + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: >- + Inherited From + [TerminalStreamError.captureStackTrace](xref:@microsoft/teams.apps.TerminalStreamError.captureStackTrace) + - name: prepareStackTrace(Error, CallSite[]) + uid: '@microsoft/teams.apps.StreamTimedOutError.prepareStackTrace' + package: '@microsoft/teams.apps' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [TerminalStreamError.prepareStackTrace](xref:@microsoft/teams.apps.TerminalStreamError.prepareStackTrace) +extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.apps/TerminalStreamError.yml b/nodejs/docs-ref-autogen/@microsoft/teams.apps/TerminalStreamError.yml new file mode 100644 index 0000000..410c5a4 --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.apps/TerminalStreamError.yml @@ -0,0 +1,203 @@ +### YamlMime:TSType +name: TerminalStreamError +uid: '@microsoft/teams.apps.TerminalStreamError' +package: '@microsoft/teams.apps' +summary: >- + Base class for terminal streaming errors (HTTP 403) that should not be + retried. +fullName: TerminalStreamError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: TerminalStreamError(string) + uid: '@microsoft/teams.apps.TerminalStreamError.constructor' + package: '@microsoft/teams.apps' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new TerminalStreamError(message?: string)' + parameters: + - id: message + type: string + description: '' +inheritedProperties: + - name: message + uid: '@microsoft/teams.apps.TerminalStreamError.message' + package: '@microsoft/teams.apps' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Error.message + - name: name + uid: '@microsoft/teams.apps.TerminalStreamError.name' + package: '@microsoft/teams.apps' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Error.name + - name: stack + uid: '@microsoft/teams.apps.TerminalStreamError.stack' + package: '@microsoft/teams.apps' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Error.stack + - name: stackTraceLimit + uid: '@microsoft/teams.apps.TerminalStreamError.stackTraceLimit' + package: '@microsoft/teams.apps' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Error.stackTraceLimit +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@microsoft/teams.apps.TerminalStreamError.captureStackTrace' + package: '@microsoft/teams.apps' + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: Inherited From Error.captureStackTrace + - name: prepareStackTrace(Error, CallSite[]) + uid: '@microsoft/teams.apps.TerminalStreamError.prepareStackTrace' + package: '@microsoft/teams.apps' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: Inherited From Error.prepareStackTrace +extends: Error diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.apps/index.yml b/nodejs/docs-ref-autogen/@microsoft/teams.apps/index.yml index 0b31d28..874b4a7 100644 --- a/nodejs/docs-ref-autogen/@microsoft/teams.apps/index.yml +++ b/nodejs/docs-ref-autogen/@microsoft/teams.apps/index.yml @@ -7,8 +7,12 @@ classes: - '@microsoft/teams.apps.ActivityContext' - '@microsoft/teams.apps.App' - '@microsoft/teams.apps.ExpressAdapter' + - '@microsoft/teams.apps.FunctionContext' - '@microsoft/teams.apps.HttpPlugin' - '@microsoft/teams.apps.StreamCancelledError' + - '@microsoft/teams.apps.StreamNotAllowedError' + - '@microsoft/teams.apps.StreamTimedOutError' + - '@microsoft/teams.apps.TerminalStreamError' interfaces: - '@microsoft/teams.apps.IActivityContextConstructorArgs' - '@microsoft/teams.apps.IActivityErrorContext' @@ -47,6 +51,7 @@ typeAliases: - '@microsoft/teams.apps.HttpRouteHandler' - '@microsoft/teams.apps.IActivityContext' - '@microsoft/teams.apps.IActivityContextOptions' + - '@microsoft/teams.apps.IFunctionContextOptions' - '@microsoft/teams.apps.OAuthSettings' - '@microsoft/teams.apps.OnActivityPluginEvent' - '@microsoft/teams.apps.OnErrorPluginEvent' diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.client/App.yml b/nodejs/docs-ref-autogen/@microsoft/teams.client/App.yml new file mode 100644 index 0000000..2840e76 --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.client/App.yml @@ -0,0 +1,207 @@ +### YamlMime:TSType +name: App +uid: '@microsoft/teams.client.App' +package: '@microsoft/teams.client' +summary: >- + The main entry point for this library. This class streamlines Microsoft Teams + app development + + by simplifying the process of managing authentication, interacting with + Microsoft Graph APIs, + + and executing server-side functions. +fullName: App +remarks: '' +isDeprecated: false +type: class +constructors: + - name: App(string, AppOptions) + uid: '@microsoft/teams.client.App.constructor' + package: '@microsoft/teams.client' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new App(clientId: string, options?: AppOptions)' + parameters: + - id: clientId + type: string + description: '' + - id: options + type: + description: '' +properties: + - name: clientId + uid: '@microsoft/teams.client.App.clientId' + package: '@microsoft/teams.client' + summary: '' + fullName: clientId + remarks: '' + isDeprecated: false + syntax: + content: 'clientId: string' + return: + description: '' + type: string + - name: graph + uid: '@microsoft/teams.client.App.graph' + package: '@microsoft/teams.client' + summary: '' + fullName: graph + remarks: '' + isDeprecated: false + syntax: + content: 'graph: Client' + return: + description: '' + type: + - name: http + uid: '@microsoft/teams.client.App.http' + package: '@microsoft/teams.client' + summary: '' + fullName: http + remarks: '' + isDeprecated: false + syntax: + content: 'http: Client' + return: + description: '' + type: + - name: log + uid: '@microsoft/teams.client.App.log' + package: '@microsoft/teams.client' + summary: The apps logger + fullName: log + remarks: '' + isDeprecated: false + syntax: + content: ILogger log + return: + description: '' + type: + - name: msalInstance + uid: '@microsoft/teams.client.App.msalInstance' + package: '@microsoft/teams.client' + summary: The msal instance used in this app. undefined until the app is started. + fullName: msalInstance + remarks: '' + isDeprecated: false + syntax: + content: undefined | IPublicClientApplication msalInstance + return: + description: '' + type: >- + undefined | + - name: options + uid: '@microsoft/teams.client.App.options' + package: '@microsoft/teams.client' + summary: '' + fullName: options + remarks: '' + isDeprecated: false + syntax: + content: 'options: AppOptions' + return: + description: '' + type: + - name: startedAt + uid: '@microsoft/teams.client.App.startedAt' + package: '@microsoft/teams.client' + summary: The date/time when the app was successfully started. + fullName: startedAt + remarks: '' + isDeprecated: false + syntax: + content: undefined | Date startedAt + return: + description: '' + type: undefined | Date +methods: + - name: ensureConsentForScopes(string[]) + uid: '@microsoft/teams.client.App.ensureConsentForScopes' + package: '@microsoft/teams.client' + summary: >- + Tests whether the user has consented to the specified scopes, and prompts + them if not. This is useful for ensuring + + that the user has consented to the required scopes before calling a graph + API or other resource. + remarks: '' + isDeprecated: false + syntax: + content: 'function ensureConsentForScopes(scopes: string[]): Promise' + parameters: + - id: scopes + type: string[] + description: >- + The scopes to prewarm consent for. The scopes should be for a single + resource, and they + + should not mix the .default scope with named scopes. + return: + description: >- + A value indicating whether consent has been acquired for the specified + scopes. + type: Promise<boolean> + - name: exec(string, unknown, ExecOptions) + uid: '@microsoft/teams.client.App.exec' + package: '@microsoft/teams.client' + summary: Execute a server-side function + remarks: '' + isDeprecated: false + syntax: + content: >- + function exec(name: string, data?: unknown, options?: ExecOptions): + Promise + parameters: + - id: name + type: string + description: The unique function name + - id: data + type: unknown + description: The data to send + - id: options + type: + description: Options + return: + description: The function response + type: Promise<T> + - name: hasConsentForScopes(string[]) + uid: '@microsoft/teams.client.App.hasConsentForScopes' + package: '@microsoft/teams.client' + summary: >- + Tests whether the user has consented to the specified scopes without + prompting the user for consent. + remarks: '' + isDeprecated: false + syntax: + content: 'function hasConsentForScopes(scopes: string[]): Promise' + parameters: + - id: scopes + type: string[] + description: >- + The scopes to check consent for.The scopes should be for a single + resource, and they + + should not mix the .default scope with named scopes. + return: + description: >- + A promise that resolves to a boolean indicating whether the user has + consented to the scopes. + type: Promise<boolean> + - name: start() + uid: '@microsoft/teams.client.App.start' + package: '@microsoft/teams.client' + summary: >- + Starts the library and initializes the dependent teams-js and MSAL + libraries. + remarks: '' + isDeprecated: false + syntax: + content: 'function start(): Promise' + return: + description: |- + A promise that will be fulfilled when the app has started, or + rejected if the initialization fails or times out. + type: Promise<void> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.client/AppOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams.client/AppOptions.yml new file mode 100644 index 0000000..1d1ba6e --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.client/AppOptions.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: AppOptions +uid: '@microsoft/teams.client.AppOptions' +package: '@microsoft/teams.client' +summary: '' +fullName: AppOptions +remarks: '' +isDeprecated: false +syntax: | + type AppOptions = { + logger?: ILogger + msalOptions?: MsalOptions + remoteApiOptions?: RemoteApiOptions + } diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.client/ExecOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams.client/ExecOptions.yml new file mode 100644 index 0000000..643cbeb --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.client/ExecOptions.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: ExecOptions +uid: '@microsoft/teams.client.ExecOptions' +package: '@microsoft/teams.client' +summary: ExecOptions is used to specify options for the exec method. +fullName: ExecOptions +remarks: '' +isDeprecated: false +syntax: | + type ExecOptions = ( + | { msalTokenRequest?: SilentRequest; permission?: never } + | { msalTokenRequest?: never; permission?: string } + ) & { requestHeaders?: Record } diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.client/MsalOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams.client/MsalOptions.yml new file mode 100644 index 0000000..154c4bb --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.client/MsalOptions.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: MsalOptions +uid: '@microsoft/teams.client.MsalOptions' +package: '@microsoft/teams.client' +summary: Options to control how MSAL is initialized and used. +fullName: MsalOptions +remarks: '' +isDeprecated: false +syntax: | + type MsalOptions = ( + | { configuration?: never; msalInstance?: IPublicClientApplication } + | { configuration?: Configuration; msalInstance?: never } + ) & { prewarmScopes?: false | string[] } diff --git a/nodejs/docs-ref-autogen/@microsoft/teams.client/index.yml b/nodejs/docs-ref-autogen/@microsoft/teams.client/index.yml new file mode 100644 index 0000000..25a4903 --- /dev/null +++ b/nodejs/docs-ref-autogen/@microsoft/teams.client/index.yml @@ -0,0 +1,11 @@ +### YamlMime:TSPackage +uid: '@microsoft/teams.client' +name: '@microsoft/teams.client' +summary: '' +type: package +classes: + - '@microsoft/teams.client.App' +typeAliases: + - '@microsoft/teams.client.AppOptions' + - '@microsoft/teams.client.ExecOptions' + - '@microsoft/teams.client.MsalOptions' diff --git a/nodejs/docs-ref-autogen/toc.yml b/nodejs/docs-ref-autogen/toc.yml index 6f47f11..ef01463 100644 --- a/nodejs/docs-ref-autogen/toc.yml +++ b/nodejs/docs-ref-autogen/toc.yml @@ -29,6 +29,11 @@ no-loc: - Activity items: [] + - uid: '@microsoft/teams.api.ActivityInput' + name: ActivityInput + no-loc: + - ActivityInput + items: [] - uid: '@microsoft/teams.api.ActivityLike' name: ActivityLike no-loc: @@ -339,6 +344,11 @@ no-loc: - DeliveryMode items: [] + - uid: '@microsoft/teams.api.DeprecatedInputActivity' + name: DeprecatedInputActivity + no-loc: + - DeprecatedInputActivity + items: [] - uid: '@microsoft/teams.api.EndOfConversationCode' name: EndOfConversationCode no-loc: @@ -444,6 +454,11 @@ no-loc: - IActivity items: [] + - uid: '@microsoft/teams.api.IActivityInput' + name: IActivityInput + no-loc: + - IActivityInput + items: [] - uid: '@microsoft/teams.api.IAdaptiveCardActionInvokeActivity' name: IAdaptiveCardActionInvokeActivity no-loc: @@ -469,6 +484,11 @@ no-loc: - IConfigSubmitInvokeActivity items: [] + - uid: '@microsoft/teams.api.IConversationActivityOperations' + name: IConversationActivityOperations + no-loc: + - IConversationActivityOperations + items: [] - uid: '@microsoft/teams.api.IConversationUpdateActivity' name: IConversationUpdateActivity no-loc: @@ -529,6 +549,11 @@ no-loc: - IMessageActivity items: [] + - uid: '@microsoft/teams.api.IMessageActivityInput' + name: IMessageActivityInput + no-loc: + - IMessageActivityInput + items: [] - uid: '@microsoft/teams.api.IMessageDeleteActivity' name: IMessageDeleteActivity no-loc: @@ -689,6 +714,11 @@ no-loc: - ITypingActivity items: [] + - uid: '@microsoft/teams.api.ITypingActivityInput' + name: ITypingActivityInput + no-loc: + - ITypingActivityInput + items: [] - uid: '@microsoft/teams.api.IUnInstalledActivity' name: IUnInstalledActivity no-loc: @@ -794,6 +824,16 @@ no-loc: - MessageActivity items: [] + - uid: '@microsoft/teams.api.MessageActivityInput' + name: MessageActivityInput + no-loc: + - MessageActivityInput + items: [] + - uid: '@microsoft/teams.api.MessageActivityInputOptions' + name: MessageActivityInputOptions + no-loc: + - MessageActivityInputOptions + items: [] - uid: '@microsoft/teams.api.MessageApp' name: MessageApp no-loc: @@ -1234,6 +1274,16 @@ no-loc: - TypingActivity items: [] + - uid: '@microsoft/teams.api.TypingActivityInput' + name: TypingActivityInput + no-loc: + - TypingActivityInput + items: [] + - uid: '@microsoft/teams.api.TypingActivityInputOptions' + name: TypingActivityInputOptions + no-loc: + - TypingActivityInputOptions + items: [] - uid: '@microsoft/teams.api.UrlTaskModuleTaskInfo' name: UrlTaskModuleTaskInfo no-loc: @@ -1310,6 +1360,11 @@ no-loc: - ExpressAdapter items: [] + - uid: '@microsoft/teams.apps.FunctionContext' + name: FunctionContext + no-loc: + - FunctionContext + items: [] - uid: '@microsoft/teams.apps.HttpMethod' name: HttpMethod no-loc: @@ -1405,6 +1460,11 @@ no-loc: - IFunctionContext items: [] + - uid: '@microsoft/teams.apps.IFunctionContextOptions' + name: IFunctionContextOptions + no-loc: + - IFunctionContextOptions + items: [] - uid: '@microsoft/teams.apps.IHttpServer' name: IHttpServer no-loc: @@ -1515,11 +1575,26 @@ no-loc: - StreamCancelledError items: [] + - uid: '@microsoft/teams.apps.StreamNotAllowedError' + name: StreamNotAllowedError + no-loc: + - StreamNotAllowedError + items: [] + - uid: '@microsoft/teams.apps.StreamTimedOutError' + name: StreamTimedOutError + no-loc: + - StreamTimedOutError + items: [] - uid: '@microsoft/teams.apps.Suffixed' name: Suffixed no-loc: - Suffixed items: [] + - uid: '@microsoft/teams.apps.TerminalStreamError' + name: TerminalStreamError + no-loc: + - TerminalStreamError + items: [] - uid: '@microsoft/teams.apps.UnionToIntersection' name: UnionToIntersection no-loc: @@ -3632,6 +3707,32 @@ no-loc: - VerticalBarChartOptions items: [] +- name: '@microsoft/teams.client' + no-loc: + - '@microsoft/teams.client' + items: + - name: Overview + uid: '@microsoft/teams.client' + - uid: '@microsoft/teams.client.App' + name: App + no-loc: + - App + items: [] + - uid: '@microsoft/teams.client.AppOptions' + name: AppOptions + no-loc: + - AppOptions + items: [] + - uid: '@microsoft/teams.client.ExecOptions' + name: ExecOptions + no-loc: + - ExecOptions + items: [] + - uid: '@microsoft/teams.client.MsalOptions' + name: MsalOptions + no-loc: + - MsalOptions + items: [] - name: '@microsoft/teams.common' no-loc: - '@microsoft/teams.common'