@types/office-runtime 1.0.26 → 1.0.28

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 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: Thu, 08 Sep 2022 20:32:46 GMT
11
+ * Last updated: Tue, 20 Sep 2022 23:03:16 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `OfficeRuntime`
14
14
 
office-runtime/index.d.ts CHANGED
@@ -38,7 +38,7 @@ declare namespace OfficeRuntime {
38
38
  * [Api set: SharedRuntime 1.1, Mailbox 1.10]
39
39
  *
40
40
  * **Important**: In Outlook, support is only available with
41
- * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
41
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
42
42
  *
43
43
  * Storage limit is 10 MB per domain, which may be shared by multiple add-ins.
44
44
  */
@@ -51,7 +51,7 @@ declare namespace OfficeRuntime {
51
51
  * [Api set: SharedRuntime 1.1, Mailbox 1.10]
52
52
  *
53
53
  * **Important**: In Outlook, support is only available with
54
- * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
54
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
55
55
  *
56
56
  * @param key Key of item to be retrieved. Must be a string.
57
57
  */
@@ -64,7 +64,7 @@ declare namespace OfficeRuntime {
64
64
  * [Api set: SharedRuntime 1.1, Mailbox 1.10]
65
65
  *
66
66
  * **Important**: In Outlook, support is only available with
67
- * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
67
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
68
68
  *
69
69
  * @param key Key of item to be set. Must be a string.
70
70
  * @param value Must be a string.
@@ -78,7 +78,7 @@ declare namespace OfficeRuntime {
78
78
  * [Api set: SharedRuntime 1.1, Mailbox 1.10]
79
79
  *
80
80
  * **Important**: In Outlook, support is only available with
81
- * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
81
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
82
82
  *
83
83
  * @param key Key of item to be removed. Must be a string.
84
84
  */
@@ -91,7 +91,7 @@ declare namespace OfficeRuntime {
91
91
  * [Api set: SharedRuntime 1.1, Mailbox 1.10]
92
92
  *
93
93
  * **Important**: In Outlook, support is only available with
94
- * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
94
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
95
95
  *
96
96
  * @param keys Keys of items to be removed. Must be an array of strings.
97
97
  */
@@ -104,7 +104,7 @@ declare namespace OfficeRuntime {
104
104
  * [Api set: SharedRuntime 1.1, Mailbox 1.10]
105
105
  *
106
106
  * **Important**: In Outlook, support is only available with
107
- * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
107
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
108
108
  *
109
109
  * @param keyValues Key-value pairs to be set. Must be strings.
110
110
  */
@@ -117,7 +117,7 @@ declare namespace OfficeRuntime {
117
117
  * [Api set: SharedRuntime 1.1, Mailbox 1.10]
118
118
  *
119
119
  * **Important**: In Outlook, support is only available with
120
- * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
120
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
121
121
  *
122
122
  * @param keys Keys of items to be removed. Must be an array of strings.
123
123
  */
@@ -130,7 +130,7 @@ declare namespace OfficeRuntime {
130
130
  * [Api set: SharedRuntime 1.1, Mailbox 1.10]
131
131
  *
132
132
  * **Important**: In Outlook, support is only available with
133
- * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
133
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
134
134
  */
135
135
  getKeys(): Promise<string[]>;
136
136
  }
@@ -265,8 +265,14 @@ declare namespace OfficeRuntime {
265
265
  asyncContext?: any;
266
266
  /**
267
267
  * Causes Office to return a descriptive error when the add-in wants to access Microsoft Graph and the user/admin has not granted consent to Graph scopes. Default value is `false`.
268
- * Office only supports consent to Graph scopes when the add-in has been deployed by a tenant admin. This information will not be available during development.
268
+ * Office only supports consent to Graph scopes when the add-in has been deployed by a tenant admin.
269
269
  * Setting this option to `true` will cause Office to inform your add-in beforehand (by returning a descriptive error) if Graph access will fail.
270
+ *
271
+ * @remarks
272
+ *
273
+ * **Note**: If you're developing an Outlook add-in that uses single sign-on (SSO), comment out the `forMSGraphAccess` option before sideloading the add-in for testing.
274
+ * Otherwise, you'll receive {@link https://learn.microsoft.com/office/dev/add-ins/develop/troubleshoot-sso-in-office-add-ins#13012 | error 13012}. For additional guidance, see
275
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/authorize-to-microsoft-graph#details-on-sso-with-an-outlook-add-in | Details on SSO with an Outlook add-in}.
270
276
  */
271
277
  forMSGraphAccess?: boolean;
272
278
  }
@@ -275,7 +281,7 @@ declare namespace OfficeRuntime {
275
281
  *
276
282
  * @remarks
277
283
  *
278
- * The methods in this interface are equivalent to those in the {@link https://docs.microsoft.com/javascript/api/office/office.auth | Office.auth interface}.
284
+ * The methods in this interface are equivalent to those in the {@link https://learn.microsoft.com/javascript/api/office/office.auth | Office.auth interface}.
279
285
  * If new authentication types are added in the future, they will only be added to the `Office.auth` interface.
280
286
  * For simplicity, the code examples throughout the documentation use `Office.auth`.
281
287
  */
@@ -283,7 +289,7 @@ declare namespace OfficeRuntime {
283
289
  /**
284
290
  * Calls the Azure Active Directory V 2.0 endpoint to get an access token to your add-in's web application. Enables add-ins to identify users.
285
291
  * Server-side code can use this token to access Microsoft Graph for the add-in's web application by using the
286
- * {@link https://docs.microsoft.com/azure/active-directory/develop/active-directory-v2-protocols-oauth-on-behalf-of | "on behalf of" OAuth flow}.
292
+ * {@link https://learn.microsoft.com/azure/active-directory/develop/active-directory-v2-protocols-oauth-on-behalf-of | "on behalf of" OAuth flow}.
287
293
  * This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign-in with Organizational
288
294
  * Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
289
295
  *
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-runtime",
3
- "version": "1.0.26",
3
+ "version": "1.0.28",
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": "792f2ed71875e61e1d93e9a38f216e7d0cdd30c8a3f550d5afb7bf97573802dd",
43
+ "typesPublisherContentHash": "36b3aed1e9a5d85ef1f13cac06e1a41e8f8e84b91421b70b426aac53ada47c39",
44
44
  "typeScriptVersion": "4.1"
45
45
  }