-
Notifications
You must be signed in to change notification settings - Fork 6
/
teamsCore.yml
87 lines (84 loc) · 3.16 KB
/
teamsCore.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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
### YamlMime:TSPackage
uid: '@microsoft/teams-js.teamsCore'
name: teamsCore
summary: ''
type: module
typeAliases:
- '@microsoft/teams-js.teamsCore.readyToUnloadFunctionType'
- '@microsoft/teams-js.teamsCore.registerBeforeUnloadHandlerFunctionType'
- '@microsoft/teams-js.teamsCore.registerOnLoadHandlerFunctionType'
package: '@microsoft/teams-js'
functions:
- name: enablePrintCapability()
uid: '@microsoft/teams-js.teamsCore.enablePrintCapability'
package: '@microsoft/teams-js'
summary: Enable print capability to support printing page using Ctrl+P and cmd+P
remarks: ''
isDeprecated: false
syntax:
content: function enablePrintCapability()
- name: isSupported()
uid: '@microsoft/teams-js.teamsCore.isSupported'
package: '@microsoft/teams-js'
summary: Checks if teamsCore capability is supported by the host
remarks: ''
isDeprecated: false
syntax:
content: 'function isSupported(): boolean'
return:
description: boolean to represent whether the teamsCore capability is supported
type: boolean
- name: print()
uid: '@microsoft/teams-js.teamsCore.print'
package: '@microsoft/teams-js'
summary: default print handler
remarks: ''
isDeprecated: false
syntax:
content: function print()
- name: registerBeforeUnloadHandler(registerBeforeUnloadHandlerFunctionType)
uid: '@microsoft/teams-js.teamsCore.registerBeforeUnloadHandler'
package: '@microsoft/teams-js'
summary: Registers a handler to be called before the page is unloaded.
remarks: >-
Check out [App Caching in
Teams](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/app-caching)
for a more detailed explanation about using this API.
previewState: beta
isDeprecated: false
syntax:
content: >-
function registerBeforeUnloadHandler(handler:
registerBeforeUnloadHandlerFunctionType)
parameters:
- id: handler
type: >-
<xref
uid="@microsoft/teams-js.teamsCore.registerBeforeUnloadHandlerFunctionType"
/>
description: >-
The handler to invoke before the page is unloaded. If this handler
returns true the page should
invoke the readyToUnload function provided to it once it's ready to
be unloaded.
- name: registerOnLoadHandler(registerOnLoadHandlerFunctionType)
uid: '@microsoft/teams-js.teamsCore.registerOnLoadHandler'
package: '@microsoft/teams-js'
summary: Registers a handler to be called when the page has been requested to load.
remarks: >-
Check out [App Caching in
Teams](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/app-caching)
for a more detailed explanation about using this API.
previewState: beta
isDeprecated: false
syntax:
content: >-
function registerOnLoadHandler(handler:
registerOnLoadHandlerFunctionType)
parameters:
- id: handler
type: >-
<xref
uid="@microsoft/teams-js.teamsCore.registerOnLoadHandlerFunctionType"
/>
description: The handler to invoke when the page is loaded.