@microsoft/teams-js
Version:
Microsoft Client SDK for building app for Microsoft hosts
47 lines (46 loc) • 2.2 kB
TypeScript
/**
* Navigation specific part of the SDK.
* @module
*/
import { TabInstance } from './interfaces';
/** Navigation on complete handler function type */
export type onCompleteHandlerFunctionType = (status: boolean, reason?: string) => void;
/**
* @deprecated
* As of TeamsJS v2.0.0, please use {@link pages.returnFocus 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.
*
* @param navigateForward - Determines the direction to focus in teams app.
*/
export declare function returnFocus(navigateForward?: boolean): void;
/**
* @deprecated
* As of TeamsJS v2.0.0, please use {@link pages.tabs.navigateToTab pages.tabs.navigateToTab(tabInstance: TabInstance): Promise\<void\>} instead.
*
* Navigates the Microsoft Teams app to the specified tab instance.
*
* @param tabInstance - The tab instance to navigate to.
* @param onComplete - The callback to invoke when the action is complete.
*/
export declare function navigateToTab(tabInstance: TabInstance, onComplete?: onCompleteHandlerFunctionType): void;
/**
* @deprecated
* As of 2.0.0, this API is deprecated and can be replaced by the standard JavaScript
* API, window.location.href, when navigating the app to a new cross-domain URL. Any URL
* that is redirected to must be listed in the validDomains block of the manifest. Please
* remove any calls to this API.
* @param url - The URL to navigate the frame to.
* @param onComplete - The callback to invoke when the action is complete.
*/
export declare function navigateCrossDomain(url: string, onComplete?: onCompleteHandlerFunctionType): void;
/**
* @deprecated
* As of TeamsJS v2.0.0, please use {@link pages.backStack.navigateBack 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.
*
* @param onComplete - The callback to invoke when the action is complete.
*/
export declare function navigateBack(onComplete?: onCompleteHandlerFunctionType): void;