@types/office-js 1.0.384 → 1.0.385
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-js/README.md +1 -1
- office-js/index.d.ts +339 -318
- office-js/package.json +2 -2
office-js/index.d.ts
CHANGED
|
@@ -226,20 +226,7 @@ declare namespace Office {
|
|
|
226
226
|
*
|
|
227
227
|
* @remarks
|
|
228
228
|
*
|
|
229
|
-
* **
|
|
230
|
-
*
|
|
231
|
-
* For more information about Office application and server requirements, see
|
|
232
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
|
|
233
|
-
*
|
|
234
|
-
* *Supported applications, by platform*
|
|
235
|
-
* <table>
|
|
236
|
-
* <tr><th> </th><th> Office on Windows </th><th> Office in web browser </th><th> Office on iPad </th><th> Outlook on mobile devices </th><th> Office on Mac </th></tr>
|
|
237
|
-
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
238
|
-
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td><td> Supported </td></tr>
|
|
239
|
-
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
240
|
-
* <tr><td><strong> Project </strong></td><td> Supported </td><td> </td><td> </td><td> </td><td> Supported </td></tr>
|
|
241
|
-
* <tr><td><strong> Word </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
242
|
-
* </table>
|
|
229
|
+
* **Applications**: Excel, Outlook, PowerPoint, Project, Word
|
|
243
230
|
*/
|
|
244
231
|
var context: Context;
|
|
245
232
|
/**
|
|
@@ -281,12 +268,12 @@ declare namespace Office {
|
|
|
281
268
|
*
|
|
282
269
|
* *Supported applications, by platform*
|
|
283
270
|
* <table>
|
|
284
|
-
* <tr><th> </th><th> Office on
|
|
285
|
-
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported
|
|
286
|
-
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported
|
|
287
|
-
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported
|
|
288
|
-
* <tr><td><strong> Project </strong></td><td>
|
|
289
|
-
* <tr><td><strong> Word </strong></td><td> Supported </td><td> Supported
|
|
271
|
+
* <tr><th> </th><th> Office on the web </th><th> Office on Windows </th><th> Office on Mac </th><th> Office on iPad </th><th> Outlook on mobile devices </th></tr>
|
|
272
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> Supported </td><td> Not applicable </td></tr>
|
|
273
|
+
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> Supported </td><td> Supported </td></tr>
|
|
274
|
+
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> Supported </td><td> Not applicable </td></tr>
|
|
275
|
+
* <tr><td><strong> Project </strong></td><td> Not supported </td><td> Supported </td><td> Supported </td><td> Not supported </td><td> Not applicable </td></tr>
|
|
276
|
+
* <tr><td><strong> Word </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> Supported </td><td> Not applicable </td></tr>
|
|
290
277
|
* </table>
|
|
291
278
|
*
|
|
292
279
|
* @param reason Indicates how the app was initialized.
|
|
@@ -324,9 +311,9 @@ declare namespace Office {
|
|
|
324
311
|
*
|
|
325
312
|
* *Supported applications, by platform*
|
|
326
313
|
* <table>
|
|
327
|
-
* <tr><th> </th><th> Office on
|
|
328
|
-
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported
|
|
329
|
-
* <tr><td><strong> Word </strong></td><td>
|
|
314
|
+
* <tr><th> </th><th> Office on the web </th><th> Office on Windows </th><th> Office on iPad </th></tr>
|
|
315
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported </td><td> Supported </td></tr>
|
|
316
|
+
* <tr><td><strong> Word </strong></td><td> Not supported </td><td> Supported </td><td> Supported </td></tr>
|
|
330
317
|
* </table>
|
|
331
318
|
*/
|
|
332
319
|
function select(expression: string, callback?: (result: AsyncResult<any>) => void): Binding;
|
|
@@ -342,12 +329,12 @@ declare namespace Office {
|
|
|
342
329
|
*
|
|
343
330
|
* *Supported applications, by platform*
|
|
344
331
|
* <table>
|
|
345
|
-
* <tr><th> </th><th> Office on
|
|
346
|
-
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported
|
|
347
|
-
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported
|
|
348
|
-
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported
|
|
349
|
-
* <tr><td><strong> Project </strong></td><td>
|
|
350
|
-
* <tr><td><strong> Word </strong></td><td> Supported </td><td> Supported
|
|
332
|
+
* <tr><th> </th><th> Office on the web </th><th> Office on Windows </th><th> Office on Mac </th><th> Office on iPad </th><th> Outlook on mobile devices </th></tr>
|
|
333
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported </td><td> Not supported </td><td> Supported </td><td> Not applicable </td></tr>
|
|
334
|
+
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> Supported </td><td> Supported </td></tr>
|
|
335
|
+
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported </td><td> Not supported </td><td> Supported </td><td> Not applicable </td></tr>
|
|
336
|
+
* <tr><td><strong> Project </strong></td><td> Not supported </td><td> Supported </td><td> Not supported </td><td> Not supported </td><td> Not applicable </td></tr>
|
|
337
|
+
* <tr><td><strong> Word </strong></td><td> Supported </td><td> Supported </td><td> Not supported </td><td> Supported </td><td> Not applicable </td></tr>
|
|
351
338
|
* </table>
|
|
352
339
|
*
|
|
353
340
|
* @param useShortNamespace True to use the shortcut alias; otherwise false to disable it. The default is true.
|
|
@@ -3379,9 +3366,20 @@ declare namespace Office {
|
|
|
3379
3366
|
*
|
|
3380
3367
|
* *Supported errors*
|
|
3381
3368
|
* <table>
|
|
3382
|
-
* <tr
|
|
3383
|
-
*
|
|
3384
|
-
*
|
|
3369
|
+
* <tr>
|
|
3370
|
+
* <th><code>AsyncResult.error.name</code> </th><th><code>AsyncResult.error.message</code></th>
|
|
3371
|
+
* <th>Description of diagnostics object returned</th>
|
|
3372
|
+
* </tr>
|
|
3373
|
+
* <tr>
|
|
3374
|
+
* <td><strong>HTTPRequestFailure</strong></td>
|
|
3375
|
+
* <td>The request has failed. Please look at the diagnostics object for the HTTP error code.</td>
|
|
3376
|
+
* <td>The HTTP error code in a JSON object e.g., <code>{"HTTPCode":"401"}</code>.</td>
|
|
3377
|
+
* </tr>
|
|
3378
|
+
* <tr>
|
|
3379
|
+
* <td><strong>InternalServerError</strong></td>
|
|
3380
|
+
* <td>The Exchange server returned an error. Please look at the diagnostics object for more information.</td>
|
|
3381
|
+
* <td>The error message from the Exchange server in a JSON object e.g., <code>{"ErrorText": "The mailbox database is temporarily unavailable"}</code>.</td>
|
|
3382
|
+
* </tr>
|
|
3385
3383
|
* </table>
|
|
3386
3384
|
*/
|
|
3387
3385
|
diagnostics: any;
|
|
@@ -3867,31 +3865,31 @@ declare namespace Office {
|
|
|
3867
3865
|
* </tr>
|
|
3868
3866
|
* <tr>
|
|
3869
3867
|
* <td><code>AsyncResult.value</code></td>
|
|
3870
|
-
* <td>Always returns <code>undefined</code> because there
|
|
3868
|
+
* <td>Always returns <code>undefined</code> because there's no object or data to retrieve.</td>
|
|
3871
3869
|
* </tr>
|
|
3872
3870
|
* <tr>
|
|
3873
3871
|
* <td><code>AsyncResult.status</code></td>
|
|
3874
|
-
* <td>Determine the success or failure of the operation
|
|
3872
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
3875
3873
|
* </tr>
|
|
3876
3874
|
* <tr>
|
|
3877
3875
|
* <td><code>AsyncResult.error</code></td>
|
|
3878
|
-
* <td>Access an Error object that provides error information if the operation failed
|
|
3876
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
3879
3877
|
* </tr>
|
|
3880
3878
|
* <tr>
|
|
3881
3879
|
* <td><code>AsyncResult.asyncContext</code></td>
|
|
3882
|
-
* <td>Define an item of any type that
|
|
3880
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
3883
3881
|
* </tr>
|
|
3884
3882
|
* </table>
|
|
3885
3883
|
*
|
|
3886
3884
|
* @param data The data to be set in the current selection. Possible data types by Office application:
|
|
3887
3885
|
*
|
|
3888
|
-
* string: Excel on the web and Windows, and Word on the web and Windows only
|
|
3886
|
+
* string: Excel on the web and Windows, and Word on the web and on Windows only
|
|
3889
3887
|
*
|
|
3890
3888
|
* array of arrays: Excel and Word only
|
|
3891
3889
|
*
|
|
3892
3890
|
* {@link Office.TableData}: Excel and Word only
|
|
3893
3891
|
*
|
|
3894
|
-
* HTML: Word on the web and Windows only
|
|
3892
|
+
* HTML: Word on the web and on Windows only
|
|
3895
3893
|
*
|
|
3896
3894
|
* Office Open XML: Word only
|
|
3897
3895
|
*
|
|
@@ -4014,31 +4012,31 @@ declare namespace Office {
|
|
|
4014
4012
|
* </tr>
|
|
4015
4013
|
* <tr>
|
|
4016
4014
|
* <td><code>AsyncResult.value</code></td>
|
|
4017
|
-
* <td>Always returns <code>undefined</code> because there
|
|
4015
|
+
* <td>Always returns <code>undefined</code> because there's no object or data to retrieve.</td>
|
|
4018
4016
|
* </tr>
|
|
4019
4017
|
* <tr>
|
|
4020
4018
|
* <td><code>AsyncResult.status</code></td>
|
|
4021
|
-
* <td>Determine the success or failure of the operation
|
|
4019
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
4022
4020
|
* </tr>
|
|
4023
4021
|
* <tr>
|
|
4024
4022
|
* <td><code>AsyncResult.error</code></td>
|
|
4025
|
-
* <td>Access an Error object that provides error information if the operation failed
|
|
4023
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
4026
4024
|
* </tr>
|
|
4027
4025
|
* <tr>
|
|
4028
4026
|
* <td><code>AsyncResult.asyncContext</code></td>
|
|
4029
|
-
* <td>Define an item of any type that
|
|
4027
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
4030
4028
|
* </tr>
|
|
4031
4029
|
* </table>
|
|
4032
4030
|
*
|
|
4033
4031
|
* @param data The data to be set in the current selection. Possible data types by Office application:
|
|
4034
4032
|
*
|
|
4035
|
-
* string: Excel on the web and Windows, and Word on the web and Windows only
|
|
4033
|
+
* string: Excel on the web and on Windows, and Word on the web and on Windows only
|
|
4036
4034
|
*
|
|
4037
4035
|
* array of arrays: Excel and Word only
|
|
4038
4036
|
*
|
|
4039
4037
|
* `TableData`: Excel and Word only
|
|
4040
4038
|
*
|
|
4041
|
-
* HTML: Word on the web and Windows only
|
|
4039
|
+
* HTML: Word on the web and on Windows only
|
|
4042
4040
|
*
|
|
4043
4041
|
* Office Open XML: Word only
|
|
4044
4042
|
*
|
|
@@ -4396,11 +4394,24 @@ declare namespace Office {
|
|
|
4396
4394
|
}
|
|
4397
4395
|
/**
|
|
4398
4396
|
* Represents the runtime environment of the add-in and provides access to key objects of the API.
|
|
4399
|
-
* The current context exists as a property of Office. It
|
|
4397
|
+
* The current context exists as a property of Office. It's accessed using `Office.context`.
|
|
4400
4398
|
*
|
|
4401
4399
|
* @remarks
|
|
4402
4400
|
*
|
|
4403
|
-
* **
|
|
4401
|
+
* **Support details**
|
|
4402
|
+
*
|
|
4403
|
+
* For more information about Office application and server requirements, see
|
|
4404
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
|
|
4405
|
+
*
|
|
4406
|
+
* *Supported applications, by platform*
|
|
4407
|
+
* <table>
|
|
4408
|
+
* <tr><th> </th><th> Office on the web </th><th> Office on Windows </th><th> Office on Mac </th><th> Office on iPad </th><th> Outlook on mobile devices </th></tr>
|
|
4409
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> Supported </td><td> Not applicable </td></tr>
|
|
4410
|
+
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> Supported </td><td> Supported </td></tr>
|
|
4411
|
+
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> Supported </td><td> Not applicable </td></tr>
|
|
4412
|
+
* <tr><td><strong> Project </strong></td><td> Not supported </td><td> Supported </td><td> Supported </td><td> Not supported </td><td> Not applicable </td></tr>
|
|
4413
|
+
* <tr><td><strong> Word </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> Supported </td><td> Not applicable </td></tr>
|
|
4414
|
+
* </table>
|
|
4404
4415
|
*/
|
|
4405
4416
|
interface Context {
|
|
4406
4417
|
/**
|
|
@@ -4432,12 +4443,12 @@ declare namespace Office {
|
|
|
4432
4443
|
*
|
|
4433
4444
|
* *Supported applications, by platform*
|
|
4434
4445
|
* <table>
|
|
4435
|
-
* <tr><th> </th><th> Office on
|
|
4436
|
-
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported
|
|
4437
|
-
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported
|
|
4438
|
-
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported
|
|
4439
|
-
* <tr><td><strong> Project </strong></td><td>
|
|
4440
|
-
* <tr><td><strong> Word </strong></td><td> Supported </td><td> Supported
|
|
4446
|
+
* <tr><th> </th><th> Office on the web </th><th> Office on Windows </th><th> Office on Mac </th><th> Office on iPad </th><th> Outlook on mobile devices </th></tr>
|
|
4447
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported </td><td> Not supported </td><td> Supported </td><td> Not applicable </td></tr>
|
|
4448
|
+
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> Supported </td><td> Supported </td></tr>
|
|
4449
|
+
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported </td><td> Not supported </td><td> Supported </td><td> Not applicable </td></tr>
|
|
4450
|
+
* <tr><td><strong> Project </strong></td><td> Not supported </td><td> Supported </td><td> Not supported </td><td> Not supported </td><td> Not applicable </td></tr>
|
|
4451
|
+
* <tr><td><strong> Word </strong></td><td> Supported </td><td> Supported </td><td> Not supported </td><td> Supported </td><td> Not applicable </td></tr>
|
|
4441
4452
|
* </table>
|
|
4442
4453
|
*/
|
|
4443
4454
|
contentLanguage: string;
|
|
@@ -4470,12 +4481,12 @@ declare namespace Office {
|
|
|
4470
4481
|
*
|
|
4471
4482
|
* *Supported applications, by platform*
|
|
4472
4483
|
* <table>
|
|
4473
|
-
* <tr><th> </th><th> Office on
|
|
4474
|
-
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported
|
|
4475
|
-
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported
|
|
4476
|
-
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported
|
|
4477
|
-
* <tr><td><strong> Project </strong></td><td>
|
|
4478
|
-
* <tr><td><strong> Word </strong></td><td>
|
|
4484
|
+
* <tr><th> </th><th> Office on the web </th><th> Office on Windows </th><th> Office on Mac </th><th> Office on iPad </th><th> Outlook on mobile devices </th></tr>
|
|
4485
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> Supported </td><td> Not applicable </td></tr>
|
|
4486
|
+
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> Supported </td><td> Supported </td></tr>
|
|
4487
|
+
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> Supported </td><td> Not applicable </td></tr>
|
|
4488
|
+
* <tr><td><strong> Project </strong></td><td> Not supported </td><td> Supported </td><td> Supported </td><td> Not supported </td><td> Not applicable </td></tr>
|
|
4489
|
+
* <tr><td><strong> Word </strong></td><td> Not supported </td><td> Supported </td><td> Supported </td><td> Supported </td><td> Not applicable </td></tr>
|
|
4479
4490
|
* </table>
|
|
4480
4491
|
*/
|
|
4481
4492
|
displayLanguage: string;
|
|
@@ -5396,10 +5407,10 @@ declare namespace Office {
|
|
|
5396
5407
|
*
|
|
5397
5408
|
* *Supported FileTypes, by platform*
|
|
5398
5409
|
* <table>
|
|
5399
|
-
* <tr><th> </th><th> Office on
|
|
5400
|
-
* <tr><td><strong> Excel </strong></td><td><code>Compressed</code>, <code>Pdf</code
|
|
5401
|
-
* <tr><td><strong> PowerPoint </strong></td><td><code>Compressed</code>, <code>Pdf</code> </td><td><code>Compressed</code>, <code>Pdf</code> </td><td><code>Compressed</code>, <code>Pdf</code
|
|
5402
|
-
* <tr><td><strong> Word </strong></td><td><code>Compressed</code>, <code>Pdf</code>, <code>Text</code></td><td><code>Compressed</code>, <code>Pdf</code>, <code>Text</code></td><td><code>Compressed</code>, <code>Pdf</code></td><td><code>Compressed</code>, <code>Pdf</code
|
|
5410
|
+
* <tr><th> </th><th> Office on the web </th><th> Office on Windows </th><th> Office on Mac </th><th> Office on iPad </th></tr>
|
|
5411
|
+
* <tr><td><strong> Excel </strong></td><td><code>Compressed</code>, <code>Pdf</code> </td><td><code>Compressed</code>, <code>Pdf</code>, <code>Text</code></td><td><code>Compressed</code>, <code>Pdf</code>, <code>Text</code></td><td> Not supported </td></tr>
|
|
5412
|
+
* <tr><td><strong> PowerPoint </strong></td><td><code>Compressed</code>, <code>Pdf</code> </td><td><code>Compressed</code>, <code>Pdf</code> </td><td><code>Compressed</code>, <code>Pdf</code> </td><td><code>Compressed</code>, <code>Pdf</code></td></tr>
|
|
5413
|
+
* <tr><td><strong> Word </strong></td><td><code>Compressed</code>, <code>Pdf</code>, <code>Text</code></td><td><code>Compressed</code>, <code>Pdf</code>, <code>Text</code></td><td><code>Compressed</code>, <code>Pdf</code>, <code>Text</code></td><td><code>Compressed</code>, <code>Pdf</code></td></tr>
|
|
5403
5414
|
* </table>
|
|
5404
5415
|
*
|
|
5405
5416
|
* @param fileType The format in which the file will be returned
|
|
@@ -5423,7 +5434,7 @@ declare namespace Office {
|
|
|
5423
5434
|
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textfile | TextFile} (when using `Office.FileType.Text`)
|
|
5424
5435
|
*
|
|
5425
5436
|
* For add-ins running in Office applications other than Office on iPad, the `getFileAsync` method supports getting files in slices of up
|
|
5426
|
-
* to 4194304 bytes (4 MB). For add-ins running in Office on iPad
|
|
5437
|
+
* to 4194304 bytes (4 MB). For add-ins running in Office apps on iPad, the `getFileAsync` method supports getting files in slices of up to
|
|
5427
5438
|
* 65536 (64 KB).
|
|
5428
5439
|
*
|
|
5429
5440
|
* The `fileType` parameter can be specified by using the {@link Office.FileType} enumeration or text values. But the possible values vary with
|
|
@@ -5431,10 +5442,10 @@ declare namespace Office {
|
|
|
5431
5442
|
*
|
|
5432
5443
|
* *Supported FileTypes, by platform*
|
|
5433
5444
|
* <table>
|
|
5434
|
-
* <tr><th> </th><th> Office on
|
|
5435
|
-
* <tr><td><strong> Excel </strong></td><td><code>Compressed</code>, <code>Pdf</code
|
|
5436
|
-
* <tr><td><strong> PowerPoint </strong></td><td><code>Compressed</code>, <code>Pdf</code> </td><td><code>Compressed</code>, <code>Pdf</code> </td><td><code>Compressed</code>, <code>Pdf</code
|
|
5437
|
-
* <tr><td><strong> Word </strong></td><td><code>Compressed</code>, <code>Pdf</code>, <code>Text</code></td><td><code>Compressed</code>, <code>Pdf</code>, <code>Text</code></td><td><code>Compressed</code>, <code>Pdf</code></td><td><code>Compressed</code>, <code>Pdf</code
|
|
5445
|
+
* <tr><th> </th><th> Office on the web </th><th> Office on Windows </th><th> Office on Mac </th><th> Office on iPad </th></tr>
|
|
5446
|
+
* <tr><td><strong> Excel </strong></td><td><code>Compressed</code>, <code>Pdf</code> </td><td><code>Compressed</code>, <code>Pdf</code>, <code>Text</code></td><td><code>Compressed</code>, <code>Pdf</code>, <code>Text</code></td><td> Not supported </td></tr>
|
|
5447
|
+
* <tr><td><strong> PowerPoint </strong></td><td><code>Compressed</code>, <code>Pdf</code> </td><td><code>Compressed</code>, <code>Pdf</code> </td><td><code>Compressed</code>, <code>Pdf</code> </td><td><code>Compressed</code>, <code>Pdf</code></td></tr>
|
|
5448
|
+
* <tr><td><strong> Word </strong></td><td><code>Compressed</code>, <code>Pdf</code>, <code>Text</code></td><td><code>Compressed</code>, <code>Pdf</code>, <code>Text</code></td><td><code>Compressed</code>, <code>Pdf</code>, <code>Text</code></td><td><code>Compressed</code>, <code>Pdf</code></td></tr>
|
|
5438
5449
|
* </table>
|
|
5439
5450
|
*
|
|
5440
5451
|
* @param fileType The format in which the file will be returned
|
|
@@ -5498,19 +5509,19 @@ declare namespace Office {
|
|
|
5498
5509
|
* </tr>
|
|
5499
5510
|
* <tr>
|
|
5500
5511
|
* <td><code>AsyncResult.value</code></td>
|
|
5501
|
-
* <td>Always returns <code>undefined</code> because there
|
|
5512
|
+
* <td>Always returns <code>undefined</code> because there's no object or data to retrieve.</td>
|
|
5502
5513
|
* </tr>
|
|
5503
5514
|
* <tr>
|
|
5504
5515
|
* <td><code>AsyncResult.status</code></td>
|
|
5505
|
-
* <td>Determine the success or failure of the operation
|
|
5516
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
5506
5517
|
* </tr>
|
|
5507
5518
|
* <tr>
|
|
5508
5519
|
* <td><code>AsyncResult.error</code></td>
|
|
5509
|
-
* <td>Access an Error object that provides error information if the operation failed
|
|
5520
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
5510
5521
|
* </tr>
|
|
5511
5522
|
* <tr>
|
|
5512
5523
|
* <td><code>AsyncResult.asyncContext</code></td>
|
|
5513
|
-
* <td>Define an item of any type that
|
|
5524
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
5514
5525
|
* </tr>
|
|
5515
5526
|
* </table>
|
|
5516
5527
|
*
|
|
@@ -5523,31 +5534,31 @@ declare namespace Office {
|
|
|
5523
5534
|
* </tr>
|
|
5524
5535
|
* <tr>
|
|
5525
5536
|
* <td><code>Office.CoercionType.Html</code></td>
|
|
5526
|
-
* <td
|
|
5537
|
+
* <td><ul><li>Word</li></ul></td>
|
|
5527
5538
|
* </tr>
|
|
5528
5539
|
* <tr>
|
|
5529
5540
|
* <td><code>Office.CoercionType.Matrix</code> (array of arrays)</td>
|
|
5530
|
-
* <td
|
|
5541
|
+
* <td><ul><li>Excel</li><li>Word</li></ul></td>
|
|
5531
5542
|
* </tr>
|
|
5532
5543
|
* <tr>
|
|
5533
5544
|
* <td><code>Office.CoercionType.Ooxml</code> (Office Open XML)</td>
|
|
5534
|
-
* <td
|
|
5545
|
+
* <td><ul><li>Word</li></ul></td>
|
|
5535
5546
|
* </tr>
|
|
5536
5547
|
* <tr>
|
|
5537
5548
|
* <td><code>Office.CoercionType.SlideRange</code></td>
|
|
5538
|
-
* <td
|
|
5549
|
+
* <td><ul><li>PowerPoint</li></ul></td>
|
|
5539
5550
|
* </tr>
|
|
5540
5551
|
* <tr>
|
|
5541
5552
|
* <td><code>Office.CoercionType.Table</code> (TableData object)</td>
|
|
5542
|
-
* <td
|
|
5553
|
+
* <td><ul><li>Excel</li><li>Word</li></ul></td>
|
|
5543
5554
|
* </tr>
|
|
5544
5555
|
* <tr>
|
|
5545
5556
|
* <td><code>Office.CoercionType.Text</code> (string)</td>
|
|
5546
|
-
* <td
|
|
5557
|
+
* <td><ul><li>Excel</li><li>PowerPoint</li><li>Project</li><li>Word</li></ul></td>
|
|
5547
5558
|
* </tr>
|
|
5548
5559
|
* <tr>
|
|
5549
5560
|
* <td><code>Office.CoercionType.XmlSvg</code></td>
|
|
5550
|
-
* <td
|
|
5561
|
+
* <td><ul><li>Excel on Windows and on Mac</li></ul></td>
|
|
5551
5562
|
* </tr>
|
|
5552
5563
|
* </table>
|
|
5553
5564
|
*
|
|
@@ -5590,19 +5601,19 @@ declare namespace Office {
|
|
|
5590
5601
|
* </tr>
|
|
5591
5602
|
* <tr>
|
|
5592
5603
|
* <td><code>AsyncResult.value</code></td>
|
|
5593
|
-
* <td>Always returns <code>undefined</code> because there
|
|
5604
|
+
* <td>Always returns <code>undefined</code> because there's no object or data to retrieve.</td>
|
|
5594
5605
|
* </tr>
|
|
5595
5606
|
* <tr>
|
|
5596
5607
|
* <td><code>AsyncResult.status</code></td>
|
|
5597
|
-
* <td>Determine the success or failure of the operation
|
|
5608
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
5598
5609
|
* </tr>
|
|
5599
5610
|
* <tr>
|
|
5600
5611
|
* <td><code>AsyncResult.error</code></td>
|
|
5601
|
-
* <td>Access an Error object that provides error information if the operation failed
|
|
5612
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
5602
5613
|
* </tr>
|
|
5603
5614
|
* <tr>
|
|
5604
5615
|
* <td><code>AsyncResult.asyncContext</code></td>
|
|
5605
|
-
* <td>Define an item of any type that
|
|
5616
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
5606
5617
|
* </tr>
|
|
5607
5618
|
* </table>
|
|
5608
5619
|
*
|
|
@@ -5615,31 +5626,31 @@ declare namespace Office {
|
|
|
5615
5626
|
* </tr>
|
|
5616
5627
|
* <tr>
|
|
5617
5628
|
* <td><code>Office.CoercionType.Html</code></td>
|
|
5618
|
-
* <td
|
|
5629
|
+
* <td><ul><li>Word</li></ul></td>
|
|
5619
5630
|
* </tr>
|
|
5620
5631
|
* <tr>
|
|
5621
5632
|
* <td><code>Office.CoercionType.Matrix</code> (array of arrays)</td>
|
|
5622
|
-
* <td
|
|
5633
|
+
* <td><ul><li>Excel</li><li>Word</li></ul></td>
|
|
5623
5634
|
* </tr>
|
|
5624
5635
|
* <tr>
|
|
5625
5636
|
* <td><code>Office.CoercionType.Ooxml</code> (Office Open XML)</td>
|
|
5626
|
-
* <td
|
|
5637
|
+
* <td><ul><li>Word</li></ul></td>
|
|
5627
5638
|
* </tr>
|
|
5628
5639
|
* <tr>
|
|
5629
5640
|
* <td><code>Office.CoercionType.SlideRange</code></td>
|
|
5630
|
-
* <td
|
|
5641
|
+
* <td><ul><li>PowerPoint</li></ul></td>
|
|
5631
5642
|
* </tr>
|
|
5632
5643
|
* <tr>
|
|
5633
5644
|
* <td><code>Office.CoercionType.Table</code> (TableData object)</td>
|
|
5634
|
-
* <td
|
|
5645
|
+
* <td><ul><li>Excel</li><li>Word</li></ul></td>
|
|
5635
5646
|
* </tr>
|
|
5636
5647
|
* <tr>
|
|
5637
5648
|
* <td><code>Office.CoercionType.Text</code> (string)</td>
|
|
5638
|
-
* <td
|
|
5649
|
+
* <td><ul><li>Excel</li><li>PowerPoint</li><li>Project</li><li>Word</li></ul></td>
|
|
5639
5650
|
* </tr>
|
|
5640
5651
|
* <tr>
|
|
5641
5652
|
* <td><code>Office.CoercionType.XmlSvg</code></td>
|
|
5642
|
-
* <td
|
|
5653
|
+
* <td><ul><li>Excel on Windows and on Mac</li></ul></td>
|
|
5643
5654
|
* </tr>
|
|
5644
5655
|
* </table>
|
|
5645
5656
|
*
|
|
@@ -5755,8 +5766,13 @@ declare namespace Office {
|
|
|
5755
5766
|
*
|
|
5756
5767
|
* <table>
|
|
5757
5768
|
* <tr>
|
|
5769
|
+
* <th>Application</th>
|
|
5770
|
+
* <th>Condition</th>
|
|
5771
|
+
* <th>Behavior</th>
|
|
5772
|
+
* </tr>
|
|
5773
|
+
* <tr>
|
|
5758
5774
|
* <td>Word</td>
|
|
5759
|
-
* <td>If there
|
|
5775
|
+
* <td>If there's no selection and the insertion point is at a valid location, the specified <code>data</code> is inserted at the insertion point</td>
|
|
5760
5776
|
* <td>If <code>data</code> is a string, the specified text is inserted.</td>
|
|
5761
5777
|
* </tr>
|
|
5762
5778
|
* <tr>
|
|
@@ -5777,18 +5793,18 @@ declare namespace Office {
|
|
|
5777
5793
|
* <tr>
|
|
5778
5794
|
* <td></td>
|
|
5779
5795
|
* <td></td>
|
|
5780
|
-
* <td>If <code>data</code> is a
|
|
5796
|
+
* <td>If <code>data</code> is a Base64-encoded image stream, the specified image is inserted.</td>
|
|
5781
5797
|
* </tr>
|
|
5782
5798
|
* <tr>
|
|
5783
5799
|
* <td></td>
|
|
5784
|
-
* <td>If there
|
|
5800
|
+
* <td>If there's a selection</td>
|
|
5785
5801
|
* <td>It will be replaced with the specified <code>data</code> following the same rules as above.</td>
|
|
5786
5802
|
* </tr>
|
|
5787
5803
|
* <tr>
|
|
5788
5804
|
* <td></td>
|
|
5789
5805
|
* <td>Insert images</td>
|
|
5790
5806
|
* <td>Inserted images are placed inline. The imageLeft and imageTop parameters are ignored. The image aspect ratio is always locked. If only one of the imageWidth and imageHeight parameter is given, the other value will be automatically scaled to keep the original aspect ratio.</td>
|
|
5791
|
-
*
|
|
5807
|
+
* </tr>
|
|
5792
5808
|
*
|
|
5793
5809
|
* <tr>
|
|
5794
5810
|
* <td>Excel</td>
|
|
@@ -5808,7 +5824,7 @@ declare namespace Office {
|
|
|
5808
5824
|
* <tr>
|
|
5809
5825
|
* <td></td>
|
|
5810
5826
|
* <td>If multiple cells are selected</td>
|
|
5811
|
-
* <td>If the shape
|
|
5827
|
+
* <td>If the shape doesn't match the shape of <code>data</code>, an error is returned.</td>
|
|
5812
5828
|
* </tr>
|
|
5813
5829
|
* <tr>
|
|
5814
5830
|
* <td></td>
|
|
@@ -5855,35 +5871,35 @@ declare namespace Office {
|
|
|
5855
5871
|
* </tr>
|
|
5856
5872
|
* <tr>
|
|
5857
5873
|
* <td><code>Office.CoercionType.Html</code></td>
|
|
5858
|
-
* <td
|
|
5874
|
+
* <td><ul><li>Word</li></ul></td>
|
|
5859
5875
|
* </tr>
|
|
5860
5876
|
* <tr>
|
|
5861
5877
|
* <td><code>Office.CoercionType.Matrix</code> (array of arrays)</td>
|
|
5862
|
-
* <td
|
|
5878
|
+
* <td><ul><li>Excel</li><li>Word</li></ul></td>
|
|
5863
5879
|
* </tr>
|
|
5864
5880
|
* <tr>
|
|
5865
5881
|
* <td><code>Office.CoercionType.Ooxml</code> (Office Open XML)</td>
|
|
5866
|
-
* <td
|
|
5882
|
+
* <td><ul><li>Word</li></ul></td>
|
|
5867
5883
|
* </tr>
|
|
5868
5884
|
* <tr>
|
|
5869
5885
|
* <td><code>Office.CoercionType.SlideRange</code></td>
|
|
5870
|
-
* <td
|
|
5886
|
+
* <td><ul><li>PowerPoint on the web and on Windows</li></ul></td>
|
|
5871
5887
|
* </tr>
|
|
5872
5888
|
* <tr>
|
|
5873
5889
|
* <td><code>Office.CoercionType.Table</code> (TableData object)</td>
|
|
5874
|
-
* <td
|
|
5890
|
+
* <td><ul><li>Excel</li><li>Word</li></ul></td>
|
|
5875
5891
|
* </tr>
|
|
5876
5892
|
* <tr>
|
|
5877
5893
|
* <td><code>Office.CoercionType.Text</code> (string)</td>
|
|
5878
|
-
* <td
|
|
5894
|
+
* <td><ul><li>Excel</li><li>PowerPoint</li><li>Project</li><li>Word</li></ul></td>
|
|
5879
5895
|
* </tr>
|
|
5880
5896
|
* <tr>
|
|
5881
5897
|
* <td><code>Office.CoercionType.XmlSvg</code></td>
|
|
5882
|
-
* <td
|
|
5898
|
+
* <td><ul><li>Excel on Windows and on Mac</li><li>PowerPoint on the web, on Windows, and on Mac</li><li>Word on Windows and on Mac</li></ul></td>
|
|
5883
5899
|
* </tr>
|
|
5884
5900
|
* </table>
|
|
5885
5901
|
*
|
|
5886
|
-
* @param data The data to be set. Either a string or {@link Office.CoercionType} value,
|
|
5902
|
+
* @param data The data to be set. Either a string or {@link Office.CoercionType} value, 2D array or TableData object.
|
|
5887
5903
|
*
|
|
5888
5904
|
* If the value passed for `data` is:
|
|
5889
5905
|
*
|
|
@@ -5944,8 +5960,13 @@ declare namespace Office {
|
|
|
5944
5960
|
*
|
|
5945
5961
|
* <table>
|
|
5946
5962
|
* <tr>
|
|
5963
|
+
* <th>Application</th>
|
|
5964
|
+
* <th>Condition</th>
|
|
5965
|
+
* <th>Behavior</th>
|
|
5966
|
+
* </tr>
|
|
5967
|
+
* <tr>
|
|
5947
5968
|
* <td>Word</td>
|
|
5948
|
-
* <td>If there
|
|
5969
|
+
* <td>If there's no selection and the insertion point is at a valid location, the specified <code>data</code> is inserted at the insertion point</td>
|
|
5949
5970
|
* <td>If <code>data</code> is a string, the specified text is inserted.</td>
|
|
5950
5971
|
* </tr>
|
|
5951
5972
|
* <tr>
|
|
@@ -5966,11 +5987,11 @@ declare namespace Office {
|
|
|
5966
5987
|
* <tr>
|
|
5967
5988
|
* <td></td>
|
|
5968
5989
|
* <td></td>
|
|
5969
|
-
* <td>If <code>data</code> is a
|
|
5990
|
+
* <td>If <code>data</code> is a Base64-encoded image stream, the specified image is inserted.</td>
|
|
5970
5991
|
* </tr>
|
|
5971
5992
|
* <tr>
|
|
5972
5993
|
* <td></td>
|
|
5973
|
-
* <td>If there
|
|
5994
|
+
* <td>If there's a selection</td>
|
|
5974
5995
|
* <td>It will be replaced with the specified <code>data</code> following the same rules as above.</td>
|
|
5975
5996
|
* </tr>
|
|
5976
5997
|
* <tr>
|
|
@@ -5997,7 +6018,7 @@ declare namespace Office {
|
|
|
5997
6018
|
* <tr>
|
|
5998
6019
|
* <td></td>
|
|
5999
6020
|
* <td>If multiple cells are selected</td>
|
|
6000
|
-
* <td>If the shape
|
|
6021
|
+
* <td>If the shape doesn't match the shape of <code>data</code>, an error is returned.</td>
|
|
6001
6022
|
* </tr>
|
|
6002
6023
|
* <tr>
|
|
6003
6024
|
* <td></td>
|
|
@@ -6044,35 +6065,35 @@ declare namespace Office {
|
|
|
6044
6065
|
* </tr>
|
|
6045
6066
|
* <tr>
|
|
6046
6067
|
* <td><code>Office.CoercionType.Html</code></td>
|
|
6047
|
-
* <td
|
|
6068
|
+
* <td><ul><li>Word</li></ul></td>
|
|
6048
6069
|
* </tr>
|
|
6049
6070
|
* <tr>
|
|
6050
6071
|
* <td><code>Office.CoercionType.Matrix</code> (array of arrays)</td>
|
|
6051
|
-
* <td
|
|
6072
|
+
* <td><ul><li>Excel</li><li>Word</li></ul></td>
|
|
6052
6073
|
* </tr>
|
|
6053
6074
|
* <tr>
|
|
6054
6075
|
* <td><code>Office.CoercionType.Ooxml</code> (Office Open XML)</td>
|
|
6055
|
-
* <td
|
|
6076
|
+
* <td><ul><li>Word</li></ul></td>
|
|
6056
6077
|
* </tr>
|
|
6057
6078
|
* <tr>
|
|
6058
6079
|
* <td><code>Office.CoercionType.SlideRange</code></td>
|
|
6059
|
-
* <td
|
|
6080
|
+
* <td><ul><li>PowerPoint on the web and on Windows</li></ul></td>
|
|
6060
6081
|
* </tr>
|
|
6061
6082
|
* <tr>
|
|
6062
6083
|
* <td><code>Office.CoercionType.Table</code> (TableData object)</td>
|
|
6063
|
-
* <td
|
|
6084
|
+
* <td><ul><li>Excel</li><li>Word</li></ul></td>
|
|
6064
6085
|
* </tr>
|
|
6065
6086
|
* <tr>
|
|
6066
6087
|
* <td><code>Office.CoercionType.Text</code> (string)</td>
|
|
6067
|
-
* <td
|
|
6088
|
+
* <td><ul><li>Excel</li><li>PowerPoint</li><li>Project</li><li>Word</li></ul></td>
|
|
6068
6089
|
* </tr>
|
|
6069
6090
|
* <tr>
|
|
6070
6091
|
* <td><code>Office.CoercionType.XmlSvg</code></td>
|
|
6071
|
-
* <td
|
|
6092
|
+
* <td><ul><li>Excel on Windows and on Mac</li><li>PowerPoint on the web, on Windows, and on Mac</li><li>Word on Windows and on Mac</li></ul></td>
|
|
6072
6093
|
* </tr>
|
|
6073
6094
|
* </table>
|
|
6074
6095
|
*
|
|
6075
|
-
* @param data The data to be set. Either a string or {@link Office.CoercionType} value,
|
|
6096
|
+
* @param data The data to be set. Either a string or {@link Office.CoercionType} value, 2D array or TableData object.
|
|
6076
6097
|
*
|
|
6077
6098
|
* If the value passed for `data` is:
|
|
6078
6099
|
*
|
|
@@ -6104,7 +6125,7 @@ declare namespace Office {
|
|
|
6104
6125
|
*/
|
|
6105
6126
|
setSelectedDataAsync(data: string | TableData | any[][], callback?: (result: AsyncResult<void>) => void): void;
|
|
6106
6127
|
/**
|
|
6107
|
-
* Project documents only. Get Project field (
|
|
6128
|
+
* Project documents only. Get Project field (e.g., ProjectWebAccessURL).
|
|
6108
6129
|
* @param fieldId Project level fields.
|
|
6109
6130
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
6110
6131
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -6112,7 +6133,7 @@ declare namespace Office {
|
|
|
6112
6133
|
*/
|
|
6113
6134
|
getProjectFieldAsync(fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;
|
|
6114
6135
|
/**
|
|
6115
|
-
* Project documents only. Get Project field (
|
|
6136
|
+
* Project documents only. Get Project field (e.g., ProjectWebAccessURL).
|
|
6116
6137
|
* @param fieldId Project level fields.
|
|
6117
6138
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6118
6139
|
* The `value` property of the result contains the `fieldValue` property, which represents the value of the specified field.
|
|
@@ -6120,8 +6141,8 @@ declare namespace Office {
|
|
|
6120
6141
|
*/
|
|
6121
6142
|
getProjectFieldAsync(fieldId: number, callback?: (result: AsyncResult<any>) => void): void;
|
|
6122
6143
|
/**
|
|
6123
|
-
* Project documents only. Get resource field for provided resource
|
|
6124
|
-
* @param resourceId Either a string or value of the Resource
|
|
6144
|
+
* Project documents only. Get resource field for provided resource ID. (e.g., ResourceName)
|
|
6145
|
+
* @param resourceId Either a string or value of the Resource ID.
|
|
6125
6146
|
* @param fieldId Resource Fields.
|
|
6126
6147
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
6127
6148
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -6130,8 +6151,8 @@ declare namespace Office {
|
|
|
6130
6151
|
*/
|
|
6131
6152
|
getResourceFieldAsync(resourceId: string, fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
|
|
6132
6153
|
/**
|
|
6133
|
-
* Project documents only. Get resource field for provided resource
|
|
6134
|
-
* @param resourceId Either a string or value of the
|
|
6154
|
+
* Project documents only. Get resource field for provided resource ID. (e.g., ResourceName)
|
|
6155
|
+
* @param resourceId Either a string or value of the resource ID.
|
|
6135
6156
|
* @param fieldId Resource Fields.
|
|
6136
6157
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6137
6158
|
* The `value` property of the result is the GUID of the resource as a string.
|
|
@@ -6139,7 +6160,7 @@ declare namespace Office {
|
|
|
6139
6160
|
*/
|
|
6140
6161
|
getResourceFieldAsync(resourceId: string, fieldId: number, callback?: (result: AsyncResult<string>) => void): void;
|
|
6141
6162
|
/**
|
|
6142
|
-
* Project documents only. Get the current selected Resource's
|
|
6163
|
+
* Project documents only. Get the current selected Resource's ID.
|
|
6143
6164
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
6144
6165
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6145
6166
|
* The `value` property of the result is the GUID of the resource as a string.
|
|
@@ -6147,14 +6168,14 @@ declare namespace Office {
|
|
|
6147
6168
|
*/
|
|
6148
6169
|
getSelectedResourceAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
|
|
6149
6170
|
/**
|
|
6150
|
-
* Project documents only. Get the current selected Resource's
|
|
6171
|
+
* Project documents only. Get the current selected Resource's ID.
|
|
6151
6172
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6152
6173
|
* The `value` property of the result is the GUID of the resource as a string.
|
|
6153
6174
|
*
|
|
6154
6175
|
*/
|
|
6155
6176
|
getSelectedResourceAsync(callback?: (result: AsyncResult<string>) => void): void;
|
|
6156
6177
|
/**
|
|
6157
|
-
* Project documents only. Get the current selected Task's
|
|
6178
|
+
* Project documents only. Get the current selected Task's ID.
|
|
6158
6179
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
6159
6180
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6160
6181
|
* The `value` property of the result is the GUID of the resource as a string.
|
|
@@ -6162,14 +6183,14 @@ declare namespace Office {
|
|
|
6162
6183
|
*/
|
|
6163
6184
|
getSelectedTaskAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;
|
|
6164
6185
|
/**
|
|
6165
|
-
* Project documents only. Get the current selected Task's
|
|
6186
|
+
* Project documents only. Get the current selected Task's ID.
|
|
6166
6187
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6167
6188
|
* The `value` property of the result is the GUID of the resource as a string.
|
|
6168
6189
|
*
|
|
6169
6190
|
*/
|
|
6170
6191
|
getSelectedTaskAsync(callback?: (result: AsyncResult<string>) => void): void;
|
|
6171
6192
|
/**
|
|
6172
|
-
* Project documents only. Get the current selected View Type (
|
|
6193
|
+
* Project documents only. Get the current selected View Type (e.g., Gantt) and View Name.
|
|
6173
6194
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
6174
6195
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6175
6196
|
* The `value` property of the result contains the following properties:
|
|
@@ -6179,7 +6200,7 @@ declare namespace Office {
|
|
|
6179
6200
|
*/
|
|
6180
6201
|
getSelectedViewAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;
|
|
6181
6202
|
/**
|
|
6182
|
-
* Project documents only. Get the current selected View Type (
|
|
6203
|
+
* Project documents only. Get the current selected View Type (e.g., Gantt) and View Name.
|
|
6183
6204
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6184
6205
|
* The `value` property of the result contains the following properties:
|
|
6185
6206
|
* `viewName` - The name of the view, as a ProjectViewTypes constant.
|
|
@@ -6188,20 +6209,20 @@ declare namespace Office {
|
|
|
6188
6209
|
*/
|
|
6189
6210
|
getSelectedViewAsync(callback?: (result: AsyncResult<any>) => void): void;
|
|
6190
6211
|
/**
|
|
6191
|
-
* Project documents only. Get the Task Name, WSS Task
|
|
6192
|
-
* @param taskId Either a string or value of the Task
|
|
6212
|
+
* Project documents only. Get the Task Name, WSS Task ID, and ResourceNames for given taskId.
|
|
6213
|
+
* @param taskId Either a string or value of the Task ID.
|
|
6193
6214
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
6194
6215
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6195
6216
|
* The `value` property of the result contains the following properties:
|
|
6196
6217
|
* `taskName` - The name of the task.
|
|
6197
|
-
* `wssTaskId` - The ID of the task in the synchronized SharePoint task list. If the project
|
|
6218
|
+
* `wssTaskId` - The ID of the task in the synchronized SharePoint task list. If the project isn't synchronized with a SharePoint task list, the value is 0.
|
|
6198
6219
|
* `resourceNames` - The comma-separated list of the names of resources that are assigned to the task.
|
|
6199
6220
|
*
|
|
6200
6221
|
*/
|
|
6201
6222
|
getTaskAsync(taskId: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;
|
|
6202
6223
|
/**
|
|
6203
|
-
* Project documents only. Get the Task Name, WSS Task
|
|
6204
|
-
* @param taskId Either a string or value of the Task
|
|
6224
|
+
* Project documents only. Get the Task Name, WSS Task ID, and ResourceNames for given taskId.
|
|
6225
|
+
* @param taskId Either a string or value of the Task ID.
|
|
6205
6226
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6206
6227
|
* The `value` property of the result contains the following properties:
|
|
6207
6228
|
* `taskName` - The name of the task.
|
|
@@ -6211,8 +6232,8 @@ declare namespace Office {
|
|
|
6211
6232
|
*/
|
|
6212
6233
|
getTaskAsync(taskId: string, callback?: (result: AsyncResult<any>) => void): void;
|
|
6213
6234
|
/**
|
|
6214
|
-
* Project documents only. Get task field for provided task
|
|
6215
|
-
* @param taskId Either a string or value of the Task
|
|
6235
|
+
* Project documents only. Get task field for provided task ID. (e.g., StartDate).
|
|
6236
|
+
* @param taskId Either a string or value of the Task ID.
|
|
6216
6237
|
* @param fieldId Task Fields.
|
|
6217
6238
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
6218
6239
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -6221,8 +6242,8 @@ declare namespace Office {
|
|
|
6221
6242
|
*/
|
|
6222
6243
|
getTaskFieldAsync(taskId: string, fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;
|
|
6223
6244
|
/**
|
|
6224
|
-
* Project documents only. Get task field for provided task
|
|
6225
|
-
* @param taskId Either a string or value of the Task
|
|
6245
|
+
* Project documents only. Get task field for provided task ID. (e.g., StartDate).
|
|
6246
|
+
* @param taskId Either a string or value of the Task ID.
|
|
6226
6247
|
* @param fieldId Task Fields.
|
|
6227
6248
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6228
6249
|
* The `value` property of the result contains the `fieldValue` property, which represents the value of the specified field.
|
|
@@ -6230,7 +6251,7 @@ declare namespace Office {
|
|
|
6230
6251
|
*/
|
|
6231
6252
|
getTaskFieldAsync(taskId: string, fieldId: number, callback?: (result: AsyncResult<any>) => void): void;
|
|
6232
6253
|
/**
|
|
6233
|
-
* Project documents only. Get the WSS
|
|
6254
|
+
* Project documents only. Get the WSS URL and list name for the Tasks List, the MPP is synced too.
|
|
6234
6255
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
6235
6256
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6236
6257
|
* The `value` property of the result contains the following properties:
|
|
@@ -6251,7 +6272,7 @@ declare namespace Office {
|
|
|
6251
6272
|
/**
|
|
6252
6273
|
* Project documents only. Get the maximum index of the collection of resources in the current project.
|
|
6253
6274
|
*
|
|
6254
|
-
* **Important**: This API works only in Project
|
|
6275
|
+
* **Important**: This API works only in Project on Windows desktop.
|
|
6255
6276
|
*
|
|
6256
6277
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
6257
6278
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -6262,7 +6283,7 @@ declare namespace Office {
|
|
|
6262
6283
|
/**
|
|
6263
6284
|
* Project documents only. Get the maximum index of the collection of resources in the current project.
|
|
6264
6285
|
*
|
|
6265
|
-
* **Important**: This API works only in Project
|
|
6286
|
+
* **Important**: This API works only in Project on Windows desktop.
|
|
6266
6287
|
*
|
|
6267
6288
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6268
6289
|
* The `value` property of the result is the highest index number in the current project's resource collection.
|
|
@@ -6272,7 +6293,7 @@ declare namespace Office {
|
|
|
6272
6293
|
/**
|
|
6273
6294
|
* Project documents only. Get the maximum index of the collection of tasks in the current project.
|
|
6274
6295
|
*
|
|
6275
|
-
* **Important**: This API works only in Project
|
|
6296
|
+
* **Important**: This API works only in Project on Windows desktop.
|
|
6276
6297
|
*
|
|
6277
6298
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
6278
6299
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -6283,7 +6304,7 @@ declare namespace Office {
|
|
|
6283
6304
|
/**
|
|
6284
6305
|
* Project documents only. Get the maximum index of the collection of tasks in the current project.
|
|
6285
6306
|
*
|
|
6286
|
-
* **Important**: This API works only in Project
|
|
6307
|
+
* **Important**: This API works only in Project on Windows desktop.
|
|
6287
6308
|
*
|
|
6288
6309
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6289
6310
|
* The `value` property of the result is the highest index number in the current project's task collection.
|
|
@@ -6293,7 +6314,7 @@ declare namespace Office {
|
|
|
6293
6314
|
/**
|
|
6294
6315
|
* Project documents only. Get the GUID of the resource that has the specified index in the resource collection.
|
|
6295
6316
|
*
|
|
6296
|
-
* **Important**: This API works only in Project
|
|
6317
|
+
* **Important**: This API works only in Project on Windows desktop.
|
|
6297
6318
|
*
|
|
6298
6319
|
* @param resourceIndex The index of the resource in the collection of resources for the project.
|
|
6299
6320
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -6305,7 +6326,7 @@ declare namespace Office {
|
|
|
6305
6326
|
/**
|
|
6306
6327
|
* Project documents only. Get the GUID of the resource that has the specified index in the resource collection.
|
|
6307
6328
|
*
|
|
6308
|
-
* **Important**: This API works only in Project
|
|
6329
|
+
* **Important**: This API works only in Project on Windows desktop.
|
|
6309
6330
|
*
|
|
6310
6331
|
* @param resourceIndex The index of the resource in the collection of resources for the project.
|
|
6311
6332
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -6316,7 +6337,7 @@ declare namespace Office {
|
|
|
6316
6337
|
/**
|
|
6317
6338
|
* Project documents only. Get the GUID of the task that has the specified index in the task collection.
|
|
6318
6339
|
*
|
|
6319
|
-
* **Important**: This API works only in Project
|
|
6340
|
+
* **Important**: This API works only in Project on Windows desktop.
|
|
6320
6341
|
*
|
|
6321
6342
|
* @param taskIndex The index of the task in the collection of tasks for the project.
|
|
6322
6343
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -6328,7 +6349,7 @@ declare namespace Office {
|
|
|
6328
6349
|
/**
|
|
6329
6350
|
* Project documents only. Get the GUID of the task that has the specified index in the task collection.
|
|
6330
6351
|
*
|
|
6331
|
-
* **Important**: This API works only in Project
|
|
6352
|
+
* **Important**: This API works only in Project on Windows desktop.
|
|
6332
6353
|
*
|
|
6333
6354
|
* @param taskIndex The index of the task in the collection of tasks for the project.
|
|
6334
6355
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -6337,11 +6358,11 @@ declare namespace Office {
|
|
|
6337
6358
|
*/
|
|
6338
6359
|
getTaskByIndexAsync(taskIndex: number, callback?: (result: AsyncResult<string>) => void): void;
|
|
6339
6360
|
/**
|
|
6340
|
-
* Project documents only. Set resource field for specified resource
|
|
6361
|
+
* Project documents only. Set resource field for specified resource ID.
|
|
6341
6362
|
*
|
|
6342
|
-
* **Important**: This API works only in Project
|
|
6363
|
+
* **Important**: This API works only in Project on Windows desktop.
|
|
6343
6364
|
*
|
|
6344
|
-
* @param resourceId Either a string or value of the Resource
|
|
6365
|
+
* @param resourceId Either a string or value of the Resource ID.
|
|
6345
6366
|
* @param fieldId Resource Fields.
|
|
6346
6367
|
* @param fieldValue Value of the target field.
|
|
6347
6368
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -6350,9 +6371,9 @@ declare namespace Office {
|
|
|
6350
6371
|
*/
|
|
6351
6372
|
setResourceFieldAsync(resourceId: string, fieldId: number, fieldValue: string | number | boolean | object, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
|
|
6352
6373
|
/**
|
|
6353
|
-
* Project documents only. Set resource field for specified resource
|
|
6374
|
+
* Project documents only. Set resource field for specified resource ID.
|
|
6354
6375
|
*
|
|
6355
|
-
* **Important**: This API works only in Project
|
|
6376
|
+
* **Important**: This API works only in Project on Windows desktop.
|
|
6356
6377
|
*
|
|
6357
6378
|
* @param resourceId Either a string or value of the Resource Id.
|
|
6358
6379
|
* @param fieldId Resource Fields.
|
|
@@ -6362,11 +6383,11 @@ declare namespace Office {
|
|
|
6362
6383
|
*/
|
|
6363
6384
|
setResourceFieldAsync(resourceId: string, fieldId: number, fieldValue: string | number | boolean | object, callback?: (result: AsyncResult<void>) => void): void;
|
|
6364
6385
|
/**
|
|
6365
|
-
* Project documents only. Set task field for specified task
|
|
6386
|
+
* Project documents only. Set task field for specified task ID.
|
|
6366
6387
|
*
|
|
6367
|
-
* **Important**: This API works only in Project
|
|
6388
|
+
* **Important**: This API works only in Project on Windows desktop.
|
|
6368
6389
|
*
|
|
6369
|
-
* @param taskId Either a string or value of the Task
|
|
6390
|
+
* @param taskId Either a string or value of the Task ID.
|
|
6370
6391
|
* @param fieldId Task Fields.
|
|
6371
6392
|
* @param fieldValue Value of the target field.
|
|
6372
6393
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -6375,11 +6396,11 @@ declare namespace Office {
|
|
|
6375
6396
|
*/
|
|
6376
6397
|
setTaskFieldAsync(taskId: string, fieldId: number, fieldValue: string | number | boolean | object, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
|
|
6377
6398
|
/**
|
|
6378
|
-
* Project documents only. Set task field for specified task
|
|
6399
|
+
* Project documents only. Set task field for specified task ID.
|
|
6379
6400
|
*
|
|
6380
|
-
* **Important**: This API works only in Project
|
|
6401
|
+
* **Important**: This API works only in Project on Windows desktop.
|
|
6381
6402
|
*
|
|
6382
|
-
* @param taskId Either a string or value of the Task
|
|
6403
|
+
* @param taskId Either a string or value of the Task ID.
|
|
6383
6404
|
* @param fieldId Task Fields.
|
|
6384
6405
|
* @param fieldValue Value of the target field.
|
|
6385
6406
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -6459,19 +6480,19 @@ declare namespace Office {
|
|
|
6459
6480
|
* </tr>
|
|
6460
6481
|
* <tr>
|
|
6461
6482
|
* <td><code>AsyncResult.value</code></td>
|
|
6462
|
-
* <td>Always returns <code>undefined</code> because there
|
|
6483
|
+
* <td>Always returns <code>undefined</code> because there's no object or data to retrieve.</td>
|
|
6463
6484
|
* </tr>
|
|
6464
6485
|
* <tr>
|
|
6465
6486
|
* <td><code>AsyncResult.status</code></td>
|
|
6466
|
-
* <td>Determine the success or failure of the operation
|
|
6487
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
6467
6488
|
* </tr>
|
|
6468
6489
|
* <tr>
|
|
6469
6490
|
* <td><code>AsyncResult.error</code></td>
|
|
6470
|
-
* <td>Access an Error object that provides error information if the operation failed
|
|
6491
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
6471
6492
|
* </tr>
|
|
6472
6493
|
* <tr>
|
|
6473
6494
|
* <td><code>AsyncResult.asyncContext</code></td>
|
|
6474
|
-
* <td>Define an item of any type that
|
|
6495
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
6475
6496
|
* </tr>
|
|
6476
6497
|
* </table>
|
|
6477
6498
|
*
|
|
@@ -6495,19 +6516,19 @@ declare namespace Office {
|
|
|
6495
6516
|
* </tr>
|
|
6496
6517
|
* <tr>
|
|
6497
6518
|
* <td><code>AsyncResult.value</code></td>
|
|
6498
|
-
* <td>Access the Slice object
|
|
6519
|
+
* <td>Access the Slice object.</td>
|
|
6499
6520
|
* </tr>
|
|
6500
6521
|
* <tr>
|
|
6501
6522
|
* <td><code>AsyncResult.status</code></td>
|
|
6502
|
-
* <td>Determine the success or failure of the operation
|
|
6523
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
6503
6524
|
* </tr>
|
|
6504
6525
|
* <tr>
|
|
6505
6526
|
* <td><code>AsyncResult.error</code></td>
|
|
6506
|
-
* <td>Access an Error object that provides error information if the operation failed
|
|
6527
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
6507
6528
|
* </tr>
|
|
6508
6529
|
* <tr>
|
|
6509
6530
|
* <td><code>AsyncResult.asyncContext</code></td>
|
|
6510
|
-
* <td>Define an item of any type that
|
|
6531
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
6511
6532
|
* </tr>
|
|
6512
6533
|
* </table>
|
|
6513
6534
|
*
|
|
@@ -6737,34 +6758,34 @@ declare namespace Office {
|
|
|
6737
6758
|
* <table>
|
|
6738
6759
|
* <tr>
|
|
6739
6760
|
* <th></th>
|
|
6740
|
-
* <th>Office on Windows</th>
|
|
6741
6761
|
* <th>Office on the web</th>
|
|
6762
|
+
* <th>Office on Windows</th>
|
|
6742
6763
|
* <th>Office on Mac</th>
|
|
6743
6764
|
* <th>Office on iOS</th>
|
|
6744
6765
|
* <th>Office on Android</th>
|
|
6745
6766
|
* </tr>
|
|
6746
6767
|
* <tr>
|
|
6747
6768
|
* <td><strong>Excel</strong></td>
|
|
6748
|
-
* <td>Supported</td>
|
|
6749
6769
|
* <td>Not available</td>
|
|
6750
6770
|
* <td>Supported</td>
|
|
6751
6771
|
* <td>Supported</td>
|
|
6772
|
+
* <td>Supported</td>
|
|
6752
6773
|
* <td>Not available</td>
|
|
6753
6774
|
* </tr>
|
|
6754
6775
|
* <tr>
|
|
6755
6776
|
* <td><strong>Outlook</strong></td>
|
|
6756
|
-
* <td>Preview</td>
|
|
6757
6777
|
* <td>Not available</td>
|
|
6778
|
+
* <td>Preview</td>
|
|
6758
6779
|
* <td>Not available</td>
|
|
6759
6780
|
* <td>Not available</td>
|
|
6760
6781
|
* <td>Not available</td>
|
|
6761
6782
|
* </tr>
|
|
6762
6783
|
* <tr>
|
|
6763
6784
|
* <td><strong>PowerPoint</strong></td>
|
|
6764
|
-
* <td>Supported</td>
|
|
6765
6785
|
* <td>Not available</td>
|
|
6766
6786
|
* <td>Supported</td>
|
|
6767
6787
|
* <td>Supported</td>
|
|
6788
|
+
* <td>Supported</td>
|
|
6768
6789
|
* <td>Not available</td>
|
|
6769
6790
|
* </tr>
|
|
6770
6791
|
* <tr>
|
|
@@ -7063,19 +7084,19 @@ declare namespace Office {
|
|
|
7063
7084
|
* </tr>
|
|
7064
7085
|
* <tr>
|
|
7065
7086
|
* <td><code>AsyncResult.value</code></td>
|
|
7066
|
-
* <td>Always returns <code>undefined</code> because there
|
|
7087
|
+
* <td>Always returns <code>undefined</code> because there's no data or object to retrieve when adding an event handler.</td>
|
|
7067
7088
|
* </tr>
|
|
7068
7089
|
* <tr>
|
|
7069
7090
|
* <td><code>AsyncResult.status</code></td>
|
|
7070
|
-
* <td>Determine the success or failure of the operation
|
|
7091
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
7071
7092
|
* </tr>
|
|
7072
7093
|
* <tr>
|
|
7073
7094
|
* <td><code>AsyncResult.error</code></td>
|
|
7074
|
-
* <td>Access an Error object that provides error information if the operation failed
|
|
7095
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
7075
7096
|
* </tr>
|
|
7076
7097
|
* <tr>
|
|
7077
7098
|
* <td><code>AsyncResult.asyncContext</code></td>
|
|
7078
|
-
* <td>Define an item of any type that
|
|
7099
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
7079
7100
|
* </tr>
|
|
7080
7101
|
* </table>
|
|
7081
7102
|
*/
|
|
@@ -7104,19 +7125,19 @@ declare namespace Office {
|
|
|
7104
7125
|
* </tr>
|
|
7105
7126
|
* <tr>
|
|
7106
7127
|
* <td><code>AsyncResult.value</code></td>
|
|
7107
|
-
* <td>Always returns <code>undefined</code> because there
|
|
7128
|
+
* <td>Always returns <code>undefined</code> because there's no data or object to retrieve when adding an event handler.</td>
|
|
7108
7129
|
* </tr>
|
|
7109
7130
|
* <tr>
|
|
7110
7131
|
* <td><code>AsyncResult.status</code></td>
|
|
7111
|
-
* <td>Determine the success or failure of the operation
|
|
7132
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
7112
7133
|
* </tr>
|
|
7113
7134
|
* <tr>
|
|
7114
7135
|
* <td><code>AsyncResult.error</code></td>
|
|
7115
|
-
* <td>Access an Error object that provides error information if the operation failed
|
|
7136
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
7116
7137
|
* </tr>
|
|
7117
7138
|
* <tr>
|
|
7118
7139
|
* <td><code>AsyncResult.asyncContext</code></td>
|
|
7119
|
-
* <td>Define an item of any type that
|
|
7140
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
7120
7141
|
* </tr>
|
|
7121
7142
|
* </table>
|
|
7122
7143
|
*/
|
|
@@ -7155,19 +7176,19 @@ declare namespace Office {
|
|
|
7155
7176
|
* </tr>
|
|
7156
7177
|
* <tr>
|
|
7157
7178
|
* <td><code>AsyncResult.value</code></td>
|
|
7158
|
-
* <td>Access a Settings object with the refreshed values
|
|
7179
|
+
* <td>Access a Settings object with the refreshed values.</td>
|
|
7159
7180
|
* </tr>
|
|
7160
7181
|
* <tr>
|
|
7161
7182
|
* <td><code>AsyncResult.status</code></td>
|
|
7162
|
-
* <td>Determine the success or failure of the operation
|
|
7183
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
7163
7184
|
* </tr>
|
|
7164
7185
|
* <tr>
|
|
7165
7186
|
* <td><code>AsyncResult.error</code></td>
|
|
7166
|
-
* <td>Access an Error object that provides error information if the operation failed
|
|
7187
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
7167
7188
|
* </tr>
|
|
7168
7189
|
* <tr>
|
|
7169
7190
|
* <td><code>AsyncResult.asyncContext</code></td>
|
|
7170
|
-
* <td>Define an item of any type that
|
|
7191
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
7171
7192
|
* </tr>
|
|
7172
7193
|
* </table>
|
|
7173
7194
|
*
|
|
@@ -7214,19 +7235,19 @@ declare namespace Office {
|
|
|
7214
7235
|
* </tr>
|
|
7215
7236
|
* <tr>
|
|
7216
7237
|
* <td><code>AsyncResult.value</code></td>
|
|
7217
|
-
* <td>Always returns <code>undefined</code> because there
|
|
7238
|
+
* <td>Always returns <code>undefined</code> because there's no data or object to retrieve when setting formats.</td>
|
|
7218
7239
|
* </tr>
|
|
7219
7240
|
* <tr>
|
|
7220
7241
|
* <td><code>AsyncResult.status</code></td>
|
|
7221
|
-
* <td>Determine the success or failure of the operation
|
|
7242
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
7222
7243
|
* </tr>
|
|
7223
7244
|
* <tr>
|
|
7224
7245
|
* <td><code>AsyncResult.error</code></td>
|
|
7225
|
-
* <td>Access an Error object that provides error information if the operation failed
|
|
7246
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
7226
7247
|
* </tr>
|
|
7227
7248
|
* <tr>
|
|
7228
7249
|
* <td><code>AsyncResult.asyncContext</code></td>
|
|
7229
|
-
* <td>Define an item of any type that
|
|
7250
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
7230
7251
|
* </tr>
|
|
7231
7252
|
* </table>
|
|
7232
7253
|
*
|
|
@@ -7258,19 +7279,19 @@ declare namespace Office {
|
|
|
7258
7279
|
* </tr>
|
|
7259
7280
|
* <tr>
|
|
7260
7281
|
* <td><code>AsyncResult.value</code></td>
|
|
7261
|
-
* <td>Always returns <code>undefined</code> because there
|
|
7282
|
+
* <td>Always returns <code>undefined</code> because there's no data or object to retrieve when setting formats.</td>
|
|
7262
7283
|
* </tr>
|
|
7263
7284
|
* <tr>
|
|
7264
7285
|
* <td><code>AsyncResult.status</code></td>
|
|
7265
|
-
* <td>Determine the success or failure of the operation
|
|
7286
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
7266
7287
|
* </tr>
|
|
7267
7288
|
* <tr>
|
|
7268
7289
|
* <td><code>AsyncResult.error</code></td>
|
|
7269
|
-
* <td>Access an Error object that provides error information if the operation failed
|
|
7290
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
7270
7291
|
* </tr>
|
|
7271
7292
|
* <tr>
|
|
7272
7293
|
* <td><code>AsyncResult.asyncContext</code></td>
|
|
7273
|
-
* <td>Define an item of any type that
|
|
7294
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
7274
7295
|
* </tr>
|
|
7275
7296
|
* </table>
|
|
7276
7297
|
*
|
|
@@ -7301,19 +7322,19 @@ declare namespace Office {
|
|
|
7301
7322
|
* </tr>
|
|
7302
7323
|
* <tr>
|
|
7303
7324
|
* <td><code>AsyncResult.value</code></td>
|
|
7304
|
-
* <td>Always returns <code>undefined</code> because there
|
|
7325
|
+
* <td>Always returns <code>undefined</code> because there's no object or data to retrieve.</td>
|
|
7305
7326
|
* </tr>
|
|
7306
7327
|
* <tr>
|
|
7307
7328
|
* <td><code>AsyncResult.status</code></td>
|
|
7308
|
-
* <td>Determine the success or failure of the operation
|
|
7329
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
7309
7330
|
* </tr>
|
|
7310
7331
|
* <tr>
|
|
7311
7332
|
* <td><code>AsyncResult.error</code></td>
|
|
7312
|
-
* <td>Access an Error object that provides error information if the operation failed
|
|
7333
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
7313
7334
|
* </tr>
|
|
7314
7335
|
* <tr>
|
|
7315
7336
|
* <td><code>AsyncResult.asyncContext</code></td>
|
|
7316
|
-
* <td>Define an item of any type that
|
|
7337
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
7317
7338
|
* </tr>
|
|
7318
7339
|
* </table>
|
|
7319
7340
|
*
|
|
@@ -7344,19 +7365,19 @@ declare namespace Office {
|
|
|
7344
7365
|
* </tr>
|
|
7345
7366
|
* <tr>
|
|
7346
7367
|
* <td><code>AsyncResult.value</code></td>
|
|
7347
|
-
* <td>Always returns <code>undefined</code> because there
|
|
7368
|
+
* <td>Always returns <code>undefined</code> because there's no object or data to retrieve.</td>
|
|
7348
7369
|
* </tr>
|
|
7349
7370
|
* <tr>
|
|
7350
7371
|
* <td><code>AsyncResult.status</code></td>
|
|
7351
|
-
* <td>Determine the success or failure of the operation
|
|
7372
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
7352
7373
|
* </tr>
|
|
7353
7374
|
* <tr>
|
|
7354
7375
|
* <td><code>AsyncResult.error</code></td>
|
|
7355
|
-
* <td>Access an Error object that provides error information if the operation failed
|
|
7376
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
7356
7377
|
* </tr>
|
|
7357
7378
|
* <tr>
|
|
7358
7379
|
* <td><code>AsyncResult.asyncContext</code></td>
|
|
7359
|
-
* <td>Define an item of any type that
|
|
7380
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
7360
7381
|
* </tr>
|
|
7361
7382
|
* </table>
|
|
7362
7383
|
*
|
|
@@ -7498,12 +7519,12 @@ declare namespace Office {
|
|
|
7498
7519
|
*
|
|
7499
7520
|
* @remarks
|
|
7500
7521
|
*
|
|
7501
|
-
* When you insert an empty table by selecting a single row in Excel
|
|
7522
|
+
* When you insert an empty table by selecting a single row in Excel on desktop and Excel on the web (using Table on the Insert tab), both Office
|
|
7502
7523
|
* applications create a single row of headers followed by a single blank row. However, if your add-in's script creates a binding for this
|
|
7503
7524
|
* newly inserted table (for example, by using the {@link Office.Bindings}.addFromSelectionAsync method), and then checks the value of the
|
|
7504
|
-
* rowCount property, the value returned will differ depending whether the spreadsheet is open in Excel
|
|
7525
|
+
* rowCount property, the value returned will differ depending whether the spreadsheet is open in Excel on desktop or Excel on the web.
|
|
7505
7526
|
*
|
|
7506
|
-
* - In Excel on the desktop, rowCount will return 0 (the blank row following the headers
|
|
7527
|
+
* - In Excel on the desktop (i.e., Windows and Mac), rowCount will return 0 (the blank row following the headers isn't counted).
|
|
7507
7528
|
*
|
|
7508
7529
|
* - In Excel on the web, rowCount will return 1 (the blank row following the headers is counted).
|
|
7509
7530
|
*
|
|
@@ -7673,15 +7694,15 @@ declare namespace Office {
|
|
|
7673
7694
|
* </tr>
|
|
7674
7695
|
* <tr>
|
|
7675
7696
|
* <td><code>{row: n}</code></td>
|
|
7676
|
-
* <td>Specifies the range that
|
|
7697
|
+
* <td>Specifies the range that's the zero-based nth row of data in the table.</td>
|
|
7677
7698
|
* </tr>
|
|
7678
7699
|
* <tr>
|
|
7679
7700
|
* <td><code>{column: n}</code></td>
|
|
7680
|
-
* <td>Specifies the range that
|
|
7701
|
+
* <td>Specifies the range that's the zero-based nth column of data in the table.</td>
|
|
7681
7702
|
* </tr>
|
|
7682
7703
|
* <tr>
|
|
7683
7704
|
* <td><code>{row: i, column: j}</code></td>
|
|
7684
|
-
* <td>Specifies the single cell that
|
|
7705
|
+
* <td>Specifies the single cell that's the ith row and jth column of the table.</td>
|
|
7685
7706
|
* </tr>
|
|
7686
7707
|
* <tr>
|
|
7687
7708
|
* <td><code>Office.Table.All</code></td>
|
|
@@ -7727,15 +7748,15 @@ declare namespace Office {
|
|
|
7727
7748
|
* </tr>
|
|
7728
7749
|
* <tr>
|
|
7729
7750
|
* <td><code>{row: n}</code></td>
|
|
7730
|
-
* <td>Specifies the range that
|
|
7751
|
+
* <td>Specifies the range that's the zero-based nth row of data in the table.</td>
|
|
7731
7752
|
* </tr>
|
|
7732
7753
|
* <tr>
|
|
7733
7754
|
* <td><code>{column: n}</code></td>
|
|
7734
|
-
* <td>Specifies the range that
|
|
7755
|
+
* <td>Specifies the range that's the zero-based nth column of data in the table.</td>
|
|
7735
7756
|
* </tr>
|
|
7736
7757
|
* <tr>
|
|
7737
7758
|
* <td><code>{row: i, column: j}</code></td>
|
|
7738
|
-
* <td>Specifies the single cell that
|
|
7759
|
+
* <td>Specifies the single cell that's the ith row and jth column of the table.</td>
|
|
7739
7760
|
* </tr>
|
|
7740
7761
|
* <tr>
|
|
7741
7762
|
* <td><code>Office.Table.All</code></td>
|
|
@@ -7784,15 +7805,15 @@ declare namespace Office {
|
|
|
7784
7805
|
* </tr>
|
|
7785
7806
|
* <tr>
|
|
7786
7807
|
* <td><code>{row: n}</code></td>
|
|
7787
|
-
* <td>Specifies the range that
|
|
7808
|
+
* <td>Specifies the range that's the zero-based nth row of data in the table.</td>
|
|
7788
7809
|
* </tr>
|
|
7789
7810
|
* <tr>
|
|
7790
7811
|
* <td><code>{column: n}</code></td>
|
|
7791
|
-
* <td>Specifies the range that
|
|
7812
|
+
* <td>Specifies the range that's the zero-based nth column of data in the table.</td>
|
|
7792
7813
|
* </tr>
|
|
7793
7814
|
* <tr>
|
|
7794
|
-
* <td
|
|
7795
|
-
* <td>Specifies the single cell that
|
|
7815
|
+
* <td><code>{row: i, column: j}</code></td>
|
|
7816
|
+
* <td>Specifies the single cell that's the ith row and jth column of the table.</td>
|
|
7796
7817
|
* </tr>
|
|
7797
7818
|
* <tr>
|
|
7798
7819
|
* <td><code>Office.Table.All</code></td>
|
|
@@ -7883,15 +7904,15 @@ declare namespace Office {
|
|
|
7883
7904
|
* </tr>
|
|
7884
7905
|
* <tr>
|
|
7885
7906
|
* <td><code>{row: n}</code></td>
|
|
7886
|
-
* <td>Specifies the range that
|
|
7907
|
+
* <td>Specifies the range that's the zero-based nth row of data in the table.</td>
|
|
7887
7908
|
* </tr>
|
|
7888
7909
|
* <tr>
|
|
7889
7910
|
* <td><code>{column: n}</code></td>
|
|
7890
|
-
* <td>Specifies the range that
|
|
7911
|
+
* <td>Specifies the range that's the zero-based nth column of data in the table.</td>
|
|
7891
7912
|
* </tr>
|
|
7892
7913
|
* <tr>
|
|
7893
7914
|
* <td><code>{row: i, column: j}</code></td>
|
|
7894
|
-
* <td>Specifies the single cell that
|
|
7915
|
+
* <td>Specifies the single cell that's the ith row and jth column of the table.</td>
|
|
7895
7916
|
* </tr>
|
|
7896
7917
|
* <tr>
|
|
7897
7918
|
* <td><code>Office.Table.All</code></td>
|
|
@@ -7973,19 +7994,19 @@ declare namespace Office {
|
|
|
7973
7994
|
* </tr>
|
|
7974
7995
|
* <tr>
|
|
7975
7996
|
* <td><code>AsyncResult.value</code></td>
|
|
7976
|
-
* <td>Always returns <code>undefined</code> because there
|
|
7997
|
+
* <td>Always returns <code>undefined</code> because there's no data or object to retrieve when setting formats.</td>
|
|
7977
7998
|
* </tr>
|
|
7978
7999
|
* <tr>
|
|
7979
8000
|
* <td><code>AsyncResult.status</code></td>
|
|
7980
|
-
* <td>Determine the success or failure of the operation
|
|
8001
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
7981
8002
|
* </tr>
|
|
7982
8003
|
* <tr>
|
|
7983
8004
|
* <td><code>AsyncResult.error</code></td>
|
|
7984
|
-
* <td>Access an Error object that provides error information if the operation failed
|
|
8005
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
7985
8006
|
* </tr>
|
|
7986
8007
|
* <tr>
|
|
7987
8008
|
* <td><code>AsyncResult.asyncContext</code></td>
|
|
7988
|
-
* <td>Define an item of any type that
|
|
8009
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
7989
8010
|
* </tr>
|
|
7990
8011
|
* </table>
|
|
7991
8012
|
*
|
|
@@ -8011,19 +8032,19 @@ declare namespace Office {
|
|
|
8011
8032
|
* </tr>
|
|
8012
8033
|
* <tr>
|
|
8013
8034
|
* <td><code>AsyncResult.value</code></td>
|
|
8014
|
-
* <td>Always returns <code>undefined</code> because there
|
|
8035
|
+
* <td>Always returns <code>undefined</code> because there's no data or object to retrieve when setting formats.</td>
|
|
8015
8036
|
* </tr>
|
|
8016
8037
|
* <tr>
|
|
8017
8038
|
* <td><code>AsyncResult.status</code></td>
|
|
8018
|
-
* <td>Determine the success or failure of the operation
|
|
8039
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
8019
8040
|
* </tr>
|
|
8020
8041
|
* <tr>
|
|
8021
8042
|
* <td><code>AsyncResult.error</code></td>
|
|
8022
|
-
* <td>Access an Error object that provides error information if the operation failed
|
|
8043
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
8023
8044
|
* </tr>
|
|
8024
8045
|
* <tr>
|
|
8025
8046
|
* <td><code>AsyncResult.asyncContext</code></td>
|
|
8026
|
-
* <td>Define an item of any type that
|
|
8047
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
8027
8048
|
* </tr>
|
|
8028
8049
|
* </table>
|
|
8029
8050
|
*
|
|
@@ -8170,7 +8191,7 @@ declare namespace Office {
|
|
|
8170
8191
|
* </tr>
|
|
8171
8192
|
* <tr>
|
|
8172
8193
|
* <td>12004</td>
|
|
8173
|
-
* <td>The domain of the URL passed to displayDialogAsync
|
|
8194
|
+
* <td>The domain of the URL passed to displayDialogAsync isn't trusted. The domain must be either the same domain as the host page (including protocol and port number), or it must be registered in the <code>AppDomains</code> section of the add-in manifest.</td>
|
|
8174
8195
|
* </tr>
|
|
8175
8196
|
* <tr>
|
|
8176
8197
|
* <td>12005</td>
|
|
@@ -8196,23 +8217,23 @@ declare namespace Office {
|
|
|
8196
8217
|
* </tr>
|
|
8197
8218
|
* <tr>
|
|
8198
8219
|
* <td><code>AsyncResult.value</code></td>
|
|
8199
|
-
* <td>Access the Dialog object
|
|
8220
|
+
* <td>Access the Dialog object.</td>
|
|
8200
8221
|
* </tr>
|
|
8201
8222
|
* <tr>
|
|
8202
8223
|
* <td><code>AsyncResult.status</code></td>
|
|
8203
|
-
* <td>Determine the success or failure of the operation
|
|
8224
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
8204
8225
|
* </tr>
|
|
8205
8226
|
* <tr>
|
|
8206
8227
|
* <td><code>AsyncResult.error</code></td>
|
|
8207
|
-
* <td>Access an Error object that provides error information if the operation failed
|
|
8228
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
8208
8229
|
* </tr>
|
|
8209
8230
|
* <tr>
|
|
8210
8231
|
* <td><code>AsyncResult.asyncContext</code></td>
|
|
8211
|
-
* <td>Access your user-defined object or value, if you passed one as the asyncContext parameter
|
|
8232
|
+
* <td>Access your user-defined object or value, if you passed one as the asyncContext parameter.</td>
|
|
8212
8233
|
* </tr>
|
|
8213
8234
|
* </table>
|
|
8214
8235
|
*
|
|
8215
|
-
* @param startAddress - Accepts the initial full HTTPS URL that opens in the dialog. Relative URLs
|
|
8236
|
+
* @param startAddress - Accepts the initial full HTTPS URL that opens in the dialog. Relative URLs mustn't be used.
|
|
8216
8237
|
* @param options - Optional. Accepts an {@link Office.DialogOptions} object to define dialog display.
|
|
8217
8238
|
* @param callback - Optional. Accepts a callback function to handle the dialog creation attempt. If successful, the AsyncResult.value is a Dialog object.
|
|
8218
8239
|
*/
|
|
@@ -8271,7 +8292,7 @@ declare namespace Office {
|
|
|
8271
8292
|
* </tr>
|
|
8272
8293
|
* <tr>
|
|
8273
8294
|
* <td>12004</td>
|
|
8274
|
-
* <td>The domain of the URL passed to displayDialogAsync
|
|
8295
|
+
* <td>The domain of the URL passed to displayDialogAsync isn't trusted. The domain must be either the same domain as the host page (including protocol and port number), or it must be registered in the <code>AppDomains</code> section of the add-in manifest.</td>
|
|
8275
8296
|
* </tr>
|
|
8276
8297
|
* <tr>
|
|
8277
8298
|
* <td>12005</td>
|
|
@@ -8297,23 +8318,23 @@ declare namespace Office {
|
|
|
8297
8318
|
* </tr>
|
|
8298
8319
|
* <tr>
|
|
8299
8320
|
* <td><code>AsyncResult.value</code></td>
|
|
8300
|
-
* <td>Access the Dialog object
|
|
8321
|
+
* <td>Access the Dialog object.</td>
|
|
8301
8322
|
* </tr>
|
|
8302
8323
|
* <tr>
|
|
8303
8324
|
* <td><code>AsyncResult.status</code></td>
|
|
8304
|
-
* <td>Determine the success or failure of the operation
|
|
8325
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
8305
8326
|
* </tr>
|
|
8306
8327
|
* <tr>
|
|
8307
8328
|
* <td><code>AsyncResult.error</code></td>
|
|
8308
|
-
* <td>Access an Error object that provides error information if the operation failed
|
|
8329
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
8309
8330
|
* </tr>
|
|
8310
8331
|
* <tr>
|
|
8311
8332
|
* <td><code>AsyncResult.asyncContext</code></td>
|
|
8312
|
-
* <td>Access your user-defined object or value, if you passed one as the asyncContext parameter
|
|
8333
|
+
* <td>Access your user-defined object or value, if you passed one as the asyncContext parameter.</td>
|
|
8313
8334
|
* </tr>
|
|
8314
8335
|
* </table>
|
|
8315
8336
|
*
|
|
8316
|
-
* @param startAddress - Accepts the initial full HTTPS URL that opens in the dialog. Relative URLs
|
|
8337
|
+
* @param startAddress - Accepts the initial full HTTPS URL that opens in the dialog. Relative URLs mustn't be used.
|
|
8317
8338
|
* @param callback - Optional. Accepts a callback function to handle the dialog creation attempt. If successful, the AsyncResult.value is a Dialog object.
|
|
8318
8339
|
*/
|
|
8319
8340
|
displayDialogAsync(startAddress: string, callback?: (result: AsyncResult<Dialog>) => void): void;
|
|
@@ -8484,7 +8505,7 @@ declare namespace Office {
|
|
|
8484
8505
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
8485
8506
|
*
|
|
8486
8507
|
* **Important**: The actual color depends on how the Outlook client renders it.
|
|
8487
|
-
* In this case, the colors noted on each preset apply to Outlook on
|
|
8508
|
+
* In this case, the colors noted on each preset apply to Outlook on the web, on Windows,
|
|
8488
8509
|
* and on Mac (starting in Version 16.78).
|
|
8489
8510
|
*
|
|
8490
8511
|
* Earlier versions of Outlook on Mac had a bug that displayed incorrect preset colors.
|
|
@@ -8992,7 +9013,7 @@ declare namespace Office {
|
|
|
8992
9013
|
/**
|
|
8993
9014
|
* Specifies the recipient is an SMTP email address that isn't on the Exchange server. It also refers to a recipient added from a personal Outlook address book.
|
|
8994
9015
|
*
|
|
8995
|
-
* **Important**: In Outlook on Windows (starting with Version 2210 (Build 15813.20002)),
|
|
9016
|
+
* **Important**: In Outlook on the web, on Windows (starting with Version 2210 (Build 15813.20002)), and on Mac, Global Address Book (GAL) recipients saved to a personal address book return
|
|
8996
9017
|
* the `ExternalUser` value, even if their SMTP email address appears on the Exchange server. Recipients return a `User` value only if they're directly
|
|
8997
9018
|
* added or resolved against the GAL.
|
|
8998
9019
|
*/
|
|
@@ -9878,7 +9899,7 @@ declare namespace Office {
|
|
|
9878
9899
|
/**
|
|
9879
9900
|
* Gets the ID of the series that an instance belongs to.
|
|
9880
9901
|
*
|
|
9881
|
-
* In Outlook on the web and desktop clients, the `seriesId` property returns the Exchange Web Services (EWS) ID of the parent (series) item
|
|
9902
|
+
* In Outlook on the web and on desktop clients, the `seriesId` property returns the Exchange Web Services (EWS) ID of the parent (series) item
|
|
9882
9903
|
* that this item belongs to. However, on iOS and Android, the seriesId returns the REST ID of the parent item.
|
|
9883
9904
|
*
|
|
9884
9905
|
* **Note**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier.
|
|
@@ -10275,7 +10296,7 @@ declare namespace Office {
|
|
|
10275
10296
|
*
|
|
10276
10297
|
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
10277
10298
|
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
10278
|
-
* In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
|
|
10299
|
+
* In Outlook on the web and on mobile devices, the attachment identifier is valid only within the same session.
|
|
10279
10300
|
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
10280
10301
|
* continue in a separate window.
|
|
10281
10302
|
*
|
|
@@ -10306,7 +10327,7 @@ declare namespace Office {
|
|
|
10306
10327
|
*
|
|
10307
10328
|
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
10308
10329
|
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
10309
|
-
* In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
|
|
10330
|
+
* In Outlook on the web and on mobile devices, the attachment identifier is valid only within the same session.
|
|
10310
10331
|
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
10311
10332
|
* continue in a separate window.
|
|
10312
10333
|
*
|
|
@@ -10511,7 +10532,7 @@ declare namespace Office {
|
|
|
10511
10532
|
*
|
|
10512
10533
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10513
10534
|
*
|
|
10514
|
-
*
|
|
10535
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
10515
10536
|
*
|
|
10516
10537
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
10517
10538
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -10532,7 +10553,7 @@ declare namespace Office {
|
|
|
10532
10553
|
*
|
|
10533
10554
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10534
10555
|
*
|
|
10535
|
-
*
|
|
10556
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
10536
10557
|
*
|
|
10537
10558
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
10538
10559
|
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
@@ -10544,7 +10565,7 @@ declare namespace Office {
|
|
|
10544
10565
|
* For Windows and Mac rich clients, the API call should return `true` if the default signature for new messages, replies, or forwards is set
|
|
10545
10566
|
* to a template for the sending Outlook account.
|
|
10546
10567
|
* For Outlook on the web, the API call should return `true` if the signature is enabled for compose types `newMail`, `reply`, or `forward`.
|
|
10547
|
-
* If the settings are set to "(none)" in Mac or Windows rich clients or disabled in Outlook on the
|
|
10568
|
+
* If the settings are set to "(none)" in Mac or Windows rich clients or disabled in Outlook on the web, the API call should return `false`.
|
|
10548
10569
|
*
|
|
10549
10570
|
* @remarks
|
|
10550
10571
|
* [Api set: Mailbox 1.10]
|
|
@@ -10565,7 +10586,7 @@ declare namespace Office {
|
|
|
10565
10586
|
* For Windows and Mac rich clients, the API call should return `true` if the default signature for new messages, replies, or forwards is set
|
|
10566
10587
|
* to a template for the sending Outlook account.
|
|
10567
10588
|
* For Outlook on the web, the API call should return `true` if the signature is enabled for compose types `newMail`, `reply`, or `forward`.
|
|
10568
|
-
* If the settings are set to "(none)" in Mac or Windows rich clients or disabled in Outlook on the
|
|
10589
|
+
* If the settings are set to "(none)" in Mac or Windows rich clients or disabled in Outlook on the web, the API call should return `false`.
|
|
10569
10590
|
*
|
|
10570
10591
|
* @remarks
|
|
10571
10592
|
* [Api set: Mailbox 1.10]
|
|
@@ -10609,7 +10630,7 @@ declare namespace Office {
|
|
|
10609
10630
|
*
|
|
10610
10631
|
* The `removeAttachmentAsync` method removes the attachment with the specified identifier from the item.
|
|
10611
10632
|
* As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment
|
|
10612
|
-
* in the same session. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
|
|
10633
|
+
* in the same session. In Outlook on the web and on mobile devices, the attachment identifier is valid only within the same session.
|
|
10613
10634
|
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
10614
10635
|
* continue in a separate window.
|
|
10615
10636
|
*
|
|
@@ -10638,7 +10659,7 @@ declare namespace Office {
|
|
|
10638
10659
|
*
|
|
10639
10660
|
* The `removeAttachmentAsync` method removes the attachment with the specified identifier from the item.
|
|
10640
10661
|
* As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment
|
|
10641
|
-
* in the same session. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
|
|
10662
|
+
* in the same session. In Outlook on the web and on mobile devices, the attachment identifier is valid only within the same session.
|
|
10642
10663
|
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
10643
10664
|
* continue in a separate window.
|
|
10644
10665
|
*
|
|
@@ -10796,7 +10817,7 @@ declare namespace Office {
|
|
|
10796
10817
|
* If more than 1,000,000 characters are passed in, an `ArgumentOutOfRange` exception is thrown.
|
|
10797
10818
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
10798
10819
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
10799
|
-
* `coercionType`: If text, the current style is applied in Outlook on the web and Windows.
|
|
10820
|
+
* `coercionType`: If text, the current style is applied in Outlook on the web and on Windows.
|
|
10800
10821
|
* If the field is an HTML editor, only the text data is inserted, even if the data is HTML.
|
|
10801
10822
|
* If html and the field supports HTML (the subject doesn't), the current style is applied in Outlook on the web and the
|
|
10802
10823
|
* default style is applied in Outlook on desktop clients.
|
|
@@ -10903,12 +10924,12 @@ declare namespace Office {
|
|
|
10903
10924
|
* The `optionalAttendees` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
|
|
10904
10925
|
* each optional attendee to the meeting. Collection size limits:
|
|
10905
10926
|
*
|
|
10927
|
+
* - Web browser, new Mac UI, Android: No limit
|
|
10928
|
+
*
|
|
10906
10929
|
* - Windows: 500 members
|
|
10907
10930
|
*
|
|
10908
10931
|
* - Classic Mac UI: 100 members
|
|
10909
10932
|
*
|
|
10910
|
-
* - New Mac UI, web browser, Android: No limit
|
|
10911
|
-
*
|
|
10912
10933
|
* *Compose mode*
|
|
10913
10934
|
*
|
|
10914
10935
|
* The `optionalAttendees` property returns a `Recipients` object that provides methods to get or update the
|
|
@@ -10940,12 +10961,12 @@ declare namespace Office {
|
|
|
10940
10961
|
* The `requiredAttendees` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
|
|
10941
10962
|
* each required attendee to the meeting. Collection size limits:
|
|
10942
10963
|
*
|
|
10964
|
+
* - Web browser, new Mac UI, Android: No limit
|
|
10965
|
+
*
|
|
10943
10966
|
* - Windows: 500 members
|
|
10944
10967
|
*
|
|
10945
10968
|
* - Classic Mac UI: 100 members
|
|
10946
10969
|
*
|
|
10947
|
-
* - New Mac UI, web browser, Android: No limit
|
|
10948
|
-
*
|
|
10949
10970
|
* *Compose mode*
|
|
10950
10971
|
*
|
|
10951
10972
|
* The `requiredAttendees` property returns a `Recipients` object that provides methods to get or update the
|
|
@@ -11274,7 +11295,7 @@ declare namespace Office {
|
|
|
11274
11295
|
/**
|
|
11275
11296
|
* Gets the ID of the series that an instance belongs to.
|
|
11276
11297
|
*
|
|
11277
|
-
* In Outlook on the web and desktop clients, the `seriesId` returns the Exchange Web Services (EWS) ID of the parent (series) item
|
|
11298
|
+
* In Outlook on the web and on desktop clients, the `seriesId` returns the Exchange Web Services (EWS) ID of the parent (series) item
|
|
11278
11299
|
* that this item belongs to. However, on iOS and Android, the seriesId returns the REST ID of the parent item.
|
|
11279
11300
|
*
|
|
11280
11301
|
* **Note**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier.
|
|
@@ -11388,7 +11409,7 @@ declare namespace Office {
|
|
|
11388
11409
|
* When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
11389
11410
|
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
11390
11411
|
*
|
|
11391
|
-
* **Note**: This method
|
|
11412
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
11392
11413
|
*
|
|
11393
11414
|
* @remarks
|
|
11394
11415
|
* [Api set: Mailbox 1.9]
|
|
@@ -11416,7 +11437,7 @@ declare namespace Office {
|
|
|
11416
11437
|
* When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
11417
11438
|
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
11418
11439
|
*
|
|
11419
|
-
* **Note**: This method
|
|
11440
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
11420
11441
|
*
|
|
11421
11442
|
* @remarks
|
|
11422
11443
|
* [Api set: Mailbox 1.9]
|
|
@@ -11467,7 +11488,7 @@ declare namespace Office {
|
|
|
11467
11488
|
* When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
11468
11489
|
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
11469
11490
|
*
|
|
11470
|
-
* **Note**: This method
|
|
11491
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
11471
11492
|
*
|
|
11472
11493
|
* @remarks
|
|
11473
11494
|
* [Api set: Mailbox 1.9]
|
|
@@ -11494,7 +11515,7 @@ declare namespace Office {
|
|
|
11494
11515
|
* When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
11495
11516
|
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
11496
11517
|
*
|
|
11497
|
-
* **Note**: This method
|
|
11518
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
11498
11519
|
*
|
|
11499
11520
|
* @remarks
|
|
11500
11521
|
* [Api set: Mailbox 1.9]
|
|
@@ -11514,7 +11535,7 @@ declare namespace Office {
|
|
|
11514
11535
|
*
|
|
11515
11536
|
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
11516
11537
|
* the attachment's identifier from an {@link Office.AppointmentRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
11517
|
-
* to retrieve the attachment. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
|
|
11538
|
+
* to retrieve the attachment. In Outlook on the web and on mobile devices, the attachment identifier is valid only within the same session.
|
|
11518
11539
|
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
11519
11540
|
* continue in a separate window.
|
|
11520
11541
|
*
|
|
@@ -11545,7 +11566,7 @@ declare namespace Office {
|
|
|
11545
11566
|
*
|
|
11546
11567
|
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
11547
11568
|
* the attachment's identifier from an {@link Office.AppointmentRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
11548
|
-
* to retrieve the attachment. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
|
|
11569
|
+
* to retrieve the attachment. In Outlook on the web and on mobile devices, the attachment identifier is valid only within the same session.
|
|
11549
11570
|
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
11550
11571
|
* continue in a separate window.
|
|
11551
11572
|
*
|
|
@@ -11629,7 +11650,7 @@ declare namespace Office {
|
|
|
11629
11650
|
* <tr>
|
|
11630
11651
|
* <th>Value of entityType</th>
|
|
11631
11652
|
* <th>Type of objects in returned array</th>
|
|
11632
|
-
* <th>Required
|
|
11653
|
+
* <th>Required permission level</th>
|
|
11633
11654
|
* </tr>
|
|
11634
11655
|
* <tr>
|
|
11635
11656
|
* <td>Address</td>
|
|
@@ -11889,7 +11910,7 @@ declare namespace Office {
|
|
|
11889
11910
|
*
|
|
11890
11911
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11891
11912
|
*
|
|
11892
|
-
* **Note**: This method
|
|
11913
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
11893
11914
|
*
|
|
11894
11915
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
11895
11916
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -11910,7 +11931,7 @@ declare namespace Office {
|
|
|
11910
11931
|
*
|
|
11911
11932
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11912
11933
|
*
|
|
11913
|
-
* **Note**: This method
|
|
11934
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
11914
11935
|
*
|
|
11915
11936
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
11916
11937
|
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
@@ -12071,7 +12092,7 @@ declare namespace Office {
|
|
|
12071
12092
|
* Gets the name of the attachment.
|
|
12072
12093
|
*
|
|
12073
12094
|
* **Important**: For message or appointment items that were attached by drag-and-drop or "Attach Item",
|
|
12074
|
-
* `name` includes a file extension in Outlook on Mac, but excludes the extension on the web or Windows.
|
|
12095
|
+
* `name` includes a file extension in Outlook on Mac, but excludes the extension on the web or on Windows.
|
|
12075
12096
|
*/
|
|
12076
12097
|
name: string;
|
|
12077
12098
|
/**
|
|
@@ -12123,7 +12144,7 @@ declare namespace Office {
|
|
|
12123
12144
|
* Gets the name of the attachment.
|
|
12124
12145
|
*
|
|
12125
12146
|
* **Important**: For message or appointment items that were attached by drag-and-drop or "Attach Item",
|
|
12126
|
-
* `name` includes a file extension in Outlook on Mac, but excludes the extension on the web or Windows.
|
|
12147
|
+
* `name` includes a file extension in Outlook on Mac, but excludes the extension on the web or on Windows.
|
|
12127
12148
|
*/
|
|
12128
12149
|
name: string;
|
|
12129
12150
|
/**
|
|
@@ -12355,7 +12376,7 @@ declare namespace Office {
|
|
|
12355
12376
|
*
|
|
12356
12377
|
* **Important**:
|
|
12357
12378
|
*
|
|
12358
|
-
* - After the content is prepended, the position of the cursor depends on which client the add-in is running. In Outlook on
|
|
12379
|
+
* - After the content is prepended, the position of the cursor depends on which client the add-in is running. In Outlook on the web and on Windows, the cursor
|
|
12359
12380
|
* position remains the same in the pre-existing content of the body. For example, if the cursor was positioned at the beginning of the body prior to the
|
|
12360
12381
|
* `prependAsync` call, it will appear between the prepended content and the pre-existing content of the body after the call. In Outlook on Mac, the cursor
|
|
12361
12382
|
* position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the user selects something in the body of the mail item.
|
|
@@ -12397,7 +12418,7 @@ declare namespace Office {
|
|
|
12397
12418
|
*
|
|
12398
12419
|
* **Important**:
|
|
12399
12420
|
*
|
|
12400
|
-
* - After the content is prepended, the position of the cursor depends on which client the add-in is running. In Outlook on
|
|
12421
|
+
* - After the content is prepended, the position of the cursor depends on which client the add-in is running. In Outlook on the web and on Windows, the cursor
|
|
12401
12422
|
* position remains the same in the pre-existing content of the body. For example, if the cursor was positioned at the beginning of the body prior to the
|
|
12402
12423
|
* `prependAsync` call, it will appear between the prepended content and the pre-existing content of the body after the call. In Outlook on Mac, the cursor
|
|
12403
12424
|
* position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the user selects something in the body of the mail item.
|
|
@@ -14111,7 +14132,7 @@ declare namespace Office {
|
|
|
14111
14132
|
* **Note**: The "Outlook" value is returned for Outlook on desktop clients (i.e., Windows and Mac).
|
|
14112
14133
|
*
|
|
14113
14134
|
* - `hostVersion` (string): A string that represents the version of either the Office application or the Exchange Server (e.g., "15.0.468.0").
|
|
14114
|
-
* If the mail add-in is running in Outlook on desktop or mobile clients, the `hostVersion` property returns the version of the
|
|
14135
|
+
* If the mail add-in is running in Outlook on desktop or on mobile clients, the `hostVersion` property returns the version of the
|
|
14115
14136
|
* application, Outlook. In Outlook on the web, the property returns the version of the Exchange Server.
|
|
14116
14137
|
*
|
|
14117
14138
|
* - `OWAView` (`MailboxEnums.OWAView` or string): An enum (or string literal) that represents the current view of Outlook on the web.
|
|
@@ -14276,7 +14297,7 @@ declare namespace Office {
|
|
|
14276
14297
|
/**
|
|
14277
14298
|
* Gets a dictionary containing time information in local client time.
|
|
14278
14299
|
*
|
|
14279
|
-
* The dates and times used by a mail app for Outlook on the web or desktop clients can use different time zones.
|
|
14300
|
+
* The dates and times used by a mail app for Outlook on the web or on desktop clients can use different time zones.
|
|
14280
14301
|
* Outlook uses the client computer time zone; Outlook on the web uses the time zone set on the Exchange Admin Center (EAC).
|
|
14281
14302
|
* You should handle date and time values so that the values you display on the user interface are always consistent with the time zone that
|
|
14282
14303
|
* the user expects.
|
|
@@ -14380,7 +14401,7 @@ declare namespace Office {
|
|
|
14380
14401
|
* If the specified item identifier does not identify an existing appointment, a blank pane opens on the client computer or device, and
|
|
14381
14402
|
* no error message is returned.
|
|
14382
14403
|
*
|
|
14383
|
-
* **Note**: This method
|
|
14404
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
14384
14405
|
*
|
|
14385
14406
|
* @remarks
|
|
14386
14407
|
* [Api set: Mailbox 1.9]
|
|
@@ -14411,7 +14432,7 @@ declare namespace Office {
|
|
|
14411
14432
|
* If the specified item identifier does not identify an existing appointment, a blank pane opens on the client computer or device, and
|
|
14412
14433
|
* no error message is returned.
|
|
14413
14434
|
*
|
|
14414
|
-
* **Note**: This method
|
|
14435
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
14415
14436
|
*
|
|
14416
14437
|
* @remarks
|
|
14417
14438
|
* [Api set: Mailbox 1.9]
|
|
@@ -14463,11 +14484,11 @@ declare namespace Office {
|
|
|
14463
14484
|
* If the specified item identifier does not identify an existing message, no message will be displayed on the client computer, and
|
|
14464
14485
|
* no error message is returned.
|
|
14465
14486
|
*
|
|
14466
|
-
*
|
|
14487
|
+
* Don't use the `displayMessageForm` or `displayMessageFormAsync` method with an itemId that represents an appointment.
|
|
14467
14488
|
* Use the `displayAppointmentForm` or `displayAppointmentFormAsync` method to display an existing appointment,
|
|
14468
14489
|
* and `displayNewAppointmentForm` or `displayNewAppointmentFormAsync` to display a form to create a new appointment.
|
|
14469
14490
|
*
|
|
14470
|
-
* **Note**: This method
|
|
14491
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
14471
14492
|
*
|
|
14472
14493
|
* @remarks
|
|
14473
14494
|
* [Api set: Mailbox 1.9]
|
|
@@ -14493,11 +14514,11 @@ declare namespace Office {
|
|
|
14493
14514
|
* If the specified item identifier does not identify an existing message, no message will be displayed on the client computer, and
|
|
14494
14515
|
* no error message is returned.
|
|
14495
14516
|
*
|
|
14496
|
-
*
|
|
14517
|
+
* Don't use the `displayMessageForm` or `displayMessageFormAsync` method with an itemId that represents an appointment.
|
|
14497
14518
|
* Use the `displayAppointmentForm` or `displayAppointmentFormAsync` method to display an existing appointment,
|
|
14498
14519
|
* and `displayNewAppointmentForm` or `displayNewAppointmentFormAsync` to display a form to create a new appointment.
|
|
14499
14520
|
*
|
|
14500
|
-
* **Note**: This method
|
|
14521
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
14501
14522
|
*
|
|
14502
14523
|
* @remarks
|
|
14503
14524
|
* [Api set: Mailbox 1.9]
|
|
@@ -14556,7 +14577,7 @@ declare namespace Office {
|
|
|
14556
14577
|
*
|
|
14557
14578
|
* If any of the parameters exceed the specified size limits, or if an unknown parameter name is specified, an exception is thrown.
|
|
14558
14579
|
*
|
|
14559
|
-
* **Note**: This method
|
|
14580
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
14560
14581
|
*
|
|
14561
14582
|
* @remarks
|
|
14562
14583
|
* [Api set: Mailbox 1.9]
|
|
@@ -14588,7 +14609,7 @@ declare namespace Office {
|
|
|
14588
14609
|
*
|
|
14589
14610
|
* If any of the parameters exceed the specified size limits, or if an unknown parameter name is specified, an exception is thrown.
|
|
14590
14611
|
*
|
|
14591
|
-
* **Note**: This method
|
|
14612
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
14592
14613
|
*
|
|
14593
14614
|
* @remarks
|
|
14594
14615
|
* [Api set: Mailbox 1.9]
|
|
@@ -14779,7 +14800,7 @@ declare namespace Office {
|
|
|
14779
14800
|
* - EWS operations aren't supported in add-ins running in Outlook on iOS and on Android. A REST token is always returned in Outlook
|
|
14780
14801
|
* mobile clients even if `options.isRest` is set to `false`.
|
|
14781
14802
|
*
|
|
14782
|
-
|
|
14803
|
+
* - Calling the `getCallbackTokenAsync` method in read mode requires a minimum permission level of **read item**.
|
|
14783
14804
|
*
|
|
14784
14805
|
* - Calling the `getCallbackTokenAsync` method in compose mode requires you to have saved the item.
|
|
14785
14806
|
* The `saveAsync` method requires a minimum permission level of **read/write item**.
|
|
@@ -14873,7 +14894,7 @@ declare namespace Office {
|
|
|
14873
14894
|
* - Calling the `getCallbackTokenAsync` method in compose mode requires you to have saved the item.
|
|
14874
14895
|
* The `saveAsync` method requires a minimum permission level of **read/write item**.
|
|
14875
14896
|
*
|
|
14876
|
-
* - This method isn't supported in Outlook on Android or on iOS. EWS operations aren't supported in add-ins running
|
|
14897
|
+
* - This method isn't supported in Outlook on Android or on iOS. EWS operations aren't supported in add-ins running in Outlook on mobile clients.
|
|
14877
14898
|
* For more information on supported APIs in Outlook mobile, see
|
|
14878
14899
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14879
14900
|
*
|
|
@@ -15474,7 +15495,7 @@ declare namespace Office {
|
|
|
15474
15495
|
/**
|
|
15475
15496
|
* Gets the ID of the series that an instance belongs to.
|
|
15476
15497
|
*
|
|
15477
|
-
* In Outlook on the web and desktop clients, the `seriesId` returns the Exchange Web Services (EWS) ID of the parent (series) item
|
|
15498
|
+
* In Outlook on the web and on desktop clients, the `seriesId` returns the Exchange Web Services (EWS) ID of the parent (series) item
|
|
15478
15499
|
* that this item belongs to. However, on iOS and Android, the seriesId returns the REST ID of the parent item.
|
|
15479
15500
|
*
|
|
15480
15501
|
* **Note**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier.
|
|
@@ -15829,12 +15850,12 @@ declare namespace Office {
|
|
|
15829
15850
|
*
|
|
15830
15851
|
* The behavior of this method depends on which client the add-in is running.
|
|
15831
15852
|
*
|
|
15832
|
-
* - In Outlook on Windows and on Mac, the signature under the **New messages** and **Replies/forwards** sections
|
|
15833
|
-
* of the sending account is set to **(none)**.
|
|
15834
|
-
*
|
|
15835
15853
|
* - In Outlook on the web, the signature option for new mails, replies, and forwards is disabled.
|
|
15836
15854
|
* A signature that's selected is also disabled by the method.
|
|
15837
15855
|
*
|
|
15856
|
+
* - In Outlook on Windows and on Mac, the signature under the **New messages** and **Replies/forwards** sections
|
|
15857
|
+
* of the sending account is set to **(none)**.
|
|
15858
|
+
*
|
|
15838
15859
|
* - In Outlook on Android and on iOS, the signature saved on the mobile device is cleared.
|
|
15839
15860
|
*
|
|
15840
15861
|
* @remarks
|
|
@@ -15859,12 +15880,12 @@ declare namespace Office {
|
|
|
15859
15880
|
*
|
|
15860
15881
|
* The behavior of this method depends on which client the add-in is running.
|
|
15861
15882
|
*
|
|
15862
|
-
* - In Outlook on Windows and on Mac, the signature under the **New messages** and **Replies/forwards** sections
|
|
15863
|
-
* of the sending account is set to **(none)**.
|
|
15864
|
-
*
|
|
15865
15883
|
* - In Outlook on the web, the signature option for new mails, replies, and forwards is disabled.
|
|
15866
15884
|
* A signature that's selected is also disabled by the method.
|
|
15867
15885
|
*
|
|
15886
|
+
* - In Outlook on Windows and on Mac, the signature under the **New messages** and **Replies/forwards** sections
|
|
15887
|
+
* of the sending account is set to **(none)**.
|
|
15888
|
+
*
|
|
15868
15889
|
* - In Outlook on Android and on iOS, the signature saved on the mobile device is cleared.
|
|
15869
15890
|
*
|
|
15870
15891
|
* @remarks
|
|
@@ -15887,7 +15908,7 @@ declare namespace Office {
|
|
|
15887
15908
|
*
|
|
15888
15909
|
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
15889
15910
|
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
15890
|
-
* In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
|
|
15911
|
+
* In Outlook on the web and on mobile devices, the attachment identifier is valid only within the same session.
|
|
15891
15912
|
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
15892
15913
|
* continue in a separate window.
|
|
15893
15914
|
*
|
|
@@ -15918,7 +15939,7 @@ declare namespace Office {
|
|
|
15918
15939
|
*
|
|
15919
15940
|
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
15920
15941
|
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
15921
|
-
* In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
|
|
15942
|
+
* In Outlook on the web and on mobile devices, the attachment identifier is valid only within the same session.
|
|
15922
15943
|
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
15923
15944
|
* continue in a separate window.
|
|
15924
15945
|
*
|
|
@@ -16171,9 +16192,9 @@ declare namespace Office {
|
|
|
16171
16192
|
*
|
|
16172
16193
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16173
16194
|
*
|
|
16174
|
-
* **Note**: This method
|
|
16195
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
16175
16196
|
*
|
|
16176
|
-
* **Important**: In Message Compose mode, this API
|
|
16197
|
+
* **Important**: In Message Compose mode, this API isn't supported in Outlook on the web or on Windows unless the following conditions are met.
|
|
16177
16198
|
*
|
|
16178
16199
|
* a. **Delegate access/Shared folders**
|
|
16179
16200
|
*
|
|
@@ -16213,9 +16234,9 @@ declare namespace Office {
|
|
|
16213
16234
|
*
|
|
16214
16235
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16215
16236
|
*
|
|
16216
|
-
* **Note**: This method
|
|
16237
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
16217
16238
|
*
|
|
16218
|
-
* **Important**: In Message Compose mode, this API
|
|
16239
|
+
* **Important**: In Message Compose mode, this API isn't supported in Outlook on the web or on Windows unless the following conditions are met.
|
|
16219
16240
|
*
|
|
16220
16241
|
* a. **Delegate access/Shared folders**
|
|
16221
16242
|
*
|
|
@@ -16246,7 +16267,7 @@ declare namespace Office {
|
|
|
16246
16267
|
* For Windows and Mac rich clients, the API call should return `true` if the default signature for new messages, replies, or forwards is set
|
|
16247
16268
|
* to a template for the sending Outlook account.
|
|
16248
16269
|
* For Outlook on the web, the API call should return `true` if the signature is enabled for compose types `newMail`, `reply`, or `forward`.
|
|
16249
|
-
* If the settings are set to "(none)" in Mac or Windows rich clients or disabled in Outlook on the
|
|
16270
|
+
* If the settings are set to "(none)" in Mac or Windows rich clients or disabled in Outlook on the web, the API call should return `false`.
|
|
16250
16271
|
*
|
|
16251
16272
|
* @remarks
|
|
16252
16273
|
* [Api set: Mailbox 1.10]
|
|
@@ -16267,7 +16288,7 @@ declare namespace Office {
|
|
|
16267
16288
|
* For Windows and Mac rich clients, the API call should return `true` if the default signature for new messages, replies, or forwards is set
|
|
16268
16289
|
* to a template for the sending Outlook account.
|
|
16269
16290
|
* For Outlook on the web, the API call should return `true` if the signature is enabled for compose types `newMail`, `reply`, or `forward`.
|
|
16270
|
-
* If the settings are set to "(none)" in Mac or Windows rich clients or disabled in Outlook on the
|
|
16291
|
+
* If the settings are set to "(none)" in Mac or Windows rich clients or disabled in Outlook on the web, the API call should return `false`.
|
|
16271
16292
|
*
|
|
16272
16293
|
* @remarks
|
|
16273
16294
|
* [Api set: Mailbox 1.10]
|
|
@@ -16311,7 +16332,7 @@ declare namespace Office {
|
|
|
16311
16332
|
*
|
|
16312
16333
|
* The `removeAttachmentAsync` method removes the attachment with the specified identifier from the item.
|
|
16313
16334
|
* As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment
|
|
16314
|
-
* in the same session. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
|
|
16335
|
+
* in the same session. In Outlook on the web and on mobile devices, the attachment identifier is valid only within the same session.
|
|
16315
16336
|
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
16316
16337
|
* continue in a separate window.
|
|
16317
16338
|
*
|
|
@@ -16340,7 +16361,7 @@ declare namespace Office {
|
|
|
16340
16361
|
*
|
|
16341
16362
|
* The `removeAttachmentAsync` method removes the attachment with the specified identifier from the item.
|
|
16342
16363
|
* As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment
|
|
16343
|
-
* in the same session. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
|
|
16364
|
+
* in the same session. In Outlook on the web and on mobile devices, the attachment identifier is valid only within the same session.
|
|
16344
16365
|
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
16345
16366
|
* continue in a separate window.
|
|
16346
16367
|
*
|
|
@@ -16494,7 +16515,7 @@ declare namespace Office {
|
|
|
16494
16515
|
* If more than 1,000,000 characters are passed in, an `ArgumentOutOfRange` exception is thrown.
|
|
16495
16516
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
16496
16517
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16497
|
-
* `coercionType`: If text, the current style is applied in Outlook on the web and desktop clients.
|
|
16518
|
+
* `coercionType`: If text, the current style is applied in Outlook on the web and on desktop clients.
|
|
16498
16519
|
* If the field is an HTML editor, only the text data is inserted, even if the data is HTML.
|
|
16499
16520
|
* If html and the field supports HTML (the subject doesn't), the current style is applied in Outlook on the web and the default style is
|
|
16500
16521
|
* applied in Outlook on desktop clients. If the field is a text field, an `InvalidDataFormat` error is returned.
|
|
@@ -16831,7 +16852,7 @@ declare namespace Office {
|
|
|
16831
16852
|
/**
|
|
16832
16853
|
* Gets the ID of the series that an instance belongs to.
|
|
16833
16854
|
*
|
|
16834
|
-
* In Outlook on the web and desktop clients, the `seriesId` returns the Exchange Web Services (EWS) ID of the parent (series) item
|
|
16855
|
+
* In Outlook on the web and on desktop clients, the `seriesId` returns the Exchange Web Services (EWS) ID of the parent (series) item
|
|
16835
16856
|
* that this item belongs to. However, on iOS and Android, the `seriesId` returns the REST ID of the parent item.
|
|
16836
16857
|
*
|
|
16837
16858
|
* **Note**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier.
|
|
@@ -16839,8 +16860,8 @@ declare namespace Office {
|
|
|
16839
16860
|
* Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`.
|
|
16840
16861
|
* For more details, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}.
|
|
16841
16862
|
*
|
|
16842
|
-
* The `seriesId` property returns `null` for items that
|
|
16843
|
-
* and returns `undefined` for any other items that
|
|
16863
|
+
* The `seriesId` property returns `null` for items that don't have parent items such as single appointments, series items, or meeting requests
|
|
16864
|
+
* and returns `undefined` for any other items that aren't meeting requests.
|
|
16844
16865
|
*
|
|
16845
16866
|
* @remarks
|
|
16846
16867
|
* [Api set: Mailbox 1.7]
|
|
@@ -16995,7 +17016,7 @@ declare namespace Office {
|
|
|
16995
17016
|
* When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
16996
17017
|
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
16997
17018
|
*
|
|
16998
|
-
* **Note**: This method
|
|
17019
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
16999
17020
|
*
|
|
17000
17021
|
* @remarks
|
|
17001
17022
|
* [Api set: Mailbox 1.9]
|
|
@@ -17023,7 +17044,7 @@ declare namespace Office {
|
|
|
17023
17044
|
* When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
17024
17045
|
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
17025
17046
|
*
|
|
17026
|
-
* **Note**: This method
|
|
17047
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
17027
17048
|
*
|
|
17028
17049
|
* @remarks
|
|
17029
17050
|
* [Api set: Mailbox 1.9]
|
|
@@ -17074,7 +17095,7 @@ declare namespace Office {
|
|
|
17074
17095
|
* When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
17075
17096
|
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
17076
17097
|
*
|
|
17077
|
-
* **Note**: This method
|
|
17098
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
17078
17099
|
*
|
|
17079
17100
|
* @remarks
|
|
17080
17101
|
* [Api set: Mailbox 1.9]
|
|
@@ -17101,7 +17122,7 @@ declare namespace Office {
|
|
|
17101
17122
|
* When attachments are specified in the `formData.attachments` parameter, Outlook attempts to download all attachments and attach them to the
|
|
17102
17123
|
* reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown.
|
|
17103
17124
|
*
|
|
17104
|
-
* **Note**: This method
|
|
17125
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
17105
17126
|
*
|
|
17106
17127
|
* @remarks
|
|
17107
17128
|
* [Api set: Mailbox 1.9]
|
|
@@ -17163,7 +17184,7 @@ declare namespace Office {
|
|
|
17163
17184
|
*
|
|
17164
17185
|
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
17165
17186
|
* the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
17166
|
-
* to retrieve the attachment. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
|
|
17187
|
+
* to retrieve the attachment. In Outlook on the web and on mobile devices, the attachment identifier is valid only within the same session.
|
|
17167
17188
|
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
17168
17189
|
* continue in a separate window.
|
|
17169
17190
|
*
|
|
@@ -17194,7 +17215,7 @@ declare namespace Office {
|
|
|
17194
17215
|
*
|
|
17195
17216
|
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
17196
17217
|
* the attachment's identifier from an {@link Office.MessageRead.attachments | item.attachments} call, then in the same session, use that identifier
|
|
17197
|
-
* to retrieve the attachment. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session.
|
|
17218
|
+
* to retrieve the attachment. In Outlook on the web and on mobile devices, the attachment identifier is valid only within the same session.
|
|
17198
17219
|
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
17199
17220
|
* continue in a separate window.
|
|
17200
17221
|
*
|
|
@@ -17279,7 +17300,7 @@ declare namespace Office {
|
|
|
17279
17300
|
* <tr>
|
|
17280
17301
|
* <th>Value of entityType</th>
|
|
17281
17302
|
* <th>Type of objects in returned array</th>
|
|
17282
|
-
* <th>Required
|
|
17303
|
+
* <th>Required permission level</th>
|
|
17283
17304
|
* </tr>
|
|
17284
17305
|
* <tr>
|
|
17285
17306
|
* <td>Address</td>
|
|
@@ -17465,7 +17486,7 @@ declare namespace Office {
|
|
|
17465
17486
|
*
|
|
17466
17487
|
* **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
|
|
17467
17488
|
*
|
|
17468
|
-
* **Note**: This method
|
|
17489
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
17469
17490
|
*
|
|
17470
17491
|
* @remarks
|
|
17471
17492
|
* [Api set: Mailbox 1.6]
|
|
@@ -17543,7 +17564,7 @@ declare namespace Office {
|
|
|
17543
17564
|
*
|
|
17544
17565
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
17545
17566
|
*
|
|
17546
|
-
* **Note**: This method
|
|
17567
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
17547
17568
|
*
|
|
17548
17569
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
17549
17570
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -17564,7 +17585,7 @@ declare namespace Office {
|
|
|
17564
17585
|
*
|
|
17565
17586
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
17566
17587
|
*
|
|
17567
|
-
* **Note**: This method
|
|
17588
|
+
* **Note**: This method isn't supported in Outlook on iOS or on Android.
|
|
17568
17589
|
*
|
|
17569
17590
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
17570
17591
|
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
@@ -18035,10 +18056,10 @@ declare namespace Office {
|
|
|
18035
18056
|
*
|
|
18036
18057
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18037
18058
|
*
|
|
18038
|
-
* **Important**: With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook on
|
|
18039
|
-
* on
|
|
18059
|
+
* **Important**: With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook on the web, on Windows,
|
|
18060
|
+
* on Mac (classic UI), on Android, and on iOS. However, take note of the following:
|
|
18040
18061
|
*
|
|
18041
|
-
* - In Outlook on Windows, on Mac (classic UI),
|
|
18062
|
+
* - In Outlook on the web, on Windows, and on Mac (classic UI), you can have a maximum of 500 recipients in a target field.
|
|
18042
18063
|
* If you need to add more than 100 recipients to a mail item, you can call `addAsync` repeatedly, but be mindful of the recipient limit of the field.
|
|
18043
18064
|
*
|
|
18044
18065
|
* - In Outlook on Android and on iOS, the `addAsync` method isn't supported in Message Compose mode. Only the Appointment Organizer mode is
|
|
@@ -18069,10 +18090,10 @@ declare namespace Office {
|
|
|
18069
18090
|
*
|
|
18070
18091
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18071
18092
|
*
|
|
18072
|
-
* **Important**: With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook on
|
|
18073
|
-
* on
|
|
18093
|
+
* **Important**: With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook on the web, on Windows,
|
|
18094
|
+
* on Mac (classic UI), on Android, and on iOS. However, take note of the following:
|
|
18074
18095
|
*
|
|
18075
|
-
* - In Outlook on Windows, on Mac (classic UI),
|
|
18096
|
+
* - In Outlook on the web, on Windows, and on Mac (classic UI), you can have a maximum of 500 recipients in a target field.
|
|
18076
18097
|
* If you need to add more than 100 recipients to a mail item, you can call `addAsync` repeatedly, but be mindful of the recipient limit of the field.
|
|
18077
18098
|
*
|
|
18078
18099
|
* - In Outlook on Android and on iOS, the `addAsync` method isn't supported in Message Compose mode. Only the Appointment Organizer mode is
|
|
@@ -18191,10 +18212,10 @@ declare namespace Office {
|
|
|
18191
18212
|
*
|
|
18192
18213
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18193
18214
|
*
|
|
18194
|
-
* **Important**: With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on
|
|
18195
|
-
* on
|
|
18215
|
+
* **Important**: With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on the web, on Windows,
|
|
18216
|
+
* on Mac (classic UI), on Android, and on iOS. However, take note of the following:
|
|
18196
18217
|
*
|
|
18197
|
-
* - In Outlook on Windows, on Mac (classic UI),
|
|
18218
|
+
* - In Outlook on the web, on Windows, and on Mac (classic UI), you can have a maximum of 500 recipients in a target field.
|
|
18198
18219
|
* If you need to set more than 100 recipients, you can call `setAsync` repeatedly, but be mindful of the recipient limit of the field.
|
|
18199
18220
|
*
|
|
18200
18221
|
* - In Outlook on Android and on iOS, the `setAsync` method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
@@ -18228,10 +18249,10 @@ declare namespace Office {
|
|
|
18228
18249
|
*
|
|
18229
18250
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18230
18251
|
*
|
|
18231
|
-
* **Important**: With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on
|
|
18232
|
-
* on
|
|
18252
|
+
* **Important**: With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on the web, on Windows,
|
|
18253
|
+
* on Mac (classic UI), on Android, and on iOS. However, take note of the following:
|
|
18233
18254
|
*
|
|
18234
|
-
* - In Outlook on Windows, on Mac (classic UI),
|
|
18255
|
+
* - In Outlook on the web, on Windows, and on Mac (classic UI), you can have a maximum of 500 recipients in a target field.
|
|
18235
18256
|
* If you need to set more than 100 recipients, you can call `setAsync` repeatedly, but be mindful of the recipient limit of the field.
|
|
18236
18257
|
*
|
|
18237
18258
|
* - In Outlook on Android and on iOS, the `setAsync` method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
@@ -18665,7 +18686,7 @@ declare namespace Office {
|
|
|
18665
18686
|
* your add-in has persisted changes.
|
|
18666
18687
|
* The persisted changes will not be available until the task pane (or item in the case of UI-less add-ins) is closed and reopened.
|
|
18667
18688
|
*
|
|
18668
|
-
* - When set and saved through Outlook on Windows or Mac, these settings are reflected in Outlook on the web only after a browser refresh.
|
|
18689
|
+
* - When set and saved through Outlook on Windows or on Mac, these settings are reflected in Outlook on the web only after a browser refresh.
|
|
18669
18690
|
*
|
|
18670
18691
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
18671
18692
|
*
|
|
@@ -19673,7 +19694,7 @@ declare namespace Office {
|
|
|
19673
19694
|
/**
|
|
19674
19695
|
* Gets the account type of the user associated with the mailbox.
|
|
19675
19696
|
*
|
|
19676
|
-
* **Note**: This member is currently only supported in Outlook
|
|
19697
|
+
* **Note**: This member is currently only supported in Outlook on Mac, Build 16.9.1212 and greater.
|
|
19677
19698
|
*
|
|
19678
19699
|
* @remarks
|
|
19679
19700
|
* [Api set: Mailbox 1.6]
|