-
Notifications
You must be signed in to change notification settings - Fork 6
/
IAppWindow.yml
44 lines (44 loc) · 1.49 KB
/
IAppWindow.yml
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
43
44
### YamlMime:TSType
name: IAppWindow
uid: '@microsoft/teams-js.IAppWindow'
package: '@microsoft/teams-js'
summary: Represents a window or frame within the host app.
fullName: IAppWindow
remarks: ''
isDeprecated: false
type: interface
methods:
- name: addEventListener(string, Function)
uid: '@microsoft/teams-js.IAppWindow.addEventListener'
package: '@microsoft/teams-js'
summary: >-
Add a listener that will be called when an event is received from this
AppWindow.
remarks: ''
isDeprecated: false
syntax:
content: 'function addEventListener(type: string, listener: Function)'
parameters:
- id: type
type: string
description: >-
The event to listen to. Currently the only supported type is
'message'.
- id: listener
type: Function
description: The listener that will be called
- name: postMessage(any, onCompleteFunctionType)
uid: '@microsoft/teams-js.IAppWindow.postMessage'
package: '@microsoft/teams-js'
summary: Send a message to the AppWindow.
remarks: ''
isDeprecated: false
syntax:
content: 'function postMessage(message: any, onComplete?: onCompleteFunctionType)'
parameters:
- id: message
type: any
description: The message to send
- id: onComplete
type: <xref uid="@microsoft/teams-js.onCompleteFunctionType" />
description: The callback to know if the postMessage has been success/failed.