UNPKG

@microsoft/teams-js

Version:

Microsoft Client SDK for building app for Microsoft hosts

github.com/OfficeDev/microsoft-teams-library-js

OfficeDev/microsoft-teams-library-js

42 lines (41 loc) • 1.62 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/** * Subcapability that allows communication between the dialog and the parent app. * * @remarks * Note that dialog can be invoked from parentless scenarios e.g. Search Message Extensions. The subcapability `parentCommunication` is not supported in such scenarios. * * @module */ import { PostMessageChannel } from '../dialog'; /** * Send message to the parent from dialog * * @remarks * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect. * * @param message - The message to send to the parent */ export declare function sendMessageToParentFromDialog(message: any): void; /** * Send message to the dialog from the parent * * @param message - The message to send */ export declare function sendMessageToDialog(message: any): void; /** * Register a listener that will be triggered when a message is received from the app that opened the dialog. * * @remarks * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect. * * @param listener - The listener that will be triggered. */ export declare function registerOnMessageFromParent(listener: PostMessageChannel): void; /** * Checks if dialog.url.parentCommunication capability is supported by the host * * @returns boolean to represent whether dialog.url.parentCommunication capability is supported * * @throws Error if {@linkcode app.initialize} has not successfully completed */ export declare function isSupported(): boolean;