@microsoft/teams.apps package

Classes

ActivityContext
App	The orchestrator for receiving/sending activities
HttpPlugin	Can send/receive activities via http
HttpStream	component that can send streamed chunks of an activity

Interfaces

IActivityContext
IActivityContextOptions
IActivityErrorContext
IActivityEvent	the event emitted by a plugin when an activity is received
IActivityResponseEvent	the event emitted by a plugin before an invoke response is returned
IActivitySentEvent	the event emitted by a plugin when an activity is sent
IActivitySignInContext
IClientContext
IErrorEvent	the event emitted by a plugin when an error occurs
IEvent	some event emitted from either the App or a Plugin
IEvents
IFunctionContext
IPlugin	a component for extending the base App functionality
IPluginActivityEvent	the event emitted by a plugin when an activity is received
IPluginActivityResponseEvent	the event emitted by a plugin before an activity response is sent
IPluginActivitySentEvent	the event emitted by a plugin when an activity is sent
IPluginErrorEvent	the event emitted when an error occurs
IPluginStartEvent	the event emitted when a plugin is started
ISender	a plugin that can send activities
IStreamer	component that can send streamed chunks of an activity
IStreamerEvents	the minimum events a streamer should support

Type Aliases

@microsoft/teams.apps.manifest.GroupChat

ActionType	executeFunction: Run a script function without waiting for it to finish. openPate: Open a page in a view.
Activities
ActivityType
AdditionalLanguage
Align	Define alignment of this custom tab relative to the specified built-in tab.
AlternateIcons
APISecretServiceAuthConfiguration	Object capturing details needed to do service auth. It will be only present when auth type is apiSecretServiceAuth.
AuthType	Enum of possible authentication types.
Bot
BotConfiguration	The configuration for the bot source. Required if sourceType is set to bot.
Capability
Choice
COMAddin
CommandContext
CommandList
CommandListCommand
CommandListScope
CommandType	Type of the command
ComposeExtension
ComposeExtensionAuthorization	Object capturing authorization information.
ComposeExtensionCommand
ComposeExtensionType	Type of the compose extension.
ConfigurableProperty
ConfigurableTab
ConfigurableTabContext
ConfigurableTabScope
Configuration
Connector
ConnectorScope
CopilotAgents
CustomOfficeAddin
DashboardCard	Cards wich could be pinned to dashboard providing summarized view of information relevant to user.
DashboardCardContentSource	Represents a configuration for the source of the card’s content.
DashboardCardIcon	Represents a configuration for the source of the card’s content
DeclarativeAgentRef	A reference to a declarative agent element. The element's definition is in a separate file.
DefaultGroupCapability	When a group install scope is selected, this will define the default capability when the user installs the app
DefaultInstallScope	The install scope defined for this app by default. This will be the option displayed on the button when a user tries to add the app
DefaultSize	Rendering Size for dashboard card.
Description
Developer
DevicePermission
ElementExtension	The set of extensions for this app. Currently only one extensions per app is supported.
Event
ExtensionAlternateVersionsArray
ExtensionAutoRunEventsArray
ExtensionCommonCustomControlMenuItem
ExtensionCommonCustomGroupControlsItem
ExtensionCommonIcon
ExtensionCommonSuperToolTip
ExtensionContext	Specifies the Office application windows in which the ribbon customization is available to the user. Each item in the array is a member of a string array. Possible values are: mailRead, mailCompose, meetingDetailsOrganizer, meetingDetailsAttendee.
ExtensionCustomMobileIcon
ExtensionRibbonsArray
ExtensionRibbonsArrayTabsItem
ExtensionRibbonsCustomMobileControlButtonItem
ExtensionRibbonsCustomMobileGroupItem
ExtensionRibbonsCustomTabGroupsItem
ExtensionRuntimeCode
ExtensionRuntimesActionsItem	Specifies the set of actions supported by this runtime. An action is either running a JavaScript function or opening a view such as a task pane.
ExtensionRuntimesArray	A runtime environment for a page or script
FluffyType	Defines the type of control whether button or menu.
FormFactor
GraphConnector	Specify the app's Graph connector configuration. If this is present then webApplicationInfo.id must also be specified.
Groupchat	When the install scope selected is GroupChat, this field specifies the default capability available When the install scope selected is Meetings, this field specifies the default capability available When the install scope selected is Team, this field specifies the default capability available
Hide
Icons
InputType	Type of the parameter
ItemType	Supported values: menuItem.
Lifetime	Runtimes with a short lifetime do not preserve state across executions. Runtimes with a long lifetime do.
LocalizationInfo
Manifest
ManifestAuthorization	Specify and consolidates authorization related information for the App.
ManifestVersion
MeetingExtensionDefinition	Specify meeting extension definition.
MeetingSurface
MessageHandler
MessageHandlerType	Type of the message handler
MicrosoftEntraConfiguration	Object capturing details needed to do single aad auth flow. It will be only present when auth type is entraId.
Name
Options	Configures how Outlook responds to the event.
Parameter
Permission
Permissions	List of permissions that the app needs to function.
Position
Prefer
PurpleType
RequirementsExtensionElement
RequirementsScope
ResourceSpecific
ResourceSpecificType	The type of the resource-specific permission: delegated vs application.
RuntimeType	Supports running functions and launching pages.
SamplePrompt
Scene
SendMode
SourceType	The content of the dashboard card is sourced from a bot.
StaticTab
StaticTabContext
StoreOfficeAddin
SubscriptionOffer	Subscription offer associated with this app.
SupportedChannelType
SupportedSharePointHost
TaskInfo
Value
WebApplicationInfo	Specify your AAD App ID and Graph information to help users seamlessly sign into your AAD app.
AppActivityOptions
AppOptions	App initialization options
AppTokens
DependencyOptions	options for a plugins dependency that should get injected into it by the App
EventHandler
OAuthSettings
OnActivityPluginEvent	emitted when the plugin receives an activity
OnErrorPluginEvent	emitted when the plugin encounters an error
PluginName	represents a plugins unique name
PluginOptions	options for the plugins
Prefixed
RouteHandler
Suffixed

Functions

Dependency(DependencyOptions)	add plugin dependencies via @Dependency()
Event(PluginEventName)	add an event emitter to your plugin via @Event(...)
Logger()	inject the App ILogger instance
Plugin(Partial<PluginOptions>)	turn any class into a plugin via @Plugin({ ... })
Storage()	inject the App IStorage instance

Function Details

Dependency(DependencyOptions)

add plugin dependencies via @Dependency()

function Dependency(options?: DependencyOptions): (target: any, propertyKey: string | ClassFieldDecoratorContext) => void

Parameters

options

DependencyOptions

Returns

(target: any, propertyKey: string | ClassFieldDecoratorContext) => void

Event(PluginEventName)

add an event emitter to your plugin via @Event(...)

function Event(name: PluginEventName): (target: any, propertyKey: string | ClassFieldDecoratorContext) => void

Parameters

name

PluginEventName

Returns

(target: any, propertyKey: string | ClassFieldDecoratorContext) => void

Logger()

inject the App ILogger instance

function Logger(): (target: any, propertyKey: string | ClassFieldDecoratorContext) => void

Returns

(target: any, propertyKey: string | ClassFieldDecoratorContext) => void

Plugin(Partial<PluginOptions>)

turn any class into a plugin via @Plugin({ ... })

function Plugin(metadata?: Partial<PluginOptions>): (Base: T) => T

Parameters

metadata

Partial<PluginOptions>

Returns

(Base: T) => T

Storage()

inject the App IStorage instance

function Storage(): (target: any, propertyKey: string | ClassFieldDecoratorContext) => void

Returns

(target: any, propertyKey: string | ClassFieldDecoratorContext) => void