vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-06-28 22:30:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Removing links to Office.AsyncResult

Browse Source
This commit is contained in:
Alex Jerabek
2018-08-27 11:46:34 -07:00
parent cd1db00d94
commit 228eb22291
1 changed files with 109 additions and 109 deletions
Download Patch File Download Diff File Expand all files Collapse all files

218
types/office-js/index.d.ts vendored
View File

@@ -8618,7 +8618,7 @@ declare namespace Office {
* <tr><td>{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}</td><td>Compose or read</td></tr></table>
*
* @param coercionType The format for the returned body.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type {@link Office.AsyncResult}.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult.
* The body is provided in the requested format in the asyncResult.value property.
*/
getAsync(coerciontype: Office.CoercionType, callback: (result: AsyncResult<Office.Body>) => void): void;
@@ -8635,7 +8635,7 @@ declare namespace Office {
*
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type {@link Office.AsyncResult}.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult.
* The content type is returned as one of the CoercionType values in the asyncResult.value property.
*/
getTypeAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<Office.CoercionType>) => void): void;
@@ -8669,7 +8669,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* coercionType: The desired format for the body. The string in the data parameter will be converted to this format.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type {@link Office.AsyncResult}.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult.
* Any errors encountered will be provided in the asyncResult.error property.
*/
prependAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: AsyncResult<void>) => void): void;
@@ -8714,7 +8714,7 @@ declare namespace Office {
* <tr><td>Errors</td><td>DataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters.</td></tr></table>
*
* @param data The string to be inserted at the beginning of the body. The string is limited to 1,000,000 characters.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type {@link Office.AsyncResult}.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult.
* Any errors encountered will be provided in the asyncResult.error property.
*/
prependAsync(data: string, callback: (result: AsyncResult<void>) => void): void;
@@ -8768,7 +8768,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* coercionType: The desired format for the body. The string in the data parameter will be converted to this format.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type {@link Office.AsyncResult}.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult.
* Any errors encountered will be provided in the asyncResult.error property.
*/
setAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: AsyncResult<void>) => void): void;
@@ -8817,7 +8817,7 @@ declare namespace Office {
* <tr><td>Errors</td><td>DataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters.</td></tr><tr><td></td><td>InvalidFormatError - The options.coercionType parameter is set to Office.CoercionType.Html and the message body is in plain text.</td></tr></table>
*
* @param data The string that will replace the existing body. The string is limited to 1,000,000 characters.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type {@link Office.AsyncResult}.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult.
* Any errors encountered will be provided in the asyncResult.error property.
*/
setAsync(data: string, callback: (result: AsyncResult<void>) => void): void;
@@ -8875,7 +8875,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* coercionType: The desired format for the body. The string in the data parameter will be converted to this format.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type {@link Office.AsyncResult}.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult.
* Any errors encountered will be provided in the asyncResult.error property.
*/
setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: AsyncResult<void>) => void): void;
@@ -8924,7 +8924,7 @@ declare namespace Office {
* <tr><td>Errors</td><td>DataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters.</td></tr><tr><td></td><td>InvalidFormatError - The options.coercionType parameter is set to Office.CoercionType.Html and the message body is in plain text.</td></tr></table>
*
* @param data The string that will replace the existing body. The string is limited to 1,000,000 characters.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type {@link Office.AsyncResult}.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult.
* Any errors encountered will be provided in the asyncResult.error property.
*/
setSelectedDataAsync(data: string, callback: (result: AsyncResult<void>) => void): void;
@@ -9066,7 +9066,7 @@ declare namespace Office {
* Your callback method should handle this error accordingly.
*
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* @param asyncContext Optional. Any state data that is passed to the callback method.
*
* [Api set: Mailbox 1.0]
@@ -9286,7 +9286,7 @@ declare namespace Office {
*
* @param options An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an {@link Office.AsyncResult} object.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an Office.AsyncResult object.
* The `value` property of the result is message's from value, as an EmailAddressDetails object.
*/
getAsync(options: Office.AsyncContextOptions, callback: (result: AsyncResult<Office.EmailAddressDetails>) => void): void;
@@ -9305,7 +9305,7 @@ declare namespace Office {
*
* <tr><td>{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}</td><td>Compose</td></tr></table>
*
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an {@link Office.AsyncResult} object.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an Office.AsyncResult object.
* The `value` property of the result is message's from value, as an EmailAddressDetails object.
*/
getAsync(callback?: (result: AsyncResult<Office.EmailAddressDetails>) => void): void;
@@ -9727,7 +9727,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -9750,7 +9750,7 @@ declare namespace Office {
* @param handler The function to handle the event. The function must accept a single parameter, which is an object literal.
* The type property on the parameter will match the eventType parameter passed to addHandlerAsync.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -9789,7 +9789,7 @@ declare namespace Office {
* @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
* @param options An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type {@link Office.AsyncResult}.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult.
* On success, the attachment identifier will be provided in the asyncResult.value property.
* If adding the attachment fails, the asyncResult object will contain an Error object that provides a description of the error.
*/
@@ -9872,7 +9872,7 @@ declare namespace Office {
*
* @param itemId The Exchange identifier of the item to attach. The maximum length is 100 characters.
* @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type {@link Office.AsyncResult}.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult.
* On success, the attachment identifier will be provided in the asyncResult.value property.
* If adding the attachment fails, the asyncResult object will contain an Error object that provides a description of the error.
*/
@@ -9914,7 +9914,7 @@ declare namespace Office {
*
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type {@link Office.AsyncResult}.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult.
* On success, the initialization data is provided in the asyncResult.value property as a string.
* If there is no initialization context, the asyncResult object will contain an Error object with its code property set to 9020 and its name property set to GenericResponseError.
*
@@ -9971,7 +9971,7 @@ declare namespace Office {
* @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string , removing any HTML tags present.
* If HTML, the method returns the selected text, whether it is plaintext or HTML.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*/
getSelectedDataAsync(coerciontype: Office.CoercionType, callback: (result: AsyncResult<string>) => void): void;
/**
@@ -9994,7 +9994,7 @@ declare namespace Office {
* <tr><td>{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}</td><td>Appointment Organizer</td></tr></table>
*
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* @param userContext Optional. Developers can provide any object they wish to access in the callback function.
* This object can be accessed by the asyncResult.asyncContext property in the callback function.
*/
@@ -10029,7 +10029,7 @@ declare namespace Office {
* @param attachmentIndex The identifier of the attachment to remove. The maximum length of the string is 100 characters.
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type {@link Office.AsyncResult}.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult.
* If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure.
*/
removeAttachmentAsync(attachmentIndex: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
@@ -10101,7 +10101,7 @@ declare namespace Office {
*
* @param attachmentIndex The identifier of the attachment to remove. The maximum length of the string is 100 characters.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure.
*/
removeAttachmentAsync(attachmentIndex: string, callback: (result: AsyncResult<void>) => void): void;
@@ -10129,7 +10129,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -10151,7 +10151,7 @@ declare namespace Office {
* @param handler The function to handle the event. The function must accept a single parameter, which is an object literal.
* The type property on the parameter will match the eventType parameter passed to removeHandlerAsync.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -10197,7 +10197,7 @@ declare namespace Office {
*
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type {@link Office.AsyncResult}.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult.
*/
saveAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
/**
@@ -10298,7 +10298,7 @@ declare namespace Office {
*
* <tr><td>Errors</td><td>InvalidAttachmentId - The attachment identifier does not exist.</td></tr></table>
*
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type {@link Office.AsyncResult}.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult.
*/
saveAsync(callback: (result: AsyncResult<void>) => void): void;
/**
@@ -10338,7 +10338,7 @@ declare namespace Office {
* If coercionType is not set, the result depends on the field: if the field is HTML then HTML is used;
* if the field is text, then plain text is used.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*/
setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: AsyncResult<void>) => void): void;
/**
@@ -10411,7 +10411,7 @@ declare namespace Office {
* @param data The data to be inserted. Data is not to exceed 1,000,000 characters.
* If more than 1,000,000 characters are passed in, an ArgumentOutOfRange exception is thrown.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*/
setSelectedDataAsync(data: string, callback: (result: AsyncResult<void>) => void): void;
}
@@ -10752,7 +10752,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -10776,7 +10776,7 @@ declare namespace Office {
* @param handler The function to handle the event. The function must accept a single parameter, which is an object literal.
* The type property on the parameter will match the eventType parameter passed to addHandlerAsync.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -10854,7 +10854,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
* On success, the initialization data is provided in the asyncResult.value property as a string.
* If there is no initialization context, the asyncResult object will contain an Error object with its code property
* set to 9020 and its name property set to GenericResponseError.
@@ -10876,7 +10876,7 @@ declare namespace Office {
* <tr><td>{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}</td><td>Appointment Attendee</td></tr></table>
*
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
* On success, the initialization data is provided in the asyncResult.value property as a string.
* If there is no initialization context, the asyncResult object will contain an Error object with its code property
* set to 9020 and its name property set to GenericResponseError.
@@ -11107,7 +11107,7 @@ declare namespace Office {
* <tr><td>{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}</td><td>Appointment Attendee</td></tr></table>
*
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* @param userContext Optional. Developers can provide any object they wish to access in the callback function.
* This object can be accessed by the asyncResult.asyncContext property in the callback function.
*/
@@ -11137,7 +11137,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -11160,7 +11160,7 @@ declare namespace Office {
* @param handler The function to handle the event. The function must accept a single parameter, which is an object literal.
* The type property on the parameter will match the eventType parameter passed to removeHandlerAsync.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -11319,7 +11319,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -11342,7 +11342,7 @@ declare namespace Office {
* @param handler The function to handle the event. The function must accept a single parameter, which is an object literal.
* The type property on the parameter will match the eventType parameter passed to addHandlerAsync.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -11368,7 +11368,7 @@ declare namespace Office {
* <tr><td>{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}</td><td>Compose or read</td></tr></table>
*
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* @param userContext Optional. Developers can provide any object they wish to access in the callback function.
* This object can be accessed by the asyncResult.asyncContext property in the callback function.
*/
@@ -11398,7 +11398,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -11422,7 +11422,7 @@ declare namespace Office {
* @param handler The function to handle the event. The function must accept a single parameter, which is an object literal.
* The type property on the parameter will match the eventType parameter passed to removeHandlerAsync.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -11550,7 +11550,7 @@ declare namespace Office {
* @param uri The URI that provides the location of the file to attach to the message or appointment. The maximum length is 2048 characters.
* @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}. On success, the attachment identifier will be provided in the asyncResult.value property.
* type Office.AsyncResult. On success, the attachment identifier will be provided in the asyncResult.value property.
* If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of
* the error.
*/
@@ -11618,7 +11618,7 @@ declare namespace Office {
* @param options An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}. On success, the attachment identifier will be provided in the asyncResult.value property.
* type Office.AsyncResult. On success, the attachment identifier will be provided in the asyncResult.value property.
* If adding the attachment fails, the asyncResult object will contain an Error object that provides a description of
* the error.
*/
@@ -11702,7 +11702,7 @@ declare namespace Office {
* @param itemId The Exchange identifier of the item to attach. The maximum length is 100 characters.
* @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}. On success, the attachment identifier will be provided in the asyncResult.value property.
* type Office.AsyncResult. On success, the attachment identifier will be provided in the asyncResult.value property.
* If adding the attachment fails, the asyncResult object will contain an Error object that provides a description of
* the error.
*/
@@ -11746,7 +11746,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* On success, the initialization data is provided in the asyncResult.value property as a string.
* If there is no initialization context, the asyncResult object will contain an Error object with its code property
* set to 9020 and its name property set to GenericResponseError.
@@ -11777,7 +11777,7 @@ declare namespace Office {
* @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string , removing any HTML tags present.
* If HTML, the method returns the selected text, whether it is plaintext or HTML.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*/
getSelectedDataAsync(coerciontype: Office.CoercionType, callback: (result: AsyncResult<any>) => void): void;
/**
@@ -11805,7 +11805,7 @@ declare namespace Office {
* @param options An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*/
getSelectedDataAsync(coerciontype: Office.CoercionType, options: Office.AsyncContextOptions, callback: (result: AsyncResult<any>) => void): void;
/**
@@ -11839,7 +11839,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure.
*/
removeAttachmentAsync(attachmentIndex: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
@@ -11957,7 +11957,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure.
*/
saveAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
@@ -12061,7 +12061,7 @@ declare namespace Office {
* <tr><td>Errors</td><td>InvalidAttachmentId - The attachment identifier does not exist.</td></tr></table>
*
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure.
*/
saveAsync(callback: (result: AsyncResult<void>) => void): void;
@@ -12102,7 +12102,7 @@ declare namespace Office {
* If coercionType is not set, the result depends on the field: if the field is HTML then HTML is used;
* if the field is text, then plain text is used.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*/
setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: AsyncResult<void>) => void): void;
/**
@@ -12176,7 +12176,7 @@ declare namespace Office {
* @param data The data to be inserted. Data is not to exceed 1,000,000 characters.
* If more than 1,000,000 characters are passed in, an ArgumentOutOfRange exception is thrown.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*/
setSelectedDataAsync(data: string, callback: (result: AsyncResult<void>) => void): void;
}
@@ -12365,7 +12365,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
* On success, the initialization data is provided in the asyncResult.value property as a string.
* If there is no initialization context, the asyncResult object will contain an Error object with its code property
* set to 9020 and its name property set to GenericResponseError.
@@ -12388,7 +12388,7 @@ declare namespace Office {
* <tr><td>{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}</td><td>Read</td></tr></table>
*
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
* On success, the initialization data is provided in the asyncResult.value property as a string.
* If there is no initialization context, the asyncResult object will contain an Error object with its code property
* set to 9020 and its name property set to GenericResponseError.
@@ -12877,7 +12877,7 @@ declare namespace Office {
* isInline: If true, indicates that the attachment will be shown inline in the message body, and should not be displayed in the
* attachment list.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.asyncResult}. On success, the attachment identifier will be provided in the asyncResult.value property.
* type Office.AsyncResult. On success, the attachment identifier will be provided in the asyncResult.value property.
* If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of
* the error.
*/
@@ -12944,7 +12944,7 @@ declare namespace Office {
* @param uri The URI that provides the location of the file to attach to the message or appointment. The maximum length is 2048 characters.
* @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}. On success, the attachment identifier will be provided in the asyncResult.value property.
* type Office.AsyncResult. On success, the attachment identifier will be provided in the asyncResult.value property.
* If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of
* the error.
*/
@@ -12998,7 +12998,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -13021,7 +13021,7 @@ declare namespace Office {
* @param handler The function to handle the event. The function must accept a single parameter, which is an object literal.
* The type property on the parameter will match the eventType parameter passed to addHandlerAsync.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -13145,7 +13145,7 @@ declare namespace Office {
* @param itemId The Exchange identifier of the item to attach. The maximum length is 100 characters.
* @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}. On success, the attachment identifier will be provided in the asyncResult.value property.
* type Office.AsyncResult. On success, the attachment identifier will be provided in the asyncResult.value property.
* If adding the attachment fails, the asyncResult object will contain an Error object that provides a description of
* the error.
*/
@@ -13189,7 +13189,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* On success, the initialization data is provided in the asyncResult.value property as a string.
* If there is no initialization context, the asyncResult object will contain an Error object with its code property
* set to 9020 and its name property set to GenericResponseError.
@@ -13220,7 +13220,7 @@ declare namespace Office {
* @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string, removing any HTML tags present.
* If HTML, the method returns the selected text, whether it is plaintext or HTML.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*/
getSelectedDataAsync(coerciontype: Office.CoercionType, callback: (result: AsyncResult<any>) => void): void;
/**
@@ -13248,7 +13248,7 @@ declare namespace Office {
* @param options An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*/
getSelectedDataAsync(coerciontype: Office.CoercionType, options: Office.AsyncContextOptions, callback: (result: AsyncResult<any>) => void): void;
/**
@@ -13271,7 +13271,7 @@ declare namespace Office {
* <tr><td>{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}</td><td>Message Compose</td></tr></table>
*
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* @param userContext Optional. Developers can provide any object they wish to access in the callback function.
* This object can be accessed by the asyncResult.asyncContext property in the callback function.
*/
@@ -13307,7 +13307,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure.
*/
removeAttachmentAsync(attachmentIndex: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
@@ -13378,7 +13378,7 @@ declare namespace Office {
*
* @param attachmentIndex The identifier of the attachment to remove. The maximum length of the string is 100 characters.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure.
*/
removeAttachmentAsync(attachmentIndex: string, callback: (result: AsyncResult<void>) => void): void;
@@ -13406,7 +13406,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -13429,7 +13429,7 @@ declare namespace Office {
* @param handler The function to handle the event. The function must accept a single parameter, which is an object literal.
* The type property on the parameter will match the eventType parameter passed to removeHandlerAsync.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -13476,7 +13476,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*/
saveAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
/**
@@ -13578,7 +13578,7 @@ declare namespace Office {
* <tr><td>Errors</td><td>InvalidAttachmentId - The attachment identifier does not exist.</td></tr></table>
*
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*/
saveAsync(callback: (result: AsyncResult<void>) => void): void;
/**
@@ -13617,7 +13617,7 @@ declare namespace Office {
* If coercionType is not set, the result depends on the field: if the field is HTML then HTML is used;
* if the field is text, then plain text is used.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*/
setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: AsyncResult<void>) => void): void;
/**
@@ -13690,7 +13690,7 @@ declare namespace Office {
* @param data The data to be inserted. Data is not to exceed 1,000,000 characters.
* If more than 1,000,000 characters are passed in, an ArgumentOutOfRange exception is thrown.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type{@link Office.AsyncResult}.
* typeOffice.AsyncResult.
*/
setSelectedDataAsync(data: string, callback: (result: AsyncResult<void>) => void): void;
}
@@ -14046,7 +14046,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -14070,7 +14070,7 @@ declare namespace Office {
* @param handler The function to handle the event. The function must accept a single parameter, which is an object literal.
* The type property on the parameter will match the eventType parameter passed to addHandlerAsync.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -14149,7 +14149,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
* On success, the initialization data is provided in the asyncResult.value property as a string.
* If there is no initialization context, the asyncResult object will contain an Error object with its code property
* set to 9020 and its name property set to GenericResponseError.
@@ -14173,7 +14173,7 @@ declare namespace Office {
* <tr><td>{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}</td><td>Message Read</td></tr></table>
*
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
* On success, the initialization data is provided in the asyncResult.value property as a string.
* If there is no initialization context, the asyncResult object will contain an Error object with its code property
* set to 9020 and its name property set to GenericResponseError.
@@ -14406,7 +14406,7 @@ declare namespace Office {
* <tr><td>{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}</td><td>Message Read</td></tr></table>
*
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* @param userContext Optional. Developers can provide any object they wish to access in the callback function.
* This object can be accessed by the asyncResult.asyncContext property in the callback function.
*/
@@ -14435,7 +14435,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -14458,7 +14458,7 @@ declare namespace Office {
* @param handler The function to handle the event. The function must accept a single parameter, which is an object literal.
* The type property on the parameter will match the eventType parameter passed to removeHandlerAsync.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*
* @beta
*/
@@ -14530,7 +14530,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*
* [Api set: Mailbox 1.1]
*
@@ -14552,7 +14552,7 @@ declare namespace Office {
* The location of the appointment is provided as a string in the asyncResult.value property.
*
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*
* [Api set: Mailbox 1.1]
*
@@ -14572,7 +14572,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}. If setting the location fails, the asyncResult.error property will contain an error code.
* type Office.AsyncResult. If setting the location fails, the asyncResult.error property will contain an error code.
*
* [Api set: Mailbox 1.1]
*
@@ -14638,7 +14638,7 @@ declare namespace Office {
*
* @param location The location of the appointment. The string is limited to 255 characters.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}. If setting the location fails, the asyncResult.error property will contain an error code.
* type Office.AsyncResult. If setting the location fails, the asyncResult.error property will contain an error code.
*
* [Api set: Mailbox 1.1]
*
@@ -14770,7 +14770,7 @@ declare namespace Office {
* The type property on the parameter will match the eventType parameter passed to addHandlerAsync.
* @param options Optional. Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*/
addHandlerAsync(eventType: Office.EventType, handler: (type: EventType) => void, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
/**
@@ -15028,7 +15028,7 @@ declare namespace Office {
* isRest: Determines if the token provided will be used for the Outlook REST APIs or Exchange Web Services. Default value is false.
* asyncContext: Any state data that is passed to the asynchronous method.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}. The token is provided as a string in the asyncResult.value property.
* type Office.AsyncResult. The token is provided as a string in the asyncResult.value property.
*/
getCallbackTokenAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (result: AsyncResult<string>) => void): void;
/**
@@ -15082,7 +15082,7 @@ declare namespace Office {
* <tr><td>{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}</td><td>Compose and read</td></tr></table>
*
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}. The token is provided as a string in the asyncResult.value property.
* type Office.AsyncResult. The token is provided as a string in the asyncResult.value property.
* @param userContext Optional. Any state data that is passed to the asynchronous method.
*/
getCallbackTokenAsync(callback: (result: AsyncResult<string>) => void, userContext?: any): void;
@@ -15103,7 +15103,7 @@ declare namespace Office {
* {@link https://msdn.microsoft.com/library/office/fp179828.aspx | authenticate the add-in and user with a third-party system}.
*
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* The token is provided as a string in the asyncResult.value property.
* @param userContext Optional. Any state data that is passed to the asynchronous method.|
*/
@@ -15155,7 +15155,7 @@ declare namespace Office {
* <tr><td>{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}</td><td>Compose and read</td></tr></table>
*
* @param data The EWS request.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type {@link Office.AsyncResult}.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult.
* The `value` property of the result is the XML of the EWS request provided as a string.
* If the result exceeds 1 MB in size, an error message is returned instead.
* @param userContext Optional. Any state data that is passed to the asynchronous method.
@@ -15269,7 +15269,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*
* [Api set: Mailbox 1.3]
*
@@ -15336,7 +15336,7 @@ declare namespace Office {
* @param JSONmessage A JSON object that contains the notification message to be added to the item.
* It contains a NotificationMessageDetails object.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*
* [Api set: Mailbox 1.3]
*
@@ -15362,7 +15362,7 @@ declare namespace Office {
*
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type {@link Office.AsyncResult}.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult.
* The `value` property of the result is an array of NotificationMessageDetails objects.
*/
getAllAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<Office.NotificationMessageDetails[]>) => void): void;
@@ -15376,7 +15376,7 @@ declare namespace Office {
*
* <tr><td>{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}</td><td>Compose or read</td></tr></table>
*
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type {@link Office.AsyncResult}.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult.
* The `value` property of the result is an array of NotificationMessageDetails objects.
*/
getAllAsync(callback: (result: AsyncResult<Office.NotificationMessageDetails[]>) => void): void;
@@ -15402,7 +15402,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*/
removeAsync(key: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
/**
@@ -15445,7 +15445,7 @@ declare namespace Office {
*
* @param key The key for the notification message to remove.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*/
removeAsync(key: string, callback: (result: AsyncResult<void>) => void): void;
/**
@@ -15474,7 +15474,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*/
replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
/**
@@ -15529,7 +15529,7 @@ declare namespace Office {
* @param JSONmessage A JSON object that contains the new notification message to replace the existing message.
* It contains a NotificationMessageDetails object.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*/
replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback: (result: AsyncResult<void>) => void): void;
}
@@ -15601,7 +15601,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}. If adding the recipients fails, the asyncResult.error property will contain an error code.
* type Office.AsyncResult. If adding the recipients fails, the asyncResult.error property will contain an error code.
*/
addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
/**
@@ -15674,7 +15674,7 @@ declare namespace Office {
*
* @param recipients The recipients to add to the recipients list.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}. If adding the recipients fails, the asyncResult.error property will contain an error code.
* type Office.AsyncResult. If adding the recipients fails, the asyncResult.error property will contain an error code.
*/
addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], callback: (result: AsyncResult<void>) => void): void;
/**
@@ -15696,7 +15696,7 @@ declare namespace Office {
* @param options An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* The `value` property of the result is an array of EmailAddressDetails objects.
*/
getAsync(options: Office.AsyncContextOptions, callback: (result: AsyncResult<Office.EmailAddressDetails[]>) => void): void;
@@ -15713,7 +15713,7 @@ declare namespace Office {
* <tr><td>{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}</td><td>Compose</td></tr></table>
*
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* The `value` property of the result is an array of EmailAddressDetails objects.
*/
getAsync(callback: (result: AsyncResult<Office.EmailAddressDetails[]>) => void): void;
@@ -15751,7 +15751,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* If setting the recipients fails the asyncResult.error property will contain a code that indicates any error that occurred
* while adding the data.
*/
@@ -15832,7 +15832,7 @@ declare namespace Office {
*
* @param recipients The recipients to add to the recipients list.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* If setting the recipients fails the asyncResult.error property will contain a code that indicates any error that occurred
* while adding the data.
*/
@@ -15969,7 +15969,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
* The `value` property of the result is a Recurrence object.
*/
getAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<Office.Recurrence>) => void): void;
@@ -15988,7 +15988,7 @@ declare namespace Office {
* <tr><td>{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}</td><td>Compose or read</td></tr></table>
*
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
* The `value` property of the result is a Recurrence object.
*/
getAsync(callback?: (result: AsyncResult<Office.Recurrence>) => void): void;
@@ -16016,7 +16016,7 @@ declare namespace Office {
* @param options Optional. An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*/
setAsync(recurrencePattern: Recurrence, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
@@ -16037,7 +16037,7 @@ declare namespace Office {
*
* @param recurrencePattern A recurrence object.
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*/
setAsync(recurrencePattern: Recurrence, callback?: (result: AsyncResult<void>) => void): void;
}
@@ -16128,7 +16128,7 @@ declare namespace Office {
attachments?: ReplyFormAttachment[];
/**
* When the reply display call completes, the function passed in the callback parameter is called with a single parameter,
* asyncResult, which is an {@link Office.AsyncResult} object.
* asyncResult, which is an Office.AsyncResult object.
*/
callback?: (result: AsyncResult<any>) => void;
}
@@ -16199,7 +16199,7 @@ declare namespace Office {
* <tr><td>{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}</td><td>Compose or read</td></tr></table>
*
* @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
*/
saveAsync(callback?: (result: AsyncResult<void>) => void): void;
/**
@@ -16461,7 +16461,7 @@ declare namespace Office {
* @param options An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* The `value` property of the result is the subject of the item.
*/
getAsync(options: Office.AsyncContextOptions, callback: (result: AsyncResult<string>) => void): void;
@@ -16508,7 +16508,7 @@ declare namespace Office {
* @param options An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}. If setting the subject fails, the asyncResult.error property will contain an error code.
* type Office.AsyncResult. If setting the subject fails, the asyncResult.error property will contain an error code.
*/
setAsync(subject: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
/**
@@ -16566,7 +16566,7 @@ declare namespace Office {
*
* @param subject The subject of the appointment or message. The string is limited to 255 characters.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}. If setting the subject fails, the asyncResult.error property will contain an error code.
* type Office.AsyncResult. If setting the subject fails, the asyncResult.error property will contain an error code.
*/
setAsync(data: string, callback: (result: AsyncResult<void>) => void): void;
@@ -16674,7 +16674,7 @@ declare namespace Office {
* @param options An object literal that contains one or more of the following properties.
* asyncContext: Developers can provide any object they wish to access in the callback method.
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* If setting the date and time fails, the asyncResult.error property will contain an error code.
*/
setAsync(dateTime: Date, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
@@ -16739,7 +16739,7 @@ declare namespace Office {
*
* @param dateTime A date-time object in Coordinated Universal Time (UTC).
* @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of
* type {@link Office.AsyncResult}.
* type Office.AsyncResult.
* If setting the date and time fails, the asyncResult.error property will contain an error code.
*/
setAsync(dateTime: Date, callback: (result: AsyncResult<void>) => void): void;