@types/office-js 1.0.264 → 1.0.267

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.
Files changed (3) hide show
  1. office-js/README.md +1 -1
  2. office-js/index.d.ts +171 -139
  3. office-js/package.json +2 -2
office-js/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Thu, 16 Jun 2022 20:31:35 GMT
11
+ * Last updated: Thu, 14 Jul 2022 22:02:26 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
office-js/index.d.ts CHANGED
@@ -274,8 +274,8 @@ declare namespace Office {
274
274
  *
275
275
  * **Support details**
276
276
  *
277
- * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application.
278
- * An empty cell indicates that the Office host application doesn't support this method.
277
+ * A capital Y in the following matrix indicates that this function is supported in the corresponding Office host application.
278
+ * An empty cell indicates that the Office host application doesn't support this function.
279
279
  *
280
280
  * For more information about Office host application and server requirements, see
281
281
  * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
@@ -299,7 +299,7 @@ declare namespace Office {
299
299
  * also be used outside the add-in. In that case, once Office.js determines that it is running outside of an Office host application, it will call
300
300
  * the callback and resolve the promise with "null" for both the host and platform.
301
301
  *
302
- * @param callback - An optional callback method, that will receive the host and platform info.
302
+ * @param callback - An optional callback function, that will receive the host and platform info.
303
303
  * Alternatively, rather than use a callback, an add-in may simply wait for the Promise returned by the function to resolve.
304
304
  * @returns A Promise that contains the host and platform info, once initialization is completed.
305
305
  */
@@ -311,8 +311,8 @@ declare namespace Office {
311
311
  *
312
312
  * **Support details**
313
313
  *
314
- * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application.
315
- * An empty cell indicates that the Office host application doesn't support this method.
314
+ * A capital Y in the following matrix indicates that this function is supported in the corresponding Office host application.
315
+ * An empty cell indicates that the Office host application doesn't support this function.
316
316
  *
317
317
  * For more information about Office host application and server requirements, see
318
318
  * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
@@ -1187,7 +1187,7 @@ declare namespace Office {
1187
1187
  *
1188
1188
  * @param startAddress - Accepts the initial full HTTPS URL that opens in the dialog. Relative URLs must not be used.
1189
1189
  * @param options - Optional. Accepts an {@link Office.DialogOptions} object to define dialog display.
1190
- * @param callback - Optional. Accepts a callback method to handle the dialog creation attempt. If successful, the AsyncResult.value is a Dialog object.
1190
+ * @param callback - Optional. Accepts a callback function to handle the dialog creation attempt. If successful, the AsyncResult.value is a Dialog object.
1191
1191
  */
1192
1192
  displayDialogAsync(startAddress: string, options?: DialogOptions, callback?: (result: AsyncResult<Dialog>) => void): void;
1193
1193
  /**
@@ -1287,7 +1287,7 @@ declare namespace Office {
1287
1287
  * </table>
1288
1288
  *
1289
1289
  * @param startAddress - Accepts the initial full HTTPS URL that opens in the dialog. Relative URLs must not be used.
1290
- * @param callback - Optional. Accepts a callback method to handle the dialog creation attempt. If successful, the AsyncResult.value is a Dialog object.
1290
+ * @param callback - Optional. Accepts a callback function to handle the dialog creation attempt. If successful, the AsyncResult.value is a Dialog object.
1291
1291
  */
1292
1292
  displayDialogAsync(startAddress: string, callback?: (result: AsyncResult<Dialog>) => void): void;
1293
1293
  /**
@@ -1420,7 +1420,7 @@ declare namespace Office {
1420
1420
  * Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
1421
1421
  *
1422
1422
  * @param options - Optional. Accepts an `AuthOptions` object to define sign-on behaviors.
1423
- * @param callback - Optional. Accepts a callback method that can parse the token for the user's ID or use the token in the "on behalf of" flow to get access to Microsoft Graph.
1423
+ * @param callback - Optional. Accepts a callback function that can parse the token for the user's ID or use the token in the "on behalf of" flow to get access to Microsoft Graph.
1424
1424
  * If `AsyncResult.status` is "succeeded", then `AsyncResult.value` is the raw AAD v. 2.0-formatted access token.
1425
1425
  */
1426
1426
  getAccessTokenAsync(options?: AuthOptions, callback?: (result: AsyncResult<string>) => void): void;
@@ -1444,7 +1444,7 @@ declare namespace Office {
1444
1444
  * This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign in with Organizational
1445
1445
  * Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
1446
1446
  *
1447
- * @param callback - Optional. Accepts a callback method that can parse the token for the user's ID or use the token in the "on behalf of" flow to get access to Microsoft Graph.
1447
+ * @param callback - Optional. Accepts a callback function that can parse the token for the user's ID or use the token in the "on behalf of" flow to get access to Microsoft Graph.
1448
1448
  * If `AsyncResult.status` is "succeeded", then `AsyncResult.value` is the raw AAD v. 2.0-formatted access token.
1449
1449
  */
1450
1450
  getAccessTokenAsync(callback?: (result: AsyncResult<string>) => void): void;
@@ -1459,9 +1459,15 @@ declare namespace Office {
1459
1459
  *
1460
1460
  * **Hosts**: Excel, OneNote, Outlook, PowerPoint, Word
1461
1461
  *
1462
- * **Important**: In Outlook, this API is not supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
1463
- *
1464
1462
  * **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/identity-api-requirement-sets | IdentityAPI 1.3}
1463
+ *
1464
+ * **Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
1465
+ *
1466
+ * **Note**: In an Outlook event-based activation add-in, this API is supported in Outlook on Windows starting from version 2111 (build 14701.20000).
1467
+ * To retrieve an access token in older builds, use
1468
+ * {@link https://docs.microsoft.com/javascript/api/office-runtime/officeruntime.auth?view=common-js#office-runtime-officeruntime-auth-getaccesstoken-member(1) |
1469
+ * OfficeRuntime.auth.getAccessToken} instead. For more information, see
1470
+ * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/use-sso-in-event-based-activation | Enable single sign-on (SSO) in Outlook add-ins that use event-based activation}.
1465
1471
  *
1466
1472
  * @param options - Optional. Accepts an `AuthOptions` object to define sign-on behaviors.
1467
1473
  * @returns Promise to the access token.
@@ -1962,7 +1968,7 @@ declare namespace Office {
1962
1968
  }
1963
1969
 
1964
1970
  /**
1965
- * Returns a promise of an object described in the expression. Callback is invoked only if method fails.
1971
+ * Returns a promise of an object described in the expression. Callback is invoked only if the function fails.
1966
1972
  *
1967
1973
  * @param expression The object to be retrieved. Example "bindings#BindingName", retrieves a binding promise for a binding named 'BindingName'
1968
1974
  * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -1971,8 +1977,8 @@ declare namespace Office {
1971
1977
  *
1972
1978
  * **Support details**
1973
1979
  *
1974
- * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application.
1975
- * An empty cell indicates that the Office host application doesn't support this method.
1980
+ * A capital Y in the following matrix indicates that this function is supported in the corresponding Office host application.
1981
+ * An empty cell indicates that the Office host application doesn't support this function.
1976
1982
  *
1977
1983
  * For more information about Office host application and server requirements, see
1978
1984
  * {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
@@ -9729,7 +9735,7 @@ declare namespace Office {
9729
9735
  * @param uri - The URI that provides the location of the file to attach to the message or appointment. The maximum length is 2048 characters.
9730
9736
  * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
9731
9737
  * @param options - An object literal that contains one or more of the following properties.
9732
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
9738
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
9733
9739
  * `isInline`: If true, indicates that the attachment will be shown inline in the message body,
9734
9740
  * and should not be displayed in the attachment list.
9735
9741
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
@@ -9803,7 +9809,7 @@ declare namespace Office {
9803
9809
  * @param base64File - The base64 encoded content of an image or file to be added to an email or event.
9804
9810
  * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
9805
9811
  * @param options - An object literal that contains one or more of the following properties.
9806
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
9812
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
9807
9813
  * `isInline`: If true, indicates that the attachment will be shown inline in the message body
9808
9814
  * and should not be displayed in the attachment list.
9809
9815
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
@@ -9865,7 +9871,7 @@ declare namespace Office {
9865
9871
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
9866
9872
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
9867
9873
  * @param options - An object literal that contains one or more of the following properties.
9868
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
9874
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
9869
9875
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
9870
9876
  * `asyncResult`, which is an `Office.AsyncResult` object.
9871
9877
  */
@@ -9894,9 +9900,9 @@ declare namespace Office {
9894
9900
  * Adds an Exchange item, such as a message, as an attachment to the message or appointment.
9895
9901
  *
9896
9902
  * The `addItemAttachmentAsync` method attaches the item with the specified Exchange identifier to the item in the compose form.
9897
- * If you specify a callback method, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or
9903
+ * If you specify a callback function, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or
9898
9904
  * a code that indicates any error that occurred while attaching the item.
9899
- * You can use the `options` parameter to pass state information to the callback method, if needed.
9905
+ * You can use the `options` parameter to pass state information to the callback function, if needed.
9900
9906
  *
9901
9907
  * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
9902
9908
  *
@@ -9917,7 +9923,7 @@ declare namespace Office {
9917
9923
  * @param itemId - The Exchange identifier of the item to attach. The maximum length is 100 characters.
9918
9924
  * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
9919
9925
  * @param options - An object literal that contains one or more of the following properties.
9920
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
9926
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
9921
9927
  * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
9922
9928
  * type `Office.AsyncResult`.
9923
9929
  * On success, the attachment identifier will be provided in the `asyncResult.value` property.
@@ -9929,9 +9935,9 @@ declare namespace Office {
9929
9935
  * Adds an Exchange item, such as a message, as an attachment to the message or appointment.
9930
9936
  *
9931
9937
  * The `addItemAttachmentAsync` method attaches the item with the specified Exchange identifier to the item in the compose form.
9932
- * If you specify a callback method, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or
9938
+ * If you specify a callback function, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or
9933
9939
  * a code that indicates any error that occurred while attaching the item.
9934
- * You can use the `options` parameter to pass state information to the callback method, if needed.
9940
+ * You can use the `options` parameter to pass state information to the callback function, if needed.
9935
9941
  *
9936
9942
  * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
9937
9943
  *
@@ -9993,7 +9999,7 @@ declare namespace Office {
9993
9999
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
9994
10000
  *
9995
10001
  * @param options - An object literal that contains one or more of the following properties.
9996
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
10002
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
9997
10003
  * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
9998
10004
  * `asyncResult`, which is an `Office.AsyncResult` object.
9999
10005
  */
@@ -10042,7 +10048,7 @@ declare namespace Office {
10042
10048
  *
10043
10049
  * @param attachmentId - The identifier of the attachment you want to get.
10044
10050
  * @param options - An object literal that contains one or more of the following properties.
10045
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
10051
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
10046
10052
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
10047
10053
  * `asyncResult`, which is an `Office.AsyncResult` object. If the call fails, the `asyncResult.error` property will contain
10048
10054
  * an error code with the reason for the failure.
@@ -10088,7 +10094,7 @@ declare namespace Office {
10088
10094
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
10089
10095
  *
10090
10096
  * @param options - An object literal that contains one or more of the following properties.
10091
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
10097
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
10092
10098
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
10093
10099
  * type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
10094
10100
  * the failure.
@@ -10112,7 +10118,7 @@ declare namespace Office {
10112
10118
  /**
10113
10119
  * Asynchronously gets the ID of a saved item.
10114
10120
  *
10115
- * When invoked, this method returns the item ID via the callback method.
10121
+ * When invoked, this method returns the item ID via the callback function.
10116
10122
  *
10117
10123
  * **Note**: If your add-in calls `getItemIdAsync` on an item in compose mode (e.g., to get an `itemId` to use with EWS or the REST API),
10118
10124
  * be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server.
@@ -10130,7 +10136,7 @@ declare namespace Office {
10130
10136
  * - `ItemNotSaved`: The id can't be retrieved until the item is saved.
10131
10137
  *
10132
10138
  * @param options - An object literal that contains one or more of the following properties.
10133
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
10139
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
10134
10140
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
10135
10141
  * of type `Office.AsyncResult`.
10136
10142
  */
@@ -10138,7 +10144,7 @@ declare namespace Office {
10138
10144
  /**
10139
10145
  * Asynchronously gets the ID of a saved item.
10140
10146
  *
10141
- * When invoked, this method returns the item ID via the callback method.
10147
+ * When invoked, this method returns the item ID via the callback function.
10142
10148
  *
10143
10149
  * **Note**: If your add-in calls `getItemIdAsync` on an item in compose mode (e.g., to get an `itemId` to use with EWS or the REST API),
10144
10150
  * be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server.
@@ -10165,7 +10171,7 @@ declare namespace Office {
10165
10171
  * If there is no selection but the cursor is in the body or subject, the method returns an empty string for the selected data.
10166
10172
  * If a field other than the body or subject is selected, the method returns the `InvalidSelection` error.
10167
10173
  *
10168
- * To access the selected data from the callback method, call `asyncResult.value.data`.
10174
+ * To access the selected data from the callback function, call `asyncResult.value.data`.
10169
10175
  * To access the `source` property that the selection comes from, call `asyncResult.value.sourceProperty`, which will be either `body` or `subject`.
10170
10176
  *
10171
10177
  * @returns
@@ -10181,7 +10187,7 @@ declare namespace Office {
10181
10187
  * @param coercionType - Requests a format for the data. If `Text`, the method returns the plain text as a string, removing any HTML tags present.
10182
10188
  * If `HTML`, the method returns the selected text, whether it is plaintext or HTML.
10183
10189
  * @param options - An object literal that contains one or more of the following properties.
10184
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
10190
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
10185
10191
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
10186
10192
  * of type `Office.AsyncResult`.
10187
10193
  */
@@ -10192,7 +10198,7 @@ declare namespace Office {
10192
10198
  * If there is no selection but the cursor is in the body or subject, the method returns an empty string for the selected data.
10193
10199
  * If a field other than the body or subject is selected, the method returns the `InvalidSelection` error.
10194
10200
  *
10195
- * To access the selected data from the callback method, call `asyncResult.value.data`.
10201
+ * To access the selected data from the callback function, call `asyncResult.value.data`.
10196
10202
  * To access the `source` property that the selection comes from, call `asyncResult.value.sourceProperty`, which will be either `body` or `subject`.
10197
10203
  *
10198
10204
  * @returns
@@ -10227,7 +10233,7 @@ declare namespace Office {
10227
10233
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
10228
10234
  *
10229
10235
  * @param options - An object literal that contains one or more of the following properties.
10230
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
10236
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
10231
10237
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
10232
10238
  * type `Office.AsyncResult`.
10233
10239
  * The `value` property of the result is the properties of the shared item.
@@ -10269,7 +10275,7 @@ declare namespace Office {
10269
10275
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
10270
10276
  *
10271
10277
  * @param options - An object literal that contains one or more of the following properties.
10272
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
10278
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
10273
10279
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
10274
10280
  * type `Office.AsyncResult`.
10275
10281
  */
@@ -10339,7 +10345,7 @@ declare namespace Office {
10339
10345
  * @param attachmentId - The identifier of the attachment to remove. The maximum string length of the `attachmentId`
10340
10346
  * is 200 characters in Outlook on the web and on Windows.
10341
10347
  * @param options - An object literal that contains one or more of the following properties.
10342
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
10348
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
10343
10349
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
10344
10350
  * type `Office.AsyncResult`.
10345
10351
  * If removing the attachment fails, the `asyncResult.error` property will contain an error code with the reason for the failure.
@@ -10387,7 +10393,7 @@ declare namespace Office {
10387
10393
  *
10388
10394
  * @param eventType - The event that should revoke the handler.
10389
10395
  * @param options - An object literal that contains one or more of the following properties.
10390
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
10396
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
10391
10397
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
10392
10398
  * `asyncResult`, which is an `Office.AsyncResult` object.
10393
10399
  */
@@ -10413,7 +10419,7 @@ declare namespace Office {
10413
10419
  /**
10414
10420
  * Asynchronously saves an item.
10415
10421
  *
10416
- * When invoked, this method saves the current message as a draft and returns the item ID via the callback method.
10422
+ * When invoked, this method saves the current message as a draft and returns the item ID via the callback function.
10417
10423
  * In Outlook on the web or Outlook in online mode, the item is saved to the server.
10418
10424
  * In Outlook in cached mode, the item is saved to the local cache.
10419
10425
  *
@@ -10444,7 +10450,7 @@ declare namespace Office {
10444
10450
  * - `InvalidAttachmentId`: The attachment identifier does not exist.
10445
10451
  *
10446
10452
  * @param options - An object literal that contains one or more of the following properties.
10447
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
10453
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
10448
10454
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
10449
10455
  * type `Office.AsyncResult`.
10450
10456
  */
@@ -10452,7 +10458,7 @@ declare namespace Office {
10452
10458
  /**
10453
10459
  * Asynchronously saves an item.
10454
10460
  *
10455
- * When invoked, this method saves the current message as a draft and returns the item ID via the callback method.
10461
+ * When invoked, this method saves the current message as a draft and returns the item ID via the callback function.
10456
10462
  * In Outlook on the web or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache.
10457
10463
  *
10458
10464
  * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item will be saved as a normal
@@ -10506,7 +10512,7 @@ declare namespace Office {
10506
10512
  * @param data - The data to be inserted. Data is not to exceed 1,000,000 characters.
10507
10513
  * If more than 1,000,000 characters are passed in, an `ArgumentOutOfRange` exception is thrown.
10508
10514
  * @param options - An object literal that contains one or more of the following properties.
10509
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
10515
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
10510
10516
  * `coercionType`: If text, the current style is applied in Outlook on the web and Windows.
10511
10517
  * If the field is an HTML editor, only the text data is inserted, even if the data is HTML.
10512
10518
  * If html and the field supports HTML (the subject doesn't), the current style is applied in Outlook on the web and the
@@ -11054,7 +11060,7 @@ declare namespace Office {
11054
11060
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
11055
11061
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
11056
11062
  * @param options - An object literal that contains one or more of the following properties.
11057
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
11063
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
11058
11064
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
11059
11065
  * `asyncResult`, which is an `Office.AsyncResult` object.
11060
11066
  */
@@ -11125,7 +11131,7 @@ declare namespace Office {
11125
11131
  * @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
11126
11132
  * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
11127
11133
  * @param options - An object literal that contains one or more of the following properties.
11128
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
11134
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
11129
11135
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
11130
11136
  * `asyncResult`, which is an `Office.AsyncResult` object.
11131
11137
  */
@@ -11200,7 +11206,7 @@ declare namespace Office {
11200
11206
  * @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
11201
11207
  * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
11202
11208
  * @param options - An object literal that contains one or more of the following properties.
11203
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
11209
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
11204
11210
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
11205
11211
  * `asyncResult`, which is an `Office.AsyncResult` object.
11206
11212
  */
@@ -11255,7 +11261,7 @@ declare namespace Office {
11255
11261
  *
11256
11262
  * @param attachmentId - The identifier of the attachment you want to get.
11257
11263
  * @param options - An object literal that contains one or more of the following properties.
11258
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
11264
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
11259
11265
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
11260
11266
  * `asyncResult`, which is an `Office.AsyncResult` object. If the call fails, the `asyncResult.error` property will contain
11261
11267
  * an error code with the reason for the failure.
@@ -11499,7 +11505,7 @@ declare namespace Office {
11499
11505
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
11500
11506
  *
11501
11507
  * @param options - An object literal that contains one or more of the following properties.
11502
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
11508
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
11503
11509
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
11504
11510
  * type `Office.AsyncResult`.
11505
11511
  * The `value` property of the result is the properties of the shared item.
@@ -11563,7 +11569,7 @@ declare namespace Office {
11563
11569
  *
11564
11570
  * @param eventType - The event that should revoke the handler.
11565
11571
  * @param options - An object literal that contains one or more of the following properties.
11566
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
11572
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
11567
11573
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
11568
11574
  * `asyncResult`, which is an `Office.AsyncResult` object.
11569
11575
  */
@@ -11815,7 +11821,7 @@ declare namespace Office {
11815
11821
  *
11816
11822
  * @param data - The string to be added to the end of the body. The string is limited to 5,000 characters.
11817
11823
  * @param options - An object literal that contains one or more of the following properties.
11818
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
11824
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
11819
11825
  * `coercionType`: The desired format for the data to be appended. The string in the `data` parameter will be converted to this format.
11820
11826
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
11821
11827
  * of type `Office.AsyncResult`. Any errors encountered will be provided in the `asyncResult.error` property.
@@ -11873,7 +11879,7 @@ declare namespace Office {
11873
11879
  *
11874
11880
  * @param coercionType - The format for the returned body.
11875
11881
  * @param options - An object literal that contains one or more of the following properties:
11876
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
11882
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
11877
11883
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
11878
11884
  * of type Office.AsyncResult. The body is provided in the requested format in the `asyncResult.value` property.
11879
11885
  */
@@ -11910,7 +11916,7 @@ declare namespace Office {
11910
11916
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
11911
11917
  *
11912
11918
  * @param options - An object literal that contains one or more of the following properties.
11913
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
11919
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
11914
11920
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
11915
11921
  * of type `Office.AsyncResult`.
11916
11922
  * The content type is returned as one of the `CoercionType` values in the `asyncResult.value` property.
@@ -11959,7 +11965,7 @@ declare namespace Office {
11959
11965
  *
11960
11966
  * @param data - The string to be inserted at the beginning of the body. The string is limited to 1,000,000 characters.
11961
11967
  * @param options - An object literal that contains one or more of the following properties.
11962
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
11968
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
11963
11969
  * `coercionType`: The desired format for the body. The string in the `data` parameter will be converted to this format.
11964
11970
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
11965
11971
  * of type `Office.AsyncResult`. Any errors encountered will be provided in the `asyncResult.error` property.
@@ -12025,7 +12031,7 @@ declare namespace Office {
12025
12031
  *
12026
12032
  * @param data - The string that will replace the existing body. The string is limited to 1,000,000 characters.
12027
12033
  * @param options - An object literal that contains one or more of the following properties.
12028
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
12034
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
12029
12035
  * `coercionType`: The desired format for the body. The string in the `data` parameter will be converted to this format.
12030
12036
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
12031
12037
  * of type Office.AsyncResult. Any errors encountered will be provided in the `asyncResult.error` property.
@@ -12090,7 +12096,7 @@ declare namespace Office {
12090
12096
  *
12091
12097
  * @param data - The string that will replace the existing body. The string is limited to 1,000,000 characters.
12092
12098
  * @param options - An object literal that contains one or more of the following properties.
12093
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
12099
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
12094
12100
  * `coercionType`: The desired format for the body. The string in the `data` parameter will be converted to this format.
12095
12101
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
12096
12102
  * of type `Office.AsyncResult`. Any errors encountered will be provided in the `asyncResult.error` property.
@@ -12153,7 +12159,7 @@ declare namespace Office {
12153
12159
  *
12154
12160
  * @param data - The string that represents the signature to be set in the body of the mail. This string is limited to 30,000 characters.
12155
12161
  * @param options - An object literal that contains one or more of the following properties.
12156
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
12162
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
12157
12163
  * `coercionType`: The format the signature should be set to. If Text, the method sets the signature to plain text,
12158
12164
  * removing any HTML tags present. If Html, the method sets the signature to HTML.
12159
12165
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
@@ -12227,7 +12233,7 @@ declare namespace Office {
12227
12233
  *
12228
12234
  * @param categories - The categories to be added to the item.
12229
12235
  * @param options - An object literal that contains one or more of the following properties.
12230
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
12236
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
12231
12237
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
12232
12238
  * type `Office.AsyncResult`.
12233
12239
  */
@@ -12265,7 +12271,7 @@ declare namespace Office {
12265
12271
  * - In Outlook on the web, you can't use the API to manage categories applied to a message in Compose mode.
12266
12272
  *
12267
12273
  * @param options - An object literal that contains one or more of the following properties.
12268
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
12274
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
12269
12275
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
12270
12276
  * type `Office.AsyncResult`. If getting categories fails, the `asyncResult.error` property will contain an error code.
12271
12277
  *
@@ -12312,7 +12318,7 @@ declare namespace Office {
12312
12318
  *
12313
12319
  * @param categories - The categories to be removed from the item.
12314
12320
  * @param options - An object literal that contains one or more of the following properties.
12315
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
12321
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
12316
12322
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
12317
12323
  * type `Office.AsyncResult`. If removing categories fails, the `asyncResult.error` property will contain an error code.
12318
12324
  */
@@ -12465,7 +12471,7 @@ declare namespace Office {
12465
12471
  * In particular, a read add-in can be activated while the user is in a connected state in a read form, and subsequently the user becomes
12466
12472
  * disconnected.
12467
12473
  * If the add-in calls `saveAsync` while in the disconnected state, `saveAsync` would return an error.
12468
- * Your callback method should handle this error accordingly.
12474
+ * Your callback function should handle this error accordingly.
12469
12475
  *
12470
12476
  * @remarks
12471
12477
  *
@@ -12475,7 +12481,7 @@ declare namespace Office {
12475
12481
  *
12476
12482
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
12477
12483
  * type `Office.AsyncResult`.
12478
- * @param asyncContext - Optional. Any state data that is passed to the callback method.
12484
+ * @param asyncContext - Optional. Any state data that is passed to the callback function.
12479
12485
  */
12480
12486
  saveAsync(callback: (asyncResult: Office.AsyncResult<void>) => void, asyncContext?: any): void;
12481
12487
  /**
@@ -12488,7 +12494,7 @@ declare namespace Office {
12488
12494
  * In particular, a read add-in can be activated while the user is in a connected state in a read form, and subsequently the user becomes
12489
12495
  * disconnected.
12490
12496
  * If the add-in calls `saveAsync` while in the disconnected state, `saveAsync` would return an error.
12491
- * Your callback method should handle this error accordingly.
12497
+ * Your callback function should handle this error accordingly.
12492
12498
  *
12493
12499
  * @remarks
12494
12500
  *
@@ -12496,7 +12502,7 @@ declare namespace Office {
12496
12502
  *
12497
12503
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12498
12504
  *
12499
- * @param asyncContext - Optional. Any state data that is passed to the callback method.
12505
+ * @param asyncContext - Optional. Any state data that is passed to the callback function.
12500
12506
  */
12501
12507
  saveAsync(asyncContext?: any): void;
12502
12508
  /**
@@ -12670,7 +12676,7 @@ declare namespace Office {
12670
12676
  *
12671
12677
  * @param locationIdentifiers The locations to be added to the current list of locations.
12672
12678
  * @param options An object literal that contains one or more of the following properties.
12673
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
12679
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
12674
12680
  * @param callback Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
12675
12681
  * `asyncResult`, which is an `Office.AsyncResult` object. Check the `status` property of `asyncResult` to determine if the call succeeded.
12676
12682
  */
@@ -12705,7 +12711,7 @@ declare namespace Office {
12705
12711
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12706
12712
  *
12707
12713
  * @param options An object literal that contains one or more of the following properties.
12708
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
12714
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
12709
12715
  * @param callback Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
12710
12716
  * `asyncResult`, which is an `Office.AsyncResult` object.
12711
12717
  */
@@ -12738,7 +12744,7 @@ declare namespace Office {
12738
12744
  *
12739
12745
  * @param locationIdentifiers The locations to be removed from the current list of locations.
12740
12746
  * @param options An object literal that contains one or more of the following properties.
12741
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
12747
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
12742
12748
  * @param callback Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
12743
12749
  * `asyncResult`, which is an `Office.AsyncResult` object. Check the `status` property of `asyncResult` to determine if the call succeeded.
12744
12750
  */
@@ -12871,7 +12877,7 @@ declare namespace Office {
12871
12877
  * The email sender is always a user whose email address is on the Exchange server.
12872
12878
  *
12873
12879
  * @param options - An object literal that contains one or more of the following properties.
12874
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
12880
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
12875
12881
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
12876
12882
  * `asyncResult`, which is an `Office.AsyncResult` object.
12877
12883
  * The `value` property of the result is the item's from value, as an `EmailAddressDetails` object.
@@ -12988,7 +12994,7 @@ declare namespace Office {
12988
12994
  *
12989
12995
  * @param names - The names of the internet headers to be returned.
12990
12996
  * @param options - An object literal that contains one or more of the following properties:
12991
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
12997
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
12992
12998
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
12993
12999
  * `asyncResult`, which is an `Office.AsyncResult` object.
12994
13000
  */
@@ -13025,7 +13031,7 @@ declare namespace Office {
13025
13031
  *
13026
13032
  * @param names - The names of the internet headers to be removed.
13027
13033
  * @param options - An object literal that contains one or more of the following properties:
13028
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
13034
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
13029
13035
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13030
13036
  * `asyncResult`, which is an `Office.AsyncResult` object.
13031
13037
  */
@@ -13065,7 +13071,7 @@ declare namespace Office {
13065
13071
  * @param headers - The names and corresponding values of the headers to be set. Should be a dictionary object with keys being the names of the
13066
13072
  * internet headers and values being the values of the internet headers.
13067
13073
  * @param options - An object literal that contains one or more of the following properties.
13068
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
13074
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
13069
13075
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
13070
13076
  * of type Office.AsyncResult. Any errors encountered will be provided in the `asyncResult.error` property.
13071
13077
  */
@@ -13215,7 +13221,7 @@ declare namespace Office {
13215
13221
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
13216
13222
  *
13217
13223
  * @param options - An object literal that contains one or more of the following properties.
13218
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
13224
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
13219
13225
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
13220
13226
  * type `Office.AsyncResult`.
13221
13227
  */
@@ -13256,7 +13262,7 @@ declare namespace Office {
13256
13262
  *
13257
13263
  * @param location - The location of the appointment. The string is limited to 255 characters.
13258
13264
  * @param options - An object literal that contains one or more of the following properties.
13259
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
13265
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
13260
13266
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
13261
13267
  * type `Office.AsyncResult`. If setting the location fails, the `asyncResult.error` property will contain an error code.
13262
13268
  */
@@ -13626,7 +13632,7 @@ declare namespace Office {
13626
13632
  *
13627
13633
  * @param itemId - The Exchange Web Services (EWS) identifier for an existing calendar appointment.
13628
13634
  * @param options - An object literal that contains one or more of the following properties.
13629
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
13635
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
13630
13636
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13631
13637
  * `asyncResult`, which is an `Office.AsyncResult` object.
13632
13638
  */
@@ -13709,7 +13715,7 @@ declare namespace Office {
13709
13715
  *
13710
13716
  * @param itemId - The Exchange Web Services (EWS) identifier for an existing message.
13711
13717
  * @param options - An object literal that contains one or more of the following properties.
13712
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
13718
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
13713
13719
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13714
13720
  * `asyncResult`, which is an `Office.AsyncResult` object.
13715
13721
  */
@@ -13796,7 +13802,7 @@ declare namespace Office {
13796
13802
  *
13797
13803
  * @param parameters - An `AppointmentForm` describing the new appointment. All properties are optional.
13798
13804
  * @param options - An object literal that contains one or more of the following properties.
13799
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
13805
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
13800
13806
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13801
13807
  * `asyncResult`, which is an `Office.AsyncResult` object.
13802
13808
  */
@@ -13924,7 +13930,7 @@ declare namespace Office {
13924
13930
  * `attachments.itemId`: Only used if type is set to item. The EWS item id of the existing e-mail you want to attach to the new message.
13925
13931
  * This is a string up to 100 characters.
13926
13932
  * @param options - An object literal that contains one or more of the following properties.
13927
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
13933
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
13928
13934
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13929
13935
  * `asyncResult`, which is an `Office.AsyncResult` object.
13930
13936
  */
@@ -14250,7 +14256,7 @@ declare namespace Office {
14250
14256
  *
14251
14257
  * @param categories - The categories to be added to the master list on the mailbox.
14252
14258
  * @param options - An object literal that contains one or more of the following properties.
14253
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
14259
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
14254
14260
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
14255
14261
  * type `Office.AsyncResult`.
14256
14262
  */
@@ -14287,7 +14293,7 @@ declare namespace Office {
14287
14293
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
14288
14294
  *
14289
14295
  * @param options - An object literal that contains one or more of the following properties.
14290
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
14296
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
14291
14297
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
14292
14298
  * type `Office.AsyncResult`. If adding categories fails, the `asyncResult.error` property will contain an error code.
14293
14299
  */
@@ -14322,7 +14328,7 @@ declare namespace Office {
14322
14328
  *
14323
14329
  * @param categories - The categories to be removed from the master list on the mailbox.
14324
14330
  * @param options - An object literal that contains one or more of the following properties.
14325
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
14331
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
14326
14332
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
14327
14333
  * type `Office.AsyncResult`. If removing categories fails, the `asyncResult.error` property will contain an error code.
14328
14334
  */
@@ -14634,7 +14640,7 @@ declare namespace Office {
14634
14640
  * @param uri - The URI that provides the location of the file to attach to the message or appointment. The maximum length is 2048 characters.
14635
14641
  * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
14636
14642
  * @param options - An object literal that contains one or more of the following properties.
14637
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
14643
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
14638
14644
  * `isInline`: If true, indicates that the attachment will be shown inline in the message body, and should not be displayed in the
14639
14645
  * attachment list.
14640
14646
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
@@ -14706,7 +14712,7 @@ declare namespace Office {
14706
14712
  * @param base64File - The base64-encoded content of an image or file to be added to an email or event.
14707
14713
  * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
14708
14714
  * @param options - An object literal that contains one or more of the following properties.
14709
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
14715
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
14710
14716
  * `isInline`: If true, indicates that the attachment will be shown inline in the message body and should not be displayed in the attachment list.
14711
14717
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
14712
14718
  * type Office.AsyncResult. On success, the attachment identifier will be provided in the `asyncResult.value` property.
@@ -14763,7 +14769,7 @@ declare namespace Office {
14763
14769
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
14764
14770
  * The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
14765
14771
  * @param options - An object literal that contains one or more of the following properties.
14766
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
14772
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
14767
14773
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
14768
14774
  * `asyncResult`, which is an `Office.AsyncResult` object.
14769
14775
  */
@@ -14792,9 +14798,9 @@ declare namespace Office {
14792
14798
  * Adds an Exchange item, such as a message, as an attachment to the message or appointment.
14793
14799
  *
14794
14800
  * The `addItemAttachmentAsync` method attaches the item with the specified Exchange identifier to the item in the compose form.
14795
- * If you specify a callback method, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or
14801
+ * If you specify a callback function, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or
14796
14802
  * a code that indicates any error that occurred while attaching the item. You can use the options parameter to pass state information to the
14797
- * callback method, if needed.
14803
+ * callback function, if needed.
14798
14804
  *
14799
14805
  * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
14800
14806
  *
@@ -14815,7 +14821,7 @@ declare namespace Office {
14815
14821
  * @param itemId - The Exchange identifier of the item to attach. The maximum length is 100 characters.
14816
14822
  * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
14817
14823
  * @param options - An object literal that contains one or more of the following properties.
14818
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
14824
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
14819
14825
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
14820
14826
  * type `Office.AsyncResult`. On success, the attachment identifier will be provided in the `asyncResult.value` property.
14821
14827
  * If adding the attachment fails, the `asyncResult` object will contain an `Error` object that provides a description of
@@ -14826,9 +14832,9 @@ declare namespace Office {
14826
14832
  * Adds an Exchange item, such as a message, as an attachment to the message or appointment.
14827
14833
  *
14828
14834
  * The `addItemAttachmentAsync` method attaches the item with the specified Exchange identifier to the item in the compose form.
14829
- * If you specify a callback method, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or
14835
+ * If you specify a callback function, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or
14830
14836
  * a code that indicates any error that occurred while attaching the item. You can use the options parameter to pass state information to the
14831
- * callback method, if needed.
14837
+ * callback function, if needed.
14832
14838
  *
14833
14839
  * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
14834
14840
  *
@@ -14889,7 +14895,7 @@ declare namespace Office {
14889
14895
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
14890
14896
  *
14891
14897
  * @param options - An object literal that contains one or more of the following properties.
14892
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
14898
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
14893
14899
  * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
14894
14900
  * `asyncResult`, which is an `Office.AsyncResult` object.
14895
14901
  */
@@ -14938,7 +14944,7 @@ declare namespace Office {
14938
14944
  *
14939
14945
  * @param attachmentId - The identifier of the attachment you want to get.
14940
14946
  * @param options - An object literal that contains one or more of the following properties.
14941
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
14947
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
14942
14948
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
14943
14949
  * `asyncResult`, which is an `Office.AsyncResult` object. If the call fails, the `asyncResult.error` property will contain
14944
14950
  * an error code with the reason for the failure.
@@ -14984,7 +14990,7 @@ declare namespace Office {
14984
14990
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
14985
14991
  *
14986
14992
  * @param options - An object literal that contains one or more of the following properties.
14987
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
14993
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
14988
14994
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
14989
14995
  * type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
14990
14996
  * the failure.
@@ -15017,7 +15023,7 @@ declare namespace Office {
15017
15023
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
15018
15024
  *
15019
15025
  * @param options - An object literal that contains one or more of the following properties.
15020
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
15026
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
15021
15027
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
15022
15028
  * type `Office.AsyncResult`. On success, the `asyncResult.value` property contains an object with the item's compose type
15023
15029
  * and coercion type.
@@ -15048,7 +15054,7 @@ declare namespace Office {
15048
15054
  /**
15049
15055
  * Asynchronously gets the ID of a saved item.
15050
15056
  *
15051
- * When invoked, this method returns the item ID via the callback method.
15057
+ * When invoked, this method returns the item ID via the callback function.
15052
15058
  *
15053
15059
  * **Note**: If your add-in calls `getItemIdAsync` on an item in compose mode (e.g., to get an `itemId` to use with EWS or the REST API),
15054
15060
  * be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server.
@@ -15066,7 +15072,7 @@ declare namespace Office {
15066
15072
  * - `ItemNotSaved`: The id can't be retrieved until the item is saved.
15067
15073
  *
15068
15074
  * @param options - An object literal that contains one or more of the following properties.
15069
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
15075
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
15070
15076
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
15071
15077
  * of type `Office.AsyncResult`.
15072
15078
  */
@@ -15074,7 +15080,7 @@ declare namespace Office {
15074
15080
  /**
15075
15081
  * Asynchronously gets the ID of a saved item.
15076
15082
  *
15077
- * When invoked, this method returns the item ID via the callback method.
15083
+ * When invoked, this method returns the item ID via the callback function.
15078
15084
  *
15079
15085
  * **Note**: If your add-in calls `getItemIdAsync` on an item in compose mode (e.g., to get an `itemId` to use with EWS or the REST API),
15080
15086
  * be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server.
@@ -15101,7 +15107,7 @@ declare namespace Office {
15101
15107
  * If there is no selection but the cursor is in the body or subject, the method returns an empty string for the selected data.
15102
15108
  * If a field other than the body or subject is selected, the method returns the `InvalidSelection` error.
15103
15109
  *
15104
- * To access the selected data from the callback method, call `asyncResult.value.data`.
15110
+ * To access the selected data from the callback function, call `asyncResult.value.data`.
15105
15111
  * To access the source property that the selection comes from, call `asyncResult.value.sourceProperty`, which will be either `body` or `subject`.
15106
15112
  *
15107
15113
  * @returns
@@ -15117,7 +15123,7 @@ declare namespace Office {
15117
15123
  * @param coercionType - Requests a format for the data. If `Text`, the method returns the plain text as a string, removing any HTML tags present.
15118
15124
  * If `Html`, the method returns the selected text, whether it is plaintext or HTML.
15119
15125
  * @param options - An object literal that contains one or more of the following properties.
15120
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
15126
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
15121
15127
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
15122
15128
  * type `Office.AsyncResult`.
15123
15129
  */
@@ -15128,7 +15134,7 @@ declare namespace Office {
15128
15134
  * If there is no selection but the cursor is in the body or subject, the method returns an empty string for the selected data.
15129
15135
  * If a field other than the body or subject is selected, the method returns the `InvalidSelection` error.
15130
15136
  *
15131
- * To access the selected data from the callback method, call `asyncResult.value.data`.
15137
+ * To access the selected data from the callback function, call `asyncResult.value.data`.
15132
15138
  * To access the source property that the selection comes from, call `asyncResult.value.sourceProperty`, which will be either `body` or `subject`.
15133
15139
  *
15134
15140
  * @returns
@@ -15174,7 +15180,7 @@ declare namespace Office {
15174
15180
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
15175
15181
  *
15176
15182
  * @param options - An object literal that contains one or more of the following properties.
15177
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
15183
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
15178
15184
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
15179
15185
  * type `Office.AsyncResult`. The `value` property of the result is the properties of the shared item.
15180
15186
  */
@@ -15225,7 +15231,7 @@ declare namespace Office {
15225
15231
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
15226
15232
  *
15227
15233
  * @param options - An object literal that contains one or more of the following properties.
15228
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
15234
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
15229
15235
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
15230
15236
  * type `Office.AsyncResult`.
15231
15237
  */
@@ -15295,7 +15301,7 @@ declare namespace Office {
15295
15301
  * @param attachmentId - The identifier of the attachment to remove. The maximum string length of the `attachmentId`
15296
15302
  * is 200 characters in Outlook on the web and on Windows.
15297
15303
  * @param options - An object literal that contains one or more of the following properties.
15298
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
15304
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
15299
15305
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
15300
15306
  * type `Office.AsyncResult`. If removing the attachment fails, the `asyncResult.error` property will contain an error code
15301
15307
  * with the reason for the failure.
@@ -15343,7 +15349,7 @@ declare namespace Office {
15343
15349
  *
15344
15350
  * @param eventType - The event that should revoke the handler.
15345
15351
  * @param options - An object literal that contains one or more of the following properties.
15346
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
15352
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
15347
15353
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
15348
15354
  * `asyncResult`, which is an `Office.AsyncResult` object.
15349
15355
  */
@@ -15369,7 +15375,7 @@ declare namespace Office {
15369
15375
  /**
15370
15376
  * Asynchronously saves an item.
15371
15377
  *
15372
- * When invoked, this method saves the current message as a draft and returns the item ID via the callback method.
15378
+ * When invoked, this method saves the current message as a draft and returns the item ID via the callback function.
15373
15379
  * In Outlook on the web or Outlook in online mode, the item is saved to the server.
15374
15380
  * In Outlook in cached mode, the item is saved to the local cache.
15375
15381
  *
@@ -15396,7 +15402,7 @@ declare namespace Office {
15396
15402
  * - `InvalidAttachmentId`: The attachment identifier does not exist.
15397
15403
  *
15398
15404
  * @param options - An object literal that contains one or more of the following properties.
15399
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
15405
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
15400
15406
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
15401
15407
  * type `Office.AsyncResult`.
15402
15408
  */
@@ -15404,7 +15410,7 @@ declare namespace Office {
15404
15410
  /**
15405
15411
  * Asynchronously saves an item.
15406
15412
  *
15407
- * When invoked, this method saves the current message as a draft and returns the item id via the callback method.
15413
+ * When invoked, this method saves the current message as a draft and returns the item id via the callback function.
15408
15414
  * In Outlook on the web or Outlook in online mode, the item is saved to the server.
15409
15415
  * In Outlook in cached mode, the item is saved to the local cache.
15410
15416
  *
@@ -15455,7 +15461,7 @@ declare namespace Office {
15455
15461
  * @param data - The data to be inserted. Data is not to exceed 1,000,000 characters.
15456
15462
  * If more than 1,000,000 characters are passed in, an `ArgumentOutOfRange` exception is thrown.
15457
15463
  * @param options - An object literal that contains one or more of the following properties.
15458
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
15464
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
15459
15465
  * `coercionType`: If text, the current style is applied in Outlook on the web and desktop clients.
15460
15466
  * If the field is an HTML editor, only the text data is inserted, even if the data is HTML.
15461
15467
  * 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
@@ -15880,7 +15886,7 @@ declare namespace Office {
15880
15886
  * @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
15881
15887
  * The `type` property on the parameter will match the eventType `parameter` passed to `addHandlerAsync`.
15882
15888
  * @param options - An object literal that contains one or more of the following properties.
15883
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
15889
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
15884
15890
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
15885
15891
  * `asyncResult`, which is an `Office.AsyncResult` object.
15886
15892
  */
@@ -15951,7 +15957,7 @@ declare namespace Office {
15951
15957
  * @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
15952
15958
  * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
15953
15959
  * @param options - An object literal that contains one or more of the following properties.
15954
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
15960
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
15955
15961
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
15956
15962
  * `asyncResult`, which is an `Office.AsyncResult` object.
15957
15963
  */
@@ -16026,7 +16032,7 @@ declare namespace Office {
16026
16032
  * @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
16027
16033
  * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
16028
16034
  * @param options - An object literal that contains one or more of the following properties.
16029
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
16035
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
16030
16036
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
16031
16037
  * `asyncResult`, which is an `Office.AsyncResult` object.
16032
16038
  */
@@ -16070,7 +16076,7 @@ declare namespace Office {
16070
16076
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
16071
16077
  *
16072
16078
  * @param options - An object literal that contains one or more of the following properties.
16073
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
16079
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
16074
16080
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
16075
16081
  * `asyncResult`, which is an `Office.AsyncResult` object.
16076
16082
  * On success, the internet headers data is provided in the `asyncResult.value` property as a string.
@@ -16123,7 +16129,7 @@ declare namespace Office {
16123
16129
  *
16124
16130
  * @param attachmentId - The identifier of the attachment you want to get.
16125
16131
  * @param options - An object literal that contains one or more of the following properties.
16126
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
16132
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
16127
16133
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
16128
16134
  * `asyncResult`, which is an `Office.AsyncResult` object. If the call fails, the `asyncResult.error` property will contain
16129
16135
  * an error code with the reason for the failure.
@@ -16368,7 +16374,7 @@ declare namespace Office {
16368
16374
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
16369
16375
  *
16370
16376
  * @param options - An object literal that contains one or more of the following properties.
16371
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
16377
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
16372
16378
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
16373
16379
  * type `Office.AsyncResult`. The `value` property of the result is the properties of the shared item.
16374
16380
  */
@@ -16429,7 +16435,7 @@ declare namespace Office {
16429
16435
  *
16430
16436
  * @param eventType - The event that should revoke the handler.
16431
16437
  * @param options - An object literal that contains one or more of the following properties.
16432
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
16438
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
16433
16439
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
16434
16440
  * `asyncResult`, which is an `Office.AsyncResult` object.
16435
16441
  */
@@ -16567,7 +16573,7 @@ declare namespace Office {
16567
16573
  * @param JSONmessage - A JSON object that contains the notification message to be added to the item.
16568
16574
  * It contains a `NotificationMessageDetails` object.
16569
16575
  * @param options - An object literal that contains one or more of the following properties.
16570
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
16576
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
16571
16577
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
16572
16578
  * of type `Office.AsyncResult`.
16573
16579
  */
@@ -16603,7 +16609,7 @@ declare namespace Office {
16603
16609
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
16604
16610
  *
16605
16611
  * @param options - An object literal that contains one or more of the following properties.
16606
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
16612
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
16607
16613
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
16608
16614
  * of type `Office.AsyncResult`. The `value` property of the result is an array of `NotificationMessageDetails` objects.
16609
16615
  */
@@ -16634,7 +16640,7 @@ declare namespace Office {
16634
16640
  *
16635
16641
  * @param key - The key for the notification message to remove.
16636
16642
  * @param options - An object literal that contains one or more of the following properties.
16637
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
16643
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
16638
16644
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
16639
16645
  * of type `Office.AsyncResult`.
16640
16646
  */
@@ -16670,7 +16676,7 @@ declare namespace Office {
16670
16676
  * @param JSONmessage - A JSON object that contains the new notification message to replace the existing message.
16671
16677
  * It contains a `NotificationMessageDetails` object.
16672
16678
  * @param options - An object literal that contains one or more of the following properties.
16673
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
16679
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
16674
16680
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
16675
16681
  * of type `Office.AsyncResult`.
16676
16682
  */
@@ -16722,7 +16728,7 @@ declare namespace Office {
16722
16728
  * The appointment organizer is always a user whose email address is on the Exchange server.
16723
16729
  *
16724
16730
  * @param options - An object literal that contains one or more of the following properties.
16725
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
16731
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
16726
16732
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
16727
16733
  * `asyncResult`, which is an `AsyncResult` object. The `value` property of the result is the appointment's organizer value,
16728
16734
  * as an `EmailAddressDetails` object.
@@ -16819,7 +16825,7 @@ declare namespace Office {
16819
16825
  *
16820
16826
  * @param recipients - The recipients to add to the recipients list.
16821
16827
  * @param options - An object literal that contains one or more of the following properties.
16822
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
16828
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
16823
16829
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
16824
16830
  * of type `Office.AsyncResult`. If adding the recipients fails, the `asyncResult.error` property will contain an error code.
16825
16831
  */
@@ -16870,11 +16876,6 @@ declare namespace Office {
16870
16876
  *
16871
16877
  * - New Mac UI, Android: No limit
16872
16878
  *
16873
- * **Important**: In Outlook on the web, if a user created a new message by activating a contact's email address link from their contact or
16874
- * profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
16875
- * associated `EmailAddressDetails` object. For more details, refer to the
16876
- * {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
16877
- *
16878
16879
  * @remarks
16879
16880
  * [Api set: Mailbox 1.1]
16880
16881
  *
@@ -16882,8 +16883,26 @@ declare namespace Office {
16882
16883
  *
16883
16884
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
16884
16885
  *
16886
+ * **Important**: In Outlook on the web and on Windows, if a user creates a new message by activating a contact's email address link from their contact
16887
+ * or profile card, your add-in's `Recipients.getAsync` call returns the contact's email address in the `displayName` property of the associated
16888
+ * `EmailAddressDetails` object instead of the contact's saved name. For more details, refer to the
16889
+ * {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
16890
+ *
16891
+ * **Important**: The `getAsync` method only returns recipients resolved by the Outlook client. A resolved recipient has the following characteristics.
16892
+ *
16893
+ * - If the recipient has a saved entry in the sender's address book, Outlook resolves the email address to the recipient's saved display name.
16894
+ *
16895
+ * - A Teams meeting status icon appears before the recipient's name or email address.
16896
+ *
16897
+ * - A semicolon appears after the recipient's name or email address.
16898
+ *
16899
+ * - The recipient's name or email address is underlined or enclosed in a box.
16900
+ *
16901
+ * To resolve an email address once it's added to a mail item, the sender must use the **Tab** key or select a suggested contact or email address from
16902
+ * the auto-complete list.
16903
+ *
16885
16904
  * @param options - An object literal that contains one or more of the following properties.
16886
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
16905
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
16887
16906
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
16888
16907
  * of type `Office.AsyncResult`. The `value` property of the result is an array of `EmailAddressDetails` objects.
16889
16908
  */
@@ -16898,11 +16917,6 @@ declare namespace Office {
16898
16917
  *
16899
16918
  * - New Mac UI, Android: No limit
16900
16919
  *
16901
- * **Important**: In Outlook on the web, if a user created a new message by activating a contact's email address link from their contact or
16902
- * profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
16903
- * associated `EmailAddressDetails` object. For more details, refer to the
16904
- * {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
16905
- *
16906
16920
  * @remarks
16907
16921
  * [Api set: Mailbox 1.1]
16908
16922
  *
@@ -16910,6 +16924,24 @@ declare namespace Office {
16910
16924
  *
16911
16925
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
16912
16926
  *
16927
+ * **Important**: In Outlook on the web and on Windows, if a user creates a new message by activating a contact's email address link from their contact
16928
+ * or profile card, your add-in's `Recipients.getAsync` call returns the contact's email address in the `displayName` property of the associated
16929
+ * `EmailAddressDetails` object instead of the contact's saved name. For more details, refer to the
16930
+ * {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
16931
+ *
16932
+ * **Important**: The `getAsync` method only returns recipients resolved by the Outlook client. A resolved recipient has the following characteristics.
16933
+ *
16934
+ * - If the recipient has a saved entry in the sender's address book, Outlook resolves the email address to the recipient's saved display name.
16935
+ *
16936
+ * - A Teams meeting status icon appears before the recipient's name or email address.
16937
+ *
16938
+ * - A semicolon appears after the recipient's name or email address.
16939
+ *
16940
+ * - The recipient's name or email address is underlined or enclosed in a box.
16941
+ *
16942
+ * To resolve an email address once it's added to a mail item, the sender must use the **Tab** key or select a suggested contact or email address from
16943
+ * the auto-complete list.
16944
+ *
16913
16945
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
16914
16946
  * of type `Office.AsyncResult`. The `value` property of the result is an array of `EmailAddressDetails` objects.
16915
16947
  */
@@ -16949,7 +16981,7 @@ declare namespace Office {
16949
16981
  *
16950
16982
  * @param recipients - The recipients to add to the recipients list.
16951
16983
  * @param options - An object literal that contains one or more of the following properties.
16952
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
16984
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
16953
16985
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
16954
16986
  * type `Office.AsyncResult`. If setting the recipients fails the `asyncResult.error` property will contain a code that
16955
16987
  * indicates any error that occurred while adding the data.
@@ -17180,7 +17212,7 @@ declare namespace Office {
17180
17212
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
17181
17213
  *
17182
17214
  * @param options - An object literal that contains one or more of the following properties.
17183
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
17215
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
17184
17216
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
17185
17217
  * `asyncResult`, which is an `Office.AsyncResult` object. The `value` property of the result is a `Recurrence` object.
17186
17218
  */
@@ -17219,7 +17251,7 @@ declare namespace Office {
17219
17251
  *
17220
17252
  * @param recurrencePattern - A recurrence object.
17221
17253
  * @param options - An object literal that contains one or more of the following properties.
17222
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
17254
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
17223
17255
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
17224
17256
  * `asyncResult`, which is an `Office.AsyncResult` object.
17225
17257
  */
@@ -17378,7 +17410,7 @@ declare namespace Office {
17378
17410
  callback?: (asyncResult: Office.AsyncResult<any>) => void;
17379
17411
  /**
17380
17412
  * An object literal that contains the following property.
17381
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
17413
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
17382
17414
  */
17383
17415
  options?: Office.AsyncContextOptions;
17384
17416
  }
@@ -17462,7 +17494,7 @@ declare namespace Office {
17462
17494
  *
17463
17495
  * A maximum of 32KB is available for the settings of each add-in.
17464
17496
  *
17465
- * Any changes made to settings using the set function will not be saved to the server until the `saveAsync` function is called.
17497
+ * Any changes made to settings using the `set` method will not be saved to the server until the `saveAsync` method is called.
17466
17498
  *
17467
17499
  * @remarks
17468
17500
  *
@@ -17672,7 +17704,7 @@ declare namespace Office {
17672
17704
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
17673
17705
  *
17674
17706
  * @param options - An object literal that contains one or more of the following properties.
17675
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
17707
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
17676
17708
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
17677
17709
  * `asyncResult`, which is an `Office.AsyncResult` object.
17678
17710
  */
@@ -17732,7 +17764,7 @@ declare namespace Office {
17732
17764
  *
17733
17765
  * @param name - The session data key.
17734
17766
  * @param options - An object literal that contains one or more of the following properties.
17735
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
17767
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
17736
17768
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
17737
17769
  * `asyncResult`, which is an `Office.AsyncResult` object.
17738
17770
  */
@@ -17767,7 +17799,7 @@ declare namespace Office {
17767
17799
  * @param name - The session data key.
17768
17800
  * @param value - The session data value as a string.
17769
17801
  * @param options - An object literal that contains one or more of the following properties.
17770
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
17802
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
17771
17803
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
17772
17804
  * type `Office.AsyncResult`.
17773
17805
  */
@@ -17854,7 +17886,7 @@ declare namespace Office {
17854
17886
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
17855
17887
  *
17856
17888
  * @param options - An object literal that contains one or more of the following properties.
17857
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
17889
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
17858
17890
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
17859
17891
  * of type `Office.AsyncResult`. The `value` property of the result is the subject of the item.
17860
17892
  */
@@ -17894,7 +17926,7 @@ declare namespace Office {
17894
17926
  *
17895
17927
  * @param subject - The subject of the appointment or message. The string is limited to 255 characters.
17896
17928
  * @param options - An object literal that contains one or more of the following properties.
17897
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
17929
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
17898
17930
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
17899
17931
  * of type `Office.AsyncResult`. If setting the subject fails, the `asyncResult.error` property will contain an error code.
17900
17932
  */
@@ -17969,7 +18001,7 @@ declare namespace Office {
17969
18001
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
17970
18002
  *
17971
18003
  * @param options - An object literal that contains one or more of the following properties.
17972
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
18004
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
17973
18005
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
17974
18006
  * of type `Office.AsyncResult`. The `value` property of the result is a `Date` object.
17975
18007
  */
@@ -17999,7 +18031,7 @@ declare namespace Office {
17999
18031
  *
18000
18032
  * The time must be in UTC; you can get the correct UTC time by using the `convertToUtcClientTime` method.
18001
18033
  *
18002
- * **Important**: In the Windows client, you can't use this function to update the start or end of a recurrence.
18034
+ * **Important**: In the Windows client, you can't use this method to update the start or end of a recurrence.
18003
18035
  *
18004
18036
  * @remarks
18005
18037
  * [Api set: Mailbox 1.1]
@@ -18014,7 +18046,7 @@ declare namespace Office {
18014
18046
  *
18015
18047
  * @param dateTime - A date-time object in Coordinated Universal Time (UTC).
18016
18048
  * @param options - An object literal that contains one or more of the following properties.
18017
- * `asyncContext`: Developers can provide any object they wish to access in the callback method.
18049
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
18018
18050
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
18019
18051
  * type `Office.AsyncResult`. If setting the date and time fails, the `asyncResult.error` property will contain an error code.
18020
18052
  */
@@ -18027,7 +18059,7 @@ declare namespace Office {
18027
18059
  *
18028
18060
  * The time must be in UTC; you can get the correct UTC time by using the `convertToUtcClientTime` method.
18029
18061
  *
18030
- * **Important**: In the Windows client, you can't use this function to update the start or end of a recurrence.
18062
+ * **Important**: In the Windows client, you can't use this method to update the start or end of a recurrence.
18031
18063
  *
18032
18064
  * @remarks
18033
18065
  * [Api set: Mailbox 1.1]
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.264",
3
+ "version": "1.0.267",
4
4
  "description": "TypeScript definitions for Office.js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "f0822c3fd2ef892ade805fdfe0e108ca6334ae77f1ec07268d15b5e7ee5bd01a",
48
+ "typesPublisherContentHash": "5bbd6180ead5877b5d7fe23077dceac281d5f3465d3394d9c37bcfbfdcd51cce",
49
49
  "typeScriptVersion": "4.0"
50
50
  }