@microsoft/teams-js package
Classes
| ChildAppWindow | |
| Communication | |
| GlobalVars | |
| File |
File object that can be used to represent image or video or audio |
| Media |
Media object returned by the select Media API |
| VideoController |
VideoController class is used to communicate between the app and the host client during the video capture flow. |
| MenuItem |
Represents information about menu item for Action Menu and Navigation Bar Menu. |
| ParentAppWindow | |
| ChildAppWindow | |
| Communication | |
| GlobalVars | |
| File |
File object that can be used to represent image or video or audio |
| Media |
Media object returned by the select Media API |
| VideoController |
VideoController class is used to communicate between the app and the host client during the video capture flow. |
| MenuItem |
Represents information about menu item for Action Menu and Navigation Bar Menu. |
| ParentAppWindow | |
Interfaces
| IExpectedFailureRequest | |
| IFailedRequest | |
| AuthenticateParameters | |
| AuthTokenRequest | |
| Context | |
| DeepLinkParameters | |
| FrameContext | |
| IAppWindow | |
| LocaleInfo |
Represents OS locale info used for formatting date and time data |
| Location | |
| LocationProps | |
| AssembleAttachment |
Helper object to assembled media chunks |
| AudioProps |
All properties in AudioProps are optional and have default values in the platform |
| BarCodeConfig |
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. |
| ImageProps |
All properties in ImageProps are optional and have default values in the platform |
| ImageUri |
Input for view images API |
| MediaChunk |
Media chunks an output of getMedia API from platform |
| MediaInputs |
Input parameter supplied to the select Media API |
| VideoAndImageProps |
All properties in VideoAndImageProps are optional and have default values in the platform. |
| VideoControllerCallback |
Callback which will register your app to listen to lifecycle events during the video capture flow. |
| VideoProps |
All properties in VideoProps are optional and have default values in the platform. |
| IAppContentStageSharingCapabilities | |
| IAppContentStageSharingState | |
| ISpeakingState | |
| LiveStreamState | |
| ActionMenuParameters | |
| ViewConfiguration |
Represents information about item in View Configuration. |
| ViewData |
Represents information about view to show on Navigation Bar Menu item selection. |
| MessageRequest | |
| MessageResponse | |
| PeoplePickerInputs |
Input parameter supplied to the People Picker API |
| PeoplePickerResult |
Output user object of people picker API |
| SdkError | |
| RemoveEvent | |
| SaveEvent | |
| SaveParameters | |
| Settings | |
| IBaseSharedContent | |
| IShareRequest | |
| IURLContent | |
| ShowNotificationParameters | |
| StageViewParams |
Parameters to open a stage view. |
| TabInformation |
Represents information about tabs for an app |
| TabInstance |
Represents information about a tab instance |
| TabInstanceParameters |
Indicates information about the tab instance for filtering purposes. |
| TaskInfo | |
| TeamInformation |
Represents Team Information |
| VideoFrame |
Represents a video frame. |
| VideoFrameConfig |
Video frame configuration supplied to Teams to customize the generated video frame parameters, like format. |
| IExpectedFailureRequest | |
| IFailedRequest | |
| AuthenticateParameters | |
| AuthTokenRequest | |
| Context | |
| DeepLinkParameters | |
| FrameContext | |
| IAppWindow | |
| LocaleInfo |
Represents OS locale info used for formatting date and time data |
| Location | |
| LocationProps | |
| AssembleAttachment |
Helper object to assembled media chunks |
| AudioProps |
All properties in AudioProps are optional and have default values in the platform. |
| BarCodeConfig |
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 |
| ImageProps |
All properties in ImageProps are optional and have default values in the platform. |
| ImageUri |
Input for view images API |
| MediaChunk |
Media chunks an output of getMedia API from platform |
| MediaInputs |
Input parameter supplied to the select Media API |
| VideoAndImageProps |
All properties in VideoAndImageProps are optional and have default values in the platform |
| VideoControllerCallback |
Callback which will register your app to listen to lifecycle events during the video capture flow |
| VideoProps |
All properties in VideoProps are optional and have default values in the platform. |
| IAppContentStageSharingCapabilities | |
| IAppContentStageSharingState | |
| ISpeakingState | |
| LiveStreamState | |
| ActionMenuParameters | |
| ViewConfiguration |
Represents information about item in View Configuration. |
| ViewData |
Represents information about view to show on Navigation Bar Menu item selection |
| MessageRequest | |
| MessageResponse | |
| PeoplePickerInputs |
Input parameter supplied to the People Picker API |
| PeoplePickerResult |
Output user object of people picker API |
| SdkError | |
| RemoveEvent | |
| SaveEvent | |
| SaveParameters | |
| Settings | |
| IBaseSharedContent | |
| IShareRequest | |
| IURLContent | |
| ShowNotificationParameters | |
| StageViewParams |
Parameters to open a stage view. |
| TabInformation |
Represents information about tabs for an app |
| TabInstance |
Represents information about a tab instance |
| TabInstanceParameters |
Indicates information about the tab instance for filtering purposes. |
| TaskInfo | |
| TeamInformation |
Represents Team Information |
| VideoFrame |
Represents a video frame. |
| VideoFrameConfig |
Video frame configuration supplied to Teams to customize the generated video frame parameters, like format. |
Type Aliases
| ContentType | |
| IShareRequestContentType | |
| VideoEffectCallBack |
Video effect change call back function definition |
| VideoFrameCallback |
Video frame call back function definition |
| ContentType | |
| IShareRequestContentType | |
| VideoEffectCallBack |
Video effect change call back function definition |
| VideoFrameCallback |
Video frame call back function definition |
Enums
| ExpectedFailureReason | |
| FailedReason | |
| ChannelType |
The type of the channel with which the content is associated. |
| ErrorCode | |
| FileOpenPreference |
Allowed user file open preferences |
| FrameContexts | |
| HostClientType | |
| CameraStartMode |
The modes in which camera can be launched in select Media API |
| FileFormat |
Enum for file formats supported |
| ImageOutputFormats |
Specifies the image output formats. |
| ImageUriType |
ID contains a mapping for content uri on platform side, URL is generic. |
| MediaType |
Specifies the type of Media |
| Source |
Specifies the image source |
| CallType | |
| MeetingType | |
| DisplayMode |
Defines how a menu item should appear in the NavBar. |
| MenuListType |
Represents information about type of list to display in Navigation Bar Menu. |
| NotificationTypes | |
| TaskModuleDimension |
Task module dimension enum |
| TeamType |
Indicates the team type, currently used to distinguish between different team types in Office 365 for Education (team types 1, 2, 3, and 4). |
| UserTeamRole |
Indicates the various types of roles of a user in a team. |
| EffectChangeType |
Video effect change type enum |
| VideoFrameFormat |
Video frame format enum, currently only support NV12 |
| ExpectedFailureReason | |
| FailedReason | |
| ChannelType |
The type of the channel with which the content is associated. |
| ErrorCode | |
| FileOpenPreference |
Allowed user file open preferences |
| FrameContexts | |
| HostClientType | |
| CameraStartMode |
The modes in which camera can be launched in select Media API |
| FileFormat |
Enum for file formats supported |
| ImageOutputFormats |
Specifies the image output formats. |
| ImageUriType |
ID contains a mapping for content uri on platform side, URL is generic |
| MediaType |
Specifies the type of Media |
| Source |
Specifies the image source |
| CallType | |
| MeetingType | |
| DisplayMode |
Defines how a menu item should appear in the NavBar. |
| MenuListType |
Represents information about type of list to display in Navigation Bar Menu. |
| NotificationTypes | |
| TaskModuleDimension |
Task module dimension enum |
| TeamType |
Indicates the team type, currently used to distinguish between different team types in Office 365 for Education (team types 1, 2, 3, and 4). |
| UserTeamRole |
Indicates the various types of roles of a user in a team. |
| EffectChangeType |
Video effect change type enum |
| VideoFrameFormat |
Video frame format enum, currently only support NV12 |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for