@types/office-runtime 1.0.29 → 1.0.31
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-runtime/README.md +1 -1
- office-runtime/index.d.ts +78 -18
- office-runtime/package.json +3 -3
office-runtime/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for office-runtime (https://github.com/Of
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-runtime.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Tue, 30 May 2023 21:32:44 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
* Global values: `OfficeRuntime`
|
|
14
14
|
|
office-runtime/index.d.ts
CHANGED
|
@@ -37,8 +37,15 @@ declare namespace OfficeRuntime {
|
|
|
37
37
|
* @remarks
|
|
38
38
|
* [Api set: SharedRuntime 1.1, Mailbox 1.10]
|
|
39
39
|
*
|
|
40
|
-
*
|
|
41
|
-
* {@link https://learn.microsoft.com/
|
|
40
|
+
* This interface is available in the
|
|
41
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1 requirement set}
|
|
42
|
+
* for Excel, PowerPoint, and Word add-ins. It's also available starting in
|
|
43
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/outlook-requirement-set-1.10 | Mailbox requirement set 1.10}
|
|
44
|
+
* for Outlook.
|
|
45
|
+
*
|
|
46
|
+
* **Important**: In Outlook, support is only available with the
|
|
47
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation} feature implemented in Outlook on Windows.
|
|
48
|
+
* This interface isn't supported in Outlook on Mac or on the web.
|
|
42
49
|
*
|
|
43
50
|
* Storage limit is 10 MB per domain, which may be shared by multiple add-ins.
|
|
44
51
|
*/
|
|
@@ -50,8 +57,15 @@ declare namespace OfficeRuntime {
|
|
|
50
57
|
* @remarks
|
|
51
58
|
* [Api set: SharedRuntime 1.1, Mailbox 1.10]
|
|
52
59
|
*
|
|
53
|
-
*
|
|
54
|
-
* {@link https://learn.microsoft.com/
|
|
60
|
+
* This method is available in the
|
|
61
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1 requirement set}
|
|
62
|
+
* for Excel, PowerPoint, and Word add-ins. It's also available starting in
|
|
63
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/outlook-requirement-set-1.10 | Mailbox requirement set 1.10}
|
|
64
|
+
* for Outlook.
|
|
65
|
+
*
|
|
66
|
+
* **Important**: In Outlook, support is only available with the
|
|
67
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation} feature implemented in Outlook on Windows.
|
|
68
|
+
* This method isn't supported in Outlook on Mac or on the web.
|
|
55
69
|
*
|
|
56
70
|
* @param key Key of item to be retrieved. Must be a string.
|
|
57
71
|
*/
|
|
@@ -63,8 +77,15 @@ declare namespace OfficeRuntime {
|
|
|
63
77
|
* @remarks
|
|
64
78
|
* [Api set: SharedRuntime 1.1, Mailbox 1.10]
|
|
65
79
|
*
|
|
66
|
-
*
|
|
67
|
-
* {@link https://learn.microsoft.com/
|
|
80
|
+
* This method is available in the
|
|
81
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1 requirement set}
|
|
82
|
+
* for Excel, PowerPoint, and Word add-ins. It's also available starting in
|
|
83
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/outlook-requirement-set-1.10 | Mailbox requirement set 1.10}
|
|
84
|
+
* for Outlook.
|
|
85
|
+
*
|
|
86
|
+
* **Important**: In Outlook, support is only available with the
|
|
87
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation} feature implemented in Outlook on Windows.
|
|
88
|
+
* This method isn't supported in Outlook on Mac or on the web.
|
|
68
89
|
*
|
|
69
90
|
* @param key Key of item to be set. Must be a string.
|
|
70
91
|
* @param value Must be a string.
|
|
@@ -77,8 +98,15 @@ declare namespace OfficeRuntime {
|
|
|
77
98
|
* @remarks
|
|
78
99
|
* [Api set: SharedRuntime 1.1, Mailbox 1.10]
|
|
79
100
|
*
|
|
80
|
-
*
|
|
81
|
-
* {@link https://learn.microsoft.com/
|
|
101
|
+
* This method is available in the
|
|
102
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1 requirement set}
|
|
103
|
+
* for Excel, PowerPoint, and Word add-ins. It's also available starting in
|
|
104
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/outlook-requirement-set-1.10 | Mailbox requirement set 1.10}
|
|
105
|
+
* for Outlook.
|
|
106
|
+
*
|
|
107
|
+
* **Important**: In Outlook, support is only available with the
|
|
108
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation} feature implemented in Outlook on Windows.
|
|
109
|
+
* This method isn't supported in Outlook on Mac or on the web.
|
|
82
110
|
*
|
|
83
111
|
* @param key Key of item to be removed. Must be a string.
|
|
84
112
|
*/
|
|
@@ -90,8 +118,15 @@ declare namespace OfficeRuntime {
|
|
|
90
118
|
* @remarks
|
|
91
119
|
* [Api set: SharedRuntime 1.1, Mailbox 1.10]
|
|
92
120
|
*
|
|
93
|
-
*
|
|
94
|
-
* {@link https://learn.microsoft.com/
|
|
121
|
+
* This method is available in the
|
|
122
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1 requirement set}
|
|
123
|
+
* for Excel, PowerPoint, and Word add-ins. It's also available starting in
|
|
124
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/outlook-requirement-set-1.10 | Mailbox requirement set 1.10}
|
|
125
|
+
* for Outlook.
|
|
126
|
+
*
|
|
127
|
+
* **Important**: In Outlook, support is only available with the
|
|
128
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation} feature implemented in Outlook on Windows.
|
|
129
|
+
* This method isn't supported in Outlook on Mac or on the web.
|
|
95
130
|
*
|
|
96
131
|
* @param keys Keys of items to be removed. Must be an array of strings.
|
|
97
132
|
*/
|
|
@@ -103,8 +138,15 @@ declare namespace OfficeRuntime {
|
|
|
103
138
|
* @remarks
|
|
104
139
|
* [Api set: SharedRuntime 1.1, Mailbox 1.10]
|
|
105
140
|
*
|
|
106
|
-
*
|
|
107
|
-
* {@link https://learn.microsoft.com/
|
|
141
|
+
* This method is available in the
|
|
142
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1 requirement set}
|
|
143
|
+
* for Excel, PowerPoint, and Word add-ins. It's also available starting in
|
|
144
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/outlook-requirement-set-1.10 | Mailbox requirement set 1.10}
|
|
145
|
+
* for Outlook.
|
|
146
|
+
*
|
|
147
|
+
* **Important**: In Outlook, support is only available with the
|
|
148
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation} feature implemented in Outlook on Windows.
|
|
149
|
+
* This method isn't supported in Outlook on Mac or on the web.
|
|
108
150
|
*
|
|
109
151
|
* @param keyValues Key-value pairs to be set. Must be strings.
|
|
110
152
|
*/
|
|
@@ -116,8 +158,15 @@ declare namespace OfficeRuntime {
|
|
|
116
158
|
* @remarks
|
|
117
159
|
* [Api set: SharedRuntime 1.1, Mailbox 1.10]
|
|
118
160
|
*
|
|
119
|
-
*
|
|
120
|
-
* {@link https://learn.microsoft.com/
|
|
161
|
+
* This method is available in the
|
|
162
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1 requirement set}
|
|
163
|
+
* for Excel, PowerPoint, and Word add-ins. It's also available starting in
|
|
164
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/outlook-requirement-set-1.10 | Mailbox requirement set 1.10}
|
|
165
|
+
* for Outlook.
|
|
166
|
+
*
|
|
167
|
+
* **Important**: In Outlook, support is only available with the
|
|
168
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation} feature implemented in Outlook on Windows.
|
|
169
|
+
* This method isn't supported in Outlook on Mac or on the web.
|
|
121
170
|
*
|
|
122
171
|
* @param keys Keys of items to be removed. Must be an array of strings.
|
|
123
172
|
*/
|
|
@@ -129,8 +178,15 @@ declare namespace OfficeRuntime {
|
|
|
129
178
|
* @remarks
|
|
130
179
|
* [Api set: SharedRuntime 1.1, Mailbox 1.10]
|
|
131
180
|
*
|
|
132
|
-
*
|
|
133
|
-
* {@link https://learn.microsoft.com/
|
|
181
|
+
* This method is available in the
|
|
182
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1 requirement set}
|
|
183
|
+
* for Excel, PowerPoint, and Word add-ins. It's also available starting in
|
|
184
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/outlook-requirement-set-1.10 | Mailbox requirement set 1.10}
|
|
185
|
+
* for Outlook.
|
|
186
|
+
*
|
|
187
|
+
* **Important**: In Outlook, support is only available with the
|
|
188
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation} feature implemented in Outlook on Windows.
|
|
189
|
+
* This method isn't supported in Outlook on Mac or on the web.
|
|
134
190
|
*/
|
|
135
191
|
getKeys(): Promise<string[]>;
|
|
136
192
|
}
|
|
@@ -293,12 +349,16 @@ declare namespace OfficeRuntime {
|
|
|
293
349
|
* This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign-in with Organizational
|
|
294
350
|
* Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
|
|
295
351
|
*
|
|
296
|
-
* **Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
|
|
297
|
-
*
|
|
298
352
|
* @remarks
|
|
299
353
|
*
|
|
300
354
|
* **Applications**: Excel, Outlook, PowerPoint, Word
|
|
301
355
|
*
|
|
356
|
+
* **Important**: In Outlook, this API isn't supported in the following scenarios.
|
|
357
|
+
*
|
|
358
|
+
* - If the add-in is loaded in an Outlook.com or Gmail mailbox.
|
|
359
|
+
*
|
|
360
|
+
* - If the add-in is loaded in Outlook on the web in the Safari browser. This results in error 13001 ("The user is not signed into Office").
|
|
361
|
+
*
|
|
302
362
|
* @param options - Optional. Accepts an `AuthOptions` object to define sign-on behaviors.
|
|
303
363
|
* @returns Promise to the access token.
|
|
304
364
|
*/
|
office-runtime/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-runtime",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.31",
|
|
4
4
|
"description": "TypeScript definitions for office-runtime",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-runtime",
|
|
6
6
|
"license": "MIT",
|
|
@@ -40,6 +40,6 @@
|
|
|
40
40
|
},
|
|
41
41
|
"scripts": {},
|
|
42
42
|
"dependencies": {},
|
|
43
|
-
"typesPublisherContentHash": "
|
|
44
|
-
"typeScriptVersion": "4.
|
|
43
|
+
"typesPublisherContentHash": "74111abb4ee5fcc6fdb1cd885a814a3a4a2974b19f0bcbe159238edad57a2691",
|
|
44
|
+
"typeScriptVersion": "4.3"
|
|
45
45
|
}
|