appInitialization module

Package:

@microsoft/teams-js

Functions

notifyAppLoaded()
notifyExpectedFailure(IExpectedFailureRequest)
notifyFailure(IFailedRequest)
notifySuccess()

Function Details

notifyAppLoaded()

Warning

This API is now deprecated.

As of 2.0.0, please use app.notifyAppLoaded(): void instead.

Notifies the frame that app has loaded and to hide the loading indicator if one is shown.

function notifyAppLoaded()

notifyExpectedFailure(IExpectedFailureRequest)

Warning

This API is now deprecated.

As of 2.0.0, please use app.notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void instead.

Notifies the frame that app initialized with some expected errors.

function notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest)

Parameters

expectedFailureRequest

IExpectedFailureRequest

The expected failure request containing the reason and an optional message

notifyFailure(IFailedRequest)

Warning

This API is now deprecated.

As of 2.0.0, please use app.notifyFailure(appInitializationFailedRequest: IFailedRequest): void instead.

Notifies the frame that app initialization has failed and to show an error page in its place.

function notifyFailure(appInitializationFailedRequest: IFailedRequest)

Parameters

appInitializationFailedRequest

IFailedRequest

The failure request containing the reason for why the app failed during initialization as well as an optional message.

notifySuccess()

Warning

This API is now deprecated.

As of 2.0.0, please use app.notifySuccess(): void instead.

Notifies the frame that app initialization is successful and is ready for user interaction.

function notifySuccess()