@microsoft/teams-js package

Live Share host implementation for connecting to real-time collaborative sessions. Designed for use with the LiveShareClient class in the @microsoft/live-share package. Learn more at https://aka.ms/teamsliveshare

File object that can be used to represent image or video or audio

Media object returned by the select Media API

VideoController class is used to communicate between the app and the host client during the video capture flow

A strongly-typed class used to represent a "valid" app id.

Valid is a relative term, in this case. Truly valid app ids are UUIDs as documented in the schema: https://learn.microsoft.com/en-us/microsoftteams/platform/resources/schema/manifest-schema#id However, there are some older internal/hard-coded apps which violate this schema and use names like com.microsoft.teamspace.tab.youtube. For compatibility with these legacy apps, we unfortunately cannot securely and completely validate app ids as UUIDs. Based on this, the validation is limited to checking for script tags, length, and non-printable characters. Validation will be updated in the future to ensure the app id is a valid UUID as legacy apps update.

An object that application can utilize to establish communication with the child window it opened, which contains the corresponding task.

Represents a validated email.

An object that is utilized to facilitate communication with a parent window that initiated the opening of current window. For instance, a dialog or task module would utilize it to transmit messages to the application that launched it.

Represents information about the application's host.

Represents application information.

Represents Channel information.

Represents Chat information.

Represents structure of the received context message.

Represents the failure request sent during an erroneous app initialization.

Represents the failed request sent during a failed app initialization.

Represents Meeting information.

The response of the notify success callback.

Represents Page information.

Represents information about a SharePoint site

Represents Team information.

Represents Tenant information.

Represents User information.

Represents set of parameters needed to open the appInstallDialog.

Describes the authentication pop-up parameters

Describes authentication token request parameters

Data structure to customize the barcode scanning experience in scanBarCode API. All properties in BarCodeConfig are optional and have default values in the platform

Compose meeting parameters

Open calendar item parameters.

Represents parameters for StartCall.

Used when starting a chat with more than one person

See OpenSingleChatRequest for use in a chat with only one person

Used when starting a chat with one person

See OpenGroupChatRequest for use when a chat with more than one person

Data Structure to represent the SDK response when dialog closes

Data struture to represent the location information

Parameters supplied when composing a new mail item

Parameters supplied when composing a reply to or forward of a message

See ComposeMailType

Defines the parameters used to open a mail item in the user's mailbox

Helper object to assembled media chunks

All properties in AudioProps are optional and have default values in the platform

Barcode configuration supplied to scanBarCode API to customize barcode scanning experience in mobile All properties in BarCodeConfig are optional and have default values in the platform

All properties in ImageProps are optional and have default values in the platform

Input for view images API

Media chunks an output of getMedia API from platform

Input parameter supplied to the select Media API

Output of getMedia API from platform

All properties in VideoAndImageProps are optional and have default values in the platform

Callback which will register your app to listen to lifecycle events during the video capture flow

All properties in VideoProps are optional and have default values in the platform

Represents app permission to share contents to meeting.

Represents app being shared to stage.

Defines additional sharing options which can be provided to the shareAppContentToStage API.

Property bag for the speakingState changed event

Contains information associated with parameters required for joining the Microsoft Teams meetings. More details regarding parameters can be found at: Online Meeting Base - Microsoft Graph v1.0

Represents the current Real-Time Messaging Protocol (RTMP) live streaming state of a meeting.

Parameters used to create an action menu within an app

Type-safer version of parameters for the navigateToApp function

Describes the results of the settings.remove event. Includes notifySuccess, and notifyFailure to indicate the status of whether the settings.save call succeeded or not and why.

Describes the results of the settings.save event. Includes result, notifySuccess, and notifyFailure to indicate the return object (result) and the status of whether the settings.save call succeeded or not and why.

Parameters used in the settings.save event

Parameters provided to the navigateTo function

Defines the configuration of the current or desired instance

Input parameter supplied to the People Picker API

Output user object of people picker API

The persona to show the profile for.

Input parameters provided to the showProfile API.

This interface contains information pertaining to the contents of the host M365 application's search box

Represents the data returned when calling getContent

Represents IShareRequest parameters interface.

Represents IURLContent parameters.

Parameters to open a stage view.

Interface to assemble file chunks

File chunks an output of getDragAndDropFiles API from platform

Output of getDragAndDropFiles API from platform

Object used to represent a file

Represents a video frame

VideoFrame definition, align with the W3C spec: https://www.w3.org/TR/webcodecs/#videoframe-interface. The current version of typescript doesn't have the definition of VideoFrame so we have to define it here. At runtime it can be cast to VideoFrame directly: (videoFrame as VideoFrame).

Video frame configuration supplied to the host to customize the generated video frame parameters, like format

Information about an Action.

Data structure to describe dialog information needed to open an Adaptive Card-based dialog.

Represents the major and minor versions of the Adaptive Card schema in the current host

Data pertaining to object(s) the action is being performed on

Data structure to describe dialog information needed to open a bot-based Adaptive Card-based dialog.

Data structure to describe dialog information needed to open a bot based dialog.

Data structure to describe dialog information

Data structure to represent the size of a dialog

Represents information about a frame within a tab or dialog module.

Meant for passing data to the app related to host-to-app message performance metrics.

Represents a window or frame within the host app.

Interface for objects that can be serialized and passed to the host

Represents OS locale info used for formatting date and time data

Stores information needed to represent content stored in OneDrive or Sharepoint

Data structure to be used with the app.lifecycle.registerOnResumeHandler(handler: (context: ResumeContext) => void): void to pass the context to the app.

Represents an error that occurs during the execution of an app or integration.

Contains additional IDs of the content that the action is triggered from. Maps to ids used in the Graph.

Represents the parameters used to share a deep link.

Represents information about tabs for an app

Represents information about a tab instance

Indicates information about the tab instance for filtering purposes.

Represents Team Information

Data structure to describe dialog information needed to open a url-based dialog.

This function is passed to registerHostToAppPerformanceMetricsHandler. It is called every time a response is received from the host with metrics for analyzing message delay. See HostToAppPerformanceMetrics to see which metrics are passed to the handler.

Register before suspendOrTerminate handler function type

Register on resume handler function type

This function is passed to registerOnThemeHandler. It is called every time the user changes their theme.

See LegacyCallBacks

Handler used for receiving results when a dialog closes, either the value passed by submit(string | object, string | string[]) or an error if the dialog was closed by the user.

See ISdkResponse

Handler used to receive and process messages sent between a dialog and the app that launched it

Get location callback function type

Show location callback function type

Parameters supplied to composeMail when composing a new mail item

See ComposeNewParams See ComposeReplyOrForwardParams See ComposeMailType

Function callback type used when calling captureImage.

Error callback function type.

Function callback type used when calling getMedia

Function callback type used when calling scanBarCode.

Function callback type used when calling selectMedia.

Error callback function type

Get app content stage sharing capabilities callback function type

Get app content stage sharing state callback function type

Get live stream state callback function type

Live stream error callback function type

Register live stream changed handler function type

Register speaking state change handler function type

Back button handler function

Full screen function

Callback function

Remove event function

Save event function

Select people callback function type

The type of modalities that are supported when showing a profile. Can be provided as an optional hint with the request and will be respected if the hosting M365 application supports it.

The set of identifiers that are supported for resolving the persona.

At least one is required, and if multiple are provided then only the highest priority one will be used (AadObjectId > Upn > Smtp). AAD is now known as "Microsoft Entra ID"

The type of the profile trigger.

• MouseHover: The user hovered a target.
• Press: The target was pressed with either a mouse click or keyboard key press.
• AppRequest: The show profile request is happening programmatically, without direct user interaction.

This type will store the SearchQuery and allow other logic to be made inside the handler.

Get settings callback function type

Register on remove handler function type

Register on save handler function type

Set settings on complete function type

IShareRequestContentType defines share request type.

shareWebContent callback function type

Function type that is used to receive the result when a task module is submitted by calling tasks.submitTask(result?: string | object, appIds?: string | string[]): void

Ready to unload function type

Register before unload handler function type

Register on load handler function type

Notify error function type

Notify video frame processed function type

Callbacks and configuration supplied to the host to process the video frames.

Video frame call back function definition The callback will be called on every frame when running on the supported host. We require the frame rate of the video to be at least 22fps for 720p, thus the callback should process a frame timely. The video app should call notifyVideoFrameProcessed to notify a successfully processed video frame. The video app should call notifyError to notify a failure. When the failures accumulate to a certain number, the host will see the app is "frozen" and ask the user to close it or not.

Video effect change call back function definition Return a Promise which will be resolved when the effect is prepared, or throw an EffectFailureReason on error.

Video frame data extracted from the media stream. More properties may be added in the future.

Video frame call back function definition. The callback will be called on every frame when running on the supported host. We require the frame rate of the video to be at least 22fps for 720p, thus the callback should process a frame timely. The video app should resolve the promise to notify a successfully processed video frame. The video app should reject the promise to notify a failure. When the failures accumulate to a certain number, the host will see the app is "frozen" and ask the user to close it or not.

addEventListner function type

Callback function type

Type of callback used to indicate when executeDeepLink completes

Get context callback function type

Get tab instances callback function type

onComplete function type

Navigation on complete handler function type

Register back button handler function type

Register full screen handler function type

Register on theme change handler function type

Describes expected errors that occurred during an otherwise successful app initialization

Describes errors that caused app initialization to fail

Modalities that can be associated with a call.

Defines compose mail types.

The modes in which camera can be launched in select Media API

Enum for file formats supported

Specifies the image output formats.

ID contains a mapping for content uri on platform's side, URL is generic

Events which are used to communicate between the app and the host client during the media recording flow

Specifies the type of Media

Specifies the image source

The source of the join button click.

Represents the protocol option for sharing app content to the meeting stage.

Defines how a menu item should appear in the NavBar.

Return focus action items

The open mode for stage content.

Video effect change type enum

Predefined failure reasons for preparing the selected video effect

Video frame format enum, currently only support NV12

Types of Action Objects

The type of the channel with which the content is associated.

Dialog module dimension enum

Error codes used to identify different types of errors that can occur while developing apps.

Allowed user file open preferences

FrameContexts provides information about the context in which the app is running within the host. Developers can use FrameContexts to determine how their app should behave in different contexts, and can use the information provided by the context to adapt the app to the user's needs.

Example

If your app is running in the "settings" context, you should be displaying your apps configuration page.
If the app is running in the content context, the developer may want to display information relevant to
the content the user is currently viewing.

HostClientType represents the different client platforms on which host can be run.

HostName indicates the possible hosts for your application.

These correspond with field names in the MSGraph. See commonly accessed resources.

Indicates the team type, currently used to distinguish between different team types in Office 365 for Education (team types 1, 2, 3, and 4).

Indicates the various types of roles of a user in a team.