Share via


@microsoft/agents-hosting-extensions-teams package

Classes

Meeting

Class that exposes all Teams meeting-related events. Provides an organized way to handle meeting events in Microsoft Teams.

TeamsActivityHandler

A handler for processing Microsoft Teams-specific activities. Extends the ActivityHandler class to provide additional Teams-specific functionality. This class includes methods for handling various Teams events, such as message updates, channel events, and meeting events.

TeamsAgentExtension
TeamsAttachmentDownloader

Downloads attachments from Teams using the bots access token.

TeamsConnectorClient

A client for interacting with Microsoft Teams APIs. Extends the ConnectorClient class to provide Teams-specific functionalities.

TeamsInfo

Provides utility methods for interacting with Microsoft Teams-specific features. This class includes methods for retrieving team details, meeting information, sending messages, and managing operations within the Teams environment.

Interfaces

AppBasedLinkQuery

Represents a query for an app-based link.

BatchFailedEntriesResponse

Represents the response for failed entries in a batch operation.

BatchFailedEntry

Represents a failed entry in a batch operation.

BatchOperationResponse

Represents the response of a batch operation.

BatchOperationStateResponse

Represents the state of a batch operation.

ChannelInfo

Represents information about a channel.

FeedbackLoopData

Data returned when feedback has been enabled and a messages thumbs-up or thumbs-down button is clicked.

MeetingDetails

Interface representing the details of a meeting.

MeetingDetailsBase

Interface representing the base details of a meeting.

MeetingEndEventDetails

Interface representing the details of a meeting end event.

MeetingEventDetails

Interface representing the details of a meeting event.

MeetingNotificationChannelData

Interface representing the channel data for a meeting notification.

MeetingNotificationRecipientFailureInfo

Interface representing the failure information of a meeting notification recipient.

MeetingParticipantsEventDetails

Interface representing the details of a meeting participants event.

MeetingStageSurface

Interface representing the surface of a meeting stage.

MeetingStartEventDetails

Interface representing the details of a meeting start event.

MeetingTabIconSurface

Interface representing a meeting tab icon surface.

MessagingExtensionAction

Represents an action for a messaging extension.

MessagingExtensionActionResponse

Represents the response of a messaging extension action.

MessagingExtensionAttachment

Represents an attachment for a messaging extension.

MessagingExtensionParameter

Represents a parameter for a messaging extension query.

MessagingExtensionQuery

Represents a query for a messaging extension.

MessagingExtensionQueryOptions

Represents query options for a messaging extension.

MessagingExtensionResponse

Represents the response of a messaging extension.

MessagingExtensionResult

Represents the result of a messaging extension.

MessagingExtensionSuggestedAction

Represents suggested actions for a messaging extension.

NotificationInfo

Represents information about a notification.

OnBehalfOf

Represents information about a user on behalf of whom an action is performed.

ResourceResponse

Represents a response containing a resource ID.

TargetedMeetingNotification

Interface representing a targeted meeting notification.

TargetedMeetingNotificationValue

Interface representing the value of a targeted meeting notification.

TaskModuleContinueResponse

Interface representing the continue response of a task module.

TaskModuleMessageResponse

Interface representing the message response of a task module.

TaskModuleRequest

Interface representing the request of a task module.

TaskModuleRequestContext

Interface representing the context of a task module request.

TaskModuleResponse

Interface representing the response of a task module.

TaskModuleResponseBase

Interface representing the base response of a task module.

TaskModuleTaskInfo

Interface representing the task module task information.

TeamDetails

Represents details of a Microsoft Teams team.

TeamInfo

Represents information about a team.

TeamsChannelAccount

Represents a Teams channel account.

TeamsChannelData

Represents data for a Teams channel.

TeamsChannelDataSettings

Represents settings for Teams channel data.

TeamsMeetingInfo

Represents information about a Teams meeting.

TeamsMeetingMember

Interface representing a member of a Teams meeting.

TeamsMeetingParticipant

Interface representing a participant in a Teams meeting.

TeamsPagedMembersResult

Represents a paged result of Teams members.

TenantInfo

Represents information about a tenant.

UserMeetingDetails

Interface representing the details of a user's meeting.

Type Aliases

AttachmentLayout

Layout options for attachments.

CancelOperationResponse

Represents the response from a cancel operation.

CommandContext

Contexts for messaging extension commands.

MeetingNotification

Represents a meeting notification.

MeetingSurface

Type representing a meeting surface, which can be either a stage surface or a tab icon surface.

MessagePreviewActionType

Types of actions for message previews.

MessagePreviewType

Type representing the message preview type.

MessagingExtensionResultType

Types of messaging extension results.

  • result: Represents a standard result.
  • auth: Represents an authentication request.
  • config: Represents a configuration request.
  • message: Represents a message result.
  • botMessagePreview: Represents a bot message preview.
  • silentAuth: Represents a silent authentication request.
TeamsBatchOperationResponse

Represents a response from a batch operation in Teams.

TeamsConversationUpdateEvents

Represents the types of conversation update events specific to Microsoft Teams. Extends the base ConversationUpdateEvents with additional Teams-specific events.

TeamsMember

Represents a member in a Microsoft Teams team.

TeamsMessageEvents

Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License.

Functions

parseTeamsChannelData(object)

Parses the given object as TeamsChannelData.

parseValueMessagingExtensionQuery(unknown)

Parses the given value as a messaging extension query.

Function Details

parseTeamsChannelData(object)

Parses the given object as TeamsChannelData.

function parseTeamsChannelData(o: object): TeamsChannelData

Parameters

o

object

The object to parse.

Returns

  • The parsed TeamsChannelData.

parseValueMessagingExtensionQuery(unknown)

Parses the given value as a messaging extension query.

function parseValueMessagingExtensionQuery(value: unknown): MessagingExtensionQuery

Parameters

value

unknown

The value to parse.

Returns

  • The parsed messaging extension query.