@microsoft/teams-js
Version:
Microsoft Client SDK for building app for Microsoft hosts
60 lines (59 loc) • 2.4 kB
TypeScript
import { FilePreviewParameters, UserSettingTypes } from './interfaces';
export declare function uploadCustomApp(manifestBlob: Blob, onComplete?: (status: boolean, reason?: string) => void): void;
/**
* @hidden
* Sends a custom action MessageRequest to host or parent window
*
* @param actionName - Specifies name of the custom action to be sent
* @param args - Specifies additional arguments passed to the action
* @param callback - Optionally specify a callback to receive response parameters from the parent
* @returns id of sent message
*
* @internal
* Limited to Microsoft-internal use
*/
export declare function sendCustomMessage(actionName: string, args?: any[], callback?: (...args: any[]) => void): void;
/**
* @hidden
* Sends a custom action MessageEvent to a child iframe/window.
*
* @param actionName - Specifies name of the custom action to be sent
* @param args - Specifies additional arguments passed to the action
* @returns id of sent message
*
* @internal
* Limited to Microsoft-internal use
*/
export declare function sendCustomEvent(actionName: string, args?: any[]): void;
/**
* @hidden
* Adds a handler for an action sent by a child window or parent window
*
* @param actionName - Specifies name of the action message to handle
* @param customHandler - The callback to invoke when the action message is received. The return value is sent to the child
*
* @internal
* Limited to Microsoft-internal use
*/
export declare function registerCustomHandler(actionName: string, customHandler: (...args: any[]) => any[]): void;
/**
* @hidden
* register a handler to be called when a user setting changes. The changed setting type & value is provided in the callback.
*
* @param settingTypes - List of user setting changes to subscribe
* @param handler - When a subscribed setting is updated this handler is called
*
* @internal
* Limited to Microsoft-internal use
*/
export declare function registerUserSettingsChangeHandler(settingTypes: UserSettingTypes[], handler: (settingType: UserSettingTypes, value: any) => void): void;
/**
* @hidden
* Opens a client-friendly preview of the specified file.
*
* @param file - The file to preview.
*
* @internal
* Limited to Microsoft-internal use
*/
export declare function openFilePreview(filePreviewParameters: FilePreviewParameters): void;