@microsoft/teams-js package
Classes
| 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 |
| ChildAppWindow |
An object that application can utilize to establish communication with the child window it opened, which contains the corresponding task. |
| LiveShareHost |
Live Share host implementation for connecting to real-time collaborative sessions.
Designed for use with the |
| ParentAppWindow |
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. |
| VideoPerformanceMonitor |
This class is used to monitor the performance of video processing, and report performance events. |
Interfaces
| AppHostInfo |
Represents information about the application's host. |
| AppInfo |
Represents application information. |
| ChannelInfo |
Represents Channel information. |
| ChatInfo |
Represents Chat information. |
| Context |
Represents structure of the received context message. |
| IExpectedFailureRequest |
Represents the failure request sent during an erroneous app initialization. |
| IFailedRequest |
Represents the failed request sent during a failed app initialization. |
| MeetingInfo |
Represents Meeting information. |
| PageInfo |
Represents Page information. |
| SharePointSiteInfo |
Represents information about a SharePoint site |
| TeamInfo |
Represents Team information. |
| TenantInfo |
Represents Tenant information. |
| UserInfo |
Represents User information. |
| OpenAppInstallDialogParams |
Represents set of parameters needed to open the appInstallDialog. |
| AuthenticatePopUpParameters |
Describes the authentication pop-up parameters |
| AuthTokenRequestParameters |
Describes authentication token request parameters |
| LegacyCallBacks | |
| BarCodeConfig |
Data structure to customize the barcode scanning experience in scanBarCode API. All properties in BarCodeConfig are optional and have default values in the platform |
| ComposeMeetingParams |
Compose meeting parameters |
| OpenCalendarItemParams |
Open calendar item parameters. |
| StartCallParams |
Represents parameters for StartCall. |
| ISdkResponse |
Data Structure to represent the SDK response when dialog closes |
| Location |
Data struture to represent the location information |
| Location | |
| LocationProps | |
| ComposeNewParams |
Parameters supplied when composing a new mail item |
| ComposeReplyOrForwardParams |
Parameters supplied when composing a reply to or forward of a message See ComposeMailType |
| OpenMailItemParams |
Defines the parameters used to open a mail item in the user's mailbox |
| 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 |
| MediaResult |
Output of getMedia API from platform |
| 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 |
Represents app permission to share contents to meeting. |
| IAppContentStageSharingState |
Represents app being shared to stage. |
| IShareAppContentToStageOptions |
Defines additional sharing options which can be provided to the shareAppContentToStage API. |
| ISpeakingState |
Property bag for the speakingState changed event |
| JoinMeetingParams |
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 |
| LiveStreamState |
Represents the current Real-Time Messaging Protocol (RTMP) live streaming state of a meeting. |
| ActionMenuParameters |
Parameters used to create an action menu within an app |
| RemoveEvent |
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. |
| SaveEvent |
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. |
| SaveParameters |
Parameters used in the settings.save event |
| NavigateWithinAppParams |
Parameters for the NavigateWithinApp |
| InstanceConfig |
Defines the configuration of the current or desired instance |
| NavigateToAppParams |
Parameters for the NavigateToApp API |
| PeoplePickerInputs |
Input parameter supplied to the People Picker API |
| PeoplePickerResult |
Output user object of people picker API |
| Persona |
The persona to show the profile for. |
| ShowProfileRequest |
Input parameters provided to the showProfile API. |
| SearchQuery |
This interface contains information pertaining to the contents of the host M365 application's search box |
| IShareRequest |
Represents IShareRequest parameters interface. |
| IURLContent |
Represents IURLContent parameters. |
| StageViewParams |
Parameters to open a stage view. |
| AssembleAttachment |
Interface to assemble file chunks |
| DragAndDropFileCallback | |
| FileChunk |
File chunks an output of getDragAndDropFiles API from platform |
| FileResult |
Output of getDragAndDropFiles API from platform |
| FilesFor3PStorage |
Object used to represent a file |
| VideoBufferData |
Represents a video frame |
| VideoFrame |
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: |
| VideoFrameConfig |
Video frame configuration supplied to the host to customize the generated video frame parameters, like format |
| ActionInfo |
Information common to all actions |
| AdaptiveCardDialogInfo |
Data structure to describe dialog information needed to open an Adaptive Card-based dialog. |
| AdaptiveCardVersion |
Represents the major and minor versions of the Adaptive Card schema in the current host |
| BaseActionObject |
Data pertaining to object(s) the action is being performed on |
| BotAdaptiveCardDialogInfo |
Data structure to describe dialog information needed to open a bot-based Adaptive Card-based dialog. |
| BotUrlDialogInfo |
Data structure to describe dialog information needed to open a bot based dialog. |
| ClipboardParams |
Clipboard write parameters |
| Context | |
| DeepLinkParameters | |
| DialogInfo |
Data structure to describe dialog information |
| DialogSize |
Data structure to represent the size of a dialog |
| FrameInfo |
Represents information about a frame within a tab or dialog module. |
| IAppWindow |
Represents a window or frame within the host app. |
| LocaleInfo |
Represents OS locale info used for formatting date and time data |
| M365ContentAction |
Stores information needed to represent M365 Content stored in OneDrive or Sharepoint |
| OpenConversationRequest | |
| OpenGroupChatRequest |
Used when starting a chat with more than one person See OpenSingleChatRequest for use in a chat with only one person |
| OpenSingleChatRequest |
Used when starting a chat with one person See OpenGroupChatRequest for use when a chat with more than one person |
| ResumeContext |
Data structure to be used with the app.lifecycle.registerOnResumeHandler(handler: (context: ResumeContext) => void): void to pass the context to the app. |
| SdkError |
Represents an error that occurs during the execution of an app or integration. |
| SecondaryId |
Contains information on what Graph item is being queried |
| ShareDeepLinkParameters |
Represents the parameters used to share a deep link. |
| 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. |
| TeamInformation |
Represents Team Information |
| UrlDialogInfo |
Data structure to describe dialog information needed to open a url-based dialog. |
Type Aliases
| registerBeforeSuspendOrTerminateHandlerFunctionType |
Register before suspendOrTerminate handler function type |
| registerOnResumeHandlerFunctionType |
Register on resume handler function type |
| themeHandler |
This function is passed to registerOnThemeHandler. It is called every time the user changes their theme. |
| AuthenticateParameters |
See LegacyCallBacks |
| AuthTokenRequest | |
| DialogSubmitHandler |
Handler used for receiving results when a dialog closes, either the value passed by See |
| PostMessageChannel |
Handler used to receive and process messages sent between a dialog and the app that launched it |
| getLocationCallbackFunctionType |
Get location callback function type |
| showLocationCallbackFunctionType |
Show location callback function type |
| ComposeMailParams |
Parameters supplied to composeMail when composing a new mail item See ComposeNewParams See ComposeReplyOrForwardParams See ComposeMailType |
| captureImageCallbackFunctionType |
Function callback type used when calling captureImage. |
| errorCallbackFunctionType |
Error callback function type. |
| getMediaCallbackFunctionType |
Function callback type used when calling getMedia |
| scanBarCodeCallbackFunctionType |
Function callback type used when calling scanBarCode. |
| selectMediaCallbackFunctionType |
Function callback type used when calling selectMedia. |
| errorCallbackFunctionType |
Error callback function type |
| getAppContentCallbackFunctionType |
Get app content stage sharing capabilities callback function type |
| getAppContentStageCallbackFunctionType |
Get app content stage sharing state callback function type |
| getLiveStreamStateCallbackFunctionType |
Get live stream state callback function type |
| liveStreamErrorCallbackFunctionType |
Live stream error callback function type |
| registerLiveStreamChangedHandlerFunctionType |
Register live stream changed handler function type |
| registerSpeakingStateChangeHandlerFunctionType |
Register speaking state change handler function type |
| backButtonHandlerFunctionType |
Back button handler function |
| fullScreenChangeFunctionType |
Full screen function |
| handlerFunctionType |
Callback function |
| removeEventType |
Remove event function |
| saveEventType |
Save event function |
| selectPeopleCallbackFunctionType |
Select people callback function type |
| Modality |
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. |
| PersonaIdentifiers |
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" |
| TriggerType |
The type of the profile trigger.
|
| SearchQueryHandler |
This type will store the SearchQuery and allow other logic to be made inside the handler. |
| getSettingsCallbackFunctionType |
Get settings callback function type |
| registerOnRemoveHandlerFunctionType |
Register on remove handler function type |
| registerOnSaveHandlerFunctionType |
Register on save handler function type |
| setSettingsOnCompleteFunctionType |
Set settings on complete function type |
| IShareRequestContentType |
IShareRequestContentType defines share request type. |
| shareWebContentCallbackFunctionType |
shareWebContent callback function type |
| startTaskSubmitHandlerFunctionType |
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 |
| readyToUnloadFunctionType |
Ready to unload function type |
| registerBeforeUnloadHandlerFunctionType |
Register before unload handler function type |
| registerOnLoadHandlerFunctionType |
Register on load handler function type |
| notifyErrorFunctionType |
Notify error function type |
| notifyVideoFrameProcessedFunctionType |
Notify video frame processed function type |
| RegisterForVideoFrameParameters |
Callbacks and configuration supplied to the host to process the video frames. |
| VideoBufferHandler |
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 |
| VideoEffectCallback |
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. |
| VideoFrameData |
Video frame data extracted from the media stream. More properties may be added in the future. |
| VideoFrameHandler |
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. |
| FrameContext | |
| LoadContext | |
| Rectangle |
Internal representation of a DOMRect suitable for sending via postMessage. |
| TaskInfo | |
| addEventListnerFunctionType |
addEventListner function type |
| callbackFunctionType |
Callback function type |
| executeDeepLinkOnCompleteFunctionType |
Execute deep link on complete function type |
| getContextCallbackFunctionType |
Get context callback function type |
| getTabInstancesCallbackFunctionType |
Get tab instances callback function type |
| onCompleteFunctionType |
onComplete function type |
| onCompleteHandlerFunctionType |
Navigation on complete handler function type |
| registerBackButtonHandlerFunctionType |
Register back button handler function type |
| registerFullScreenHandlerFunctionType |
Register full screen handler function type |
| registerOnThemeChangeHandlerFunctionType |
Register on theme change handler function type |
Enums
| ExpectedFailureReason |
Describes expected errors that occurred during an otherwise successful app initialization |
| FailedReason |
Describes errors that caused app initialization to fail |
| CallModalities |
Modalities that can be associated with a call. |
| ComposeMailType |
Defines compose mail types. |
| 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's side, URL is generic |
| MediaControllerEvent |
Events which are used to communicate between the app and the host client during the media recording flow |
| MediaType |
Specifies the type of Media |
| Source |
Specifies the image source |
| EventActionSource |
The source of the join button click. |
| SharingProtocol |
Represents the protocol option for sharing app content to the meeting stage. |
| DisplayMode |
Defines how a menu item should appear in the NavBar. |
| StageViewOpenMode |
The open mode for stage content. |
| ChannelType | |
| EffectChangeType |
Video effect change type enum |
| EffectFailureReason |
Predefined failure reasons for preparing the selected video effect |
| VideoFrameFormat |
Video frame format enum, currently only support NV12 |
| ActionObjectType |
Possible Action Types |
| ChannelType |
The type of the channel with which the content is associated. |
| ClipboardSupportedMimeType |
Currently supported Mime type |
| DialogDimension |
Dialog module dimension enum |
| ErrorCode |
Error codes used to identify different types of errors that can occur while developing apps. |
| FileOpenPreference |
Allowed user file open preferences |
| FrameContexts |
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 |
| HostClientType |
HostClientType represents the different client platforms on which host can be run. |
| HostName |
HostName indicates the possible hosts for your application. |
| SecondaryM365ContentIdName |
These correspond with field names in the MSGraph. See commonly accessed resources. |
| 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. |
Functions
Function Details
appInitializeHelper(string, string[])
function appInitializeHelper(apiVersionTag: string, validMessageOrigins?: string[]): Promise<void>Parameters
- apiVersionTag
-
string
- validMessageOrigins
-
string[]
Returns
Promise<void>
backStackNavigateBackHelper(string)
function backStackNavigateBackHelper(apiVersionTag: string): Promise<void>Parameters
- apiVersionTag
-
string
Returns
Promise<void>
botUrlOpenHelper(string, BotUrlDialogInfo, DialogSubmitHandler, PostMessageChannel)
function botUrlOpenHelper(apiVersionTag: string, urlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel)Parameters
- apiVersionTag
-
string
- urlDialogInfo
- BotUrlDialogInfo
- submitHandler
- DialogSubmitHandler
- messageFromChildHandler
- PostMessageChannel
configSetConfigHelper(string, InstanceConfig)
function configSetConfigHelper(apiVersionTag: string, instanceConfig: InstanceConfig): Promise<void>Parameters
- apiVersionTag
-
string
- instanceConfig
- InstanceConfig
Returns
Promise<void>
configSetValidityStateHelper(string, boolean)
function configSetValidityStateHelper(apiVersionTag: string, validityState: boolean)Parameters
- apiVersionTag
-
string
- validityState
-
boolean
enablePrintCapability()
Warning
This API is now deprecated.
As of 2.0.0, please use teamsCore.enablePrintCapability(): void instead.
Enable print capability to support printing page using Ctrl+P and cmd+P
function enablePrintCapability()
executeDeepLink(string, executeDeepLinkOnCompleteFunctionType)
Warning
This API is now deprecated.
As of 2.0.0, please use app.openLink(deepLink: string): Promise<void> instead.
Execute deep link API.
function executeDeepLink(deepLink: string, onComplete?: executeDeepLinkOnCompleteFunctionType)Parameters
- deepLink
-
string
deep link.
- onComplete
- executeDeepLinkOnCompleteFunctionType
getAdaptiveCardSchemaVersion()
function getAdaptiveCardSchemaVersion(): AdaptiveCardVersion | undefinedReturns
AdaptiveCardVersion | undefined
The AdaptiveCardVersion representing the Adaptive Card schema
version supported by the host, or undefined if the host does not support Adaptive Cards
getConfigHelper(string)
function getConfigHelper(apiVersionTag: string): Promise<pages.InstanceConfig>Parameters
- apiVersionTag
-
string
Returns
Promise<InstanceConfig>
getContext(getContextCallbackFunctionType)
Warning
This API is now deprecated.
As of 2.0.0, please use app.getContext(): Promise<app.Context> instead.
Retrieves the current context the frame is running in.
function getContext(callback: getContextCallbackFunctionType)Parameters
- callback
- getContextCallbackFunctionType
The callback to invoke when the Context object is retrieved.
getMruTabInstances(getTabInstancesCallbackFunctionType, TabInstanceParameters)
Warning
This API is now deprecated.
As of 2.0.0, please use pages.tabs.getMruTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise<TabInformation> instead.
Allows an app to retrieve the most recently used tabs for this user.
function getMruTabInstances(callback: getTabInstancesCallbackFunctionType, tabInstanceParameters?: TabInstanceParameters)Parameters
- callback
- getTabInstancesCallbackFunctionType
The callback to invoke when the TabInformation object is retrieved.
- tabInstanceParameters
- TabInstanceParameters
OPTIONAL Ignored, kept for future use
getMruTabInstancesHelper(string, TabInstanceParameters)
function getMruTabInstancesHelper(apiVersionTag: string, tabInstanceParameters?: TabInstanceParameters): Promise<TabInformation>Parameters
- apiVersionTag
-
string
- tabInstanceParameters
- TabInstanceParameters
Returns
Promise<TabInformation>
getTabInstances(getTabInstancesCallbackFunctionType, TabInstanceParameters)
Warning
This API is now deprecated.
As of 2.0.0, please use pages.tabs.getTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise<TabInformation> instead.
Allows an app to retrieve for this user tabs that are owned by this app. If no TabInstanceParameters are passed, the app defaults to favorite teams and favorite channels.
function getTabInstances(callback: getTabInstancesCallbackFunctionType, tabInstanceParameters?: TabInstanceParameters)Parameters
- callback
- getTabInstancesCallbackFunctionType
The callback to invoke when the TabInstanceParameters object is retrieved.
- tabInstanceParameters
- TabInstanceParameters
OPTIONAL Flags that specify whether to scope call to favorite teams or channels.
getTabInstancesHelper(string, TabInstanceParameters)
function getTabInstancesHelper(apiVersionTag: string, tabInstanceParameters?: TabInstanceParameters): Promise<TabInformation>Parameters
- apiVersionTag
-
string
- tabInstanceParameters
- TabInstanceParameters
Returns
Promise<TabInformation>
initialize(callbackFunctionType, string[])
Warning
This API is now deprecated.
As of 2.0.0, please use app.initialize(validMessageOrigins?: string[]): Promise<void> instead.
Initializes the library. This must be called before any other SDK calls but after the frame is loaded successfully.
function initialize(callback?: callbackFunctionType, validMessageOrigins?: string[])Parameters
- callback
- callbackFunctionType
Optionally specify a callback to invoke when Teams SDK has successfully initialized
- validMessageOrigins
-
string[]
Optionally specify a list of cross frame message origins. There must have https: protocol otherwise they will be ignored. Example: https://www.example.com
initializeWithFrameContext(FrameInfo, callbackFunctionType, string[])
Warning
This API is now deprecated.
As of 2.0.0, please use pages.initializeWithFrameContext(frameInfo: FrameInfo, callback?: callbackFunctionType, validMessageOrigins?: string[],): void instead.
Initialize with FrameContext
function initializeWithFrameContext(frameContext: FrameInfo, callback?: callbackFunctionType, validMessageOrigins?: string[])Parameters
- frameContext
- FrameInfo
FrameContext information to be set
- callback
- callbackFunctionType
The optional callback to be invoked be invoked after initilizing the frame context
- validMessageOrigins
-
string[]
Optionally specify a list of cross frame message origins. They must have https: protocol otherwise they will be ignored. Example: https:www.example.com
isSdkError(unknown)
function isSdkError(err: unknown): errParameters
- err
-
unknown
Returns
err
navigateBack(onCompleteHandlerFunctionType)
Warning
This API is now deprecated.
As of 2.0.0, please use pages.backStack.navigateBack(): Promise<void> instead.
Navigates back in the Teams client. See registerBackButtonHandler for more information on when it's appropriate to use this method.
function navigateBack(onComplete?: onCompleteHandlerFunctionType)Parameters
- onComplete
- onCompleteHandlerFunctionType
The callback to invoke when the action is complete.
navigateCrossDomain(string, onCompleteHandlerFunctionType)
Warning
This API is now deprecated.
As of 2.0.0, please use pages.navigateCrossDomain(url: string): Promise<void> instead.
Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the valid domains specified in the validDomains block of the manifest; otherwise, an exception will be thrown. This function needs to be used only when navigating the frame to a URL in a different domain than the current one in a way that keeps the app informed of the change and allows the SDK to continue working.
function navigateCrossDomain(url: string, onComplete?: onCompleteHandlerFunctionType)Parameters
- url
-
string
The URL to navigate the frame to.
- onComplete
- onCompleteHandlerFunctionType
The callback to invoke when the action is complete.
navigateCrossDomainHelper(string, string)
function navigateCrossDomainHelper(apiVersionTag: string, url: string): Promise<void>Parameters
- apiVersionTag
-
string
- url
-
string
Returns
Promise<void>
navigateToTab(TabInstance, onCompleteHandlerFunctionType)
Warning
This API is now deprecated.
As of 2.0.0, please use pages.tabs.navigateToTab(tabInstance: TabInstance): Promise<void> instead.
Navigates the Microsoft Teams app to the specified tab instance.
function navigateToTab(tabInstance: TabInstance, onComplete?: onCompleteHandlerFunctionType)Parameters
- tabInstance
- TabInstance
The tab instance to navigate to.
- onComplete
- onCompleteHandlerFunctionType
The callback to invoke when the action is complete.
notifyAppLoadedHelper(string)
function notifyAppLoadedHelper(apiVersionTag: string)Parameters
- apiVersionTag
-
string
notifyExpectedFailureHelper(string, IExpectedFailureRequest)
function notifyExpectedFailureHelper(apiVersionTag: string, expectedFailureRequest: IExpectedFailureRequest)Parameters
- apiVersionTag
-
string
- expectedFailureRequest
- IExpectedFailureRequest
notifyFailureHelper(string, IFailedRequest)
function notifyFailureHelper(apiVersiontag: string, appInitializationFailedRequest: IFailedRequest)Parameters
- apiVersiontag
-
string
- appInitializationFailedRequest
- IFailedRequest
notifySuccessHelper(string)
function notifySuccessHelper(apiVersionTag: string)Parameters
- apiVersionTag
-
string
openLinkHelper(string, string)
function openLinkHelper(apiVersionTag: string, deepLink: string): Promise<void>Parameters
- apiVersionTag
-
string
- deepLink
-
string
Returns
Promise<void>
print()
Warning
This API is now deprecated.
As of 2.0.0, please use teamsCore.print(): void instead.
Default print handler
function print()
registerAppButtonClickHandler(callbackFunctionType)
Warning
This API is now deprecated.
As of 2.0.0, please use pages.appButton.onClick(handler: callbackFunctionType): void instead.
Registers a handler for clicking the app button. Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
function registerAppButtonClickHandler(handler: callbackFunctionType)Parameters
- handler
- callbackFunctionType
The handler to invoke when the personal app button is clicked in the app bar.
registerAppButtonHoverEnterHandler(callbackFunctionType)
Warning
This API is now deprecated.
As of 2.0.0, please use pages.appButton.onHoverEnter(handler: callbackFunctionType): void instead.
Registers a handler for entering hover of the app button. Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
function registerAppButtonHoverEnterHandler(handler: callbackFunctionType)Parameters
- handler
- callbackFunctionType
The handler to invoke when entering hover of the personal app button in the app bar.
registerAppButtonHoverLeaveHandler(callbackFunctionType)
Warning
This API is now deprecated.
As of 2.0.0, please use pages.appButton.onHoverLeave(handler: callbackFunctionType): void instead.
Registers a handler for exiting hover of the app button. Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
function registerAppButtonHoverLeaveHandler(handler: callbackFunctionType)Parameters
- handler
- callbackFunctionType
The handler to invoke when exiting hover of the personal app button in the app bar.
registerBackButtonHandler(registerBackButtonHandlerFunctionType)
Warning
This API is now deprecated.
As of 2.0.0, please use pages.backStack.registerBackButtonHandler(handler: registerBackButtonHandlerFunctionType): void instead.
Registers a handler for user presses of the Team client's back button. Experiences that maintain an internal navigation stack should use this handler to navigate the user back within their frame. If an app finds that after running its back button handler it cannot handle the event it should call the navigateBack method to ask the Teams client to handle it instead.
function registerBackButtonHandler(handler: registerBackButtonHandlerFunctionType)Parameters
The handler to invoke when the user presses their Team client's back button.
registerChangeSettingsHandler(callbackFunctionType)
Warning
This API is now deprecated.
As of 2.0.0, please use pages.config.registerChangeConfigHandler(handler: callbackFunctionType): void instead.
Registers a handler for when the user reconfigurated tab.
function registerChangeSettingsHandler(handler: callbackFunctionType)Parameters
- handler
- callbackFunctionType
The handler to invoke when the user click on Settings.
registerFullScreenHandler(registerFullScreenHandlerFunctionType)
Warning
This API is now deprecated.
As of 2.0.0, please use pages.registerFullScreenHandler(handler: registerFullScreenHandlerFunctionType): void instead.
Registers a handler for changes from or to full-screen view for a tab. Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
function registerFullScreenHandler(handler: registerFullScreenHandlerFunctionType)Parameters
The handler to invoke when the user toggles full-screen view for a tab.
registerOnThemeChangeHandler(registerOnThemeChangeHandlerFunctionType)
Warning
This API is now deprecated.
As of 2.0.0, please use app.registerOnThemeChangeHandler(handler: registerOnThemeChangeHandlerFunctionType): void instead.
Registers a handler for theme changes. Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
function registerOnThemeChangeHandler(handler: registerOnThemeChangeHandlerFunctionType)Parameters
The handler to invoke when the user changes their theme.
registerOnThemeChangeHandlerHelper(string, themeHandler)
function registerOnThemeChangeHandlerHelper(apiVersionTag: string, handler: themeHandler)Parameters
- apiVersionTag
-
string
- handler
- themeHandler
returnFocus(boolean)
Warning
This API is now deprecated.
As of 2.0.0, please use pages.returnFocus(navigateForward?: boolean): void instead.
Return focus to the main Teams app. Will focus search bar if navigating foward and app bar if navigating back.
function returnFocus(navigateForward?: boolean)Parameters
- navigateForward
-
boolean
Determines the direction to focus in teams app.
returnFocusHelper(string, boolean)
function returnFocusHelper(apiVersionTag: string, navigateForward?: boolean)Parameters
- apiVersionTag
-
string
- navigateForward
-
boolean
setCurrentFrameHelper(string, FrameInfo)
function setCurrentFrameHelper(apiVersionTag: string, frameInfo: FrameInfo)Parameters
- apiVersionTag
-
string
- frameInfo
- FrameInfo
setFrameContext(FrameInfo)
Warning
This API is now deprecated.
As of 2.0.0, please use pages.setCurrentFrame(frameInfo: FrameInfo): void instead.
Set the current Frame Context
function setFrameContext(frameContext: FrameInfo)Parameters
- frameContext
- FrameInfo
FrameContext information to be set
shareDeepLink(DeepLinkParameters)
Warning
This API is now deprecated.
As of 2.0.0, please use pages.shareDeepLink(deepLinkParameters: DeepLinkParameters): void instead.
Shares a deep link that a user can use to navigate back to a specific state in this page.
function shareDeepLink(deepLinkParameters: DeepLinkParameters)Parameters
- deepLinkParameters
- DeepLinkParameters
ID and label for the link and fallback URL.
shareDeepLinkHelper(string, ShareDeepLinkParameters)
function shareDeepLinkHelper(apiVersionTag: string, deepLinkParameters: ShareDeepLinkParameters)Parameters
- apiVersionTag
-
string
- deepLinkParameters
- ShareDeepLinkParameters
tabsNavigateToTabHelper(string, TabInstance)
function tabsNavigateToTabHelper(apiVersionTag: string, tabInstance: TabInstance): Promise<void>Parameters
- apiVersionTag
-
string
- tabInstance
- TabInstance
Returns
Promise<void>
updateResizeHelper(string, DialogSize)
function updateResizeHelper(apiVersionTag: string, dimensions: DialogSize)Parameters
- apiVersionTag
-
string
- dimensions
- DialogSize
uploadCustomApp(Blob, (status: boolean, reason?: string) => void)
function uploadCustomApp(manifestBlob: Blob, onComplete?: (status: boolean, reason?: string) => void)Parameters
- manifestBlob
-
Blob
- onComplete
-
(status: boolean, reason?: string) => void
urlOpenHelper(string, UrlDialogInfo, DialogSubmitHandler, PostMessageChannel)
function urlOpenHelper(apiVersionTag: string, urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel)Parameters
- apiVersionTag
-
string
- urlDialogInfo
- UrlDialogInfo
- submitHandler
- DialogSubmitHandler
- messageFromChildHandler
- PostMessageChannel
urlSubmitHelper(string, string | object, string | string[])
function urlSubmitHelper(apiVersionTag: string, result?: string | object, appIds?: string | string[])Parameters
- apiVersionTag
-
string
- result
-
string | object
- appIds
-
string | string[]
Comentarios
Próximamente: a lo largo de 2024, eliminaremos gradualmente los problemas de GitHub como mecanismo de comentarios para el contenido y lo reemplazaremos por un nuevo sistema de comentarios. Para obtener más información, consulte: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de