diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index 116112bee1..fab2c5095a 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -8499,7 +8499,7 @@ declare namespace Office { } } interface CoercionTypeOptions { - coercionType?: CoercionType; + coercionType?: Office.CoercionType; } enum SourceProperty { /** @@ -8697,7 +8697,7 @@ declare namespace Office { * * For cloud attachments, the formatting is a URL string. */ - format: Office.MailboxEnums.AttachmentContentFormat; + format: MailboxEnums.AttachmentContentFormat; } /** * Represents an attachment on an item from the server. Read mode only. @@ -8715,7 +8715,7 @@ declare namespace Office { /** * Gets a value that indicates the type of an attachment. */ - attachmentType: Office.MailboxEnums.AttachmentType; + attachmentType: MailboxEnums.AttachmentType; /** * Gets the MIME content type of the attachment. */ @@ -8767,15 +8767,15 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `getAsync(coercionType: Office.CoercionType, callback: (result: AsyncResult) => void): void;` + * `getAsync(coercionType: Office.CoercionType, callback: (result: Office.AsyncResult) => void): void;` * - * @param coercionType The format for the returned body. - * @param options Optional. An object literal that contains one or more of the following properties: + * @param coercionType - The format for the returned body. + * @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 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, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getAsync(coercionType: Office.CoercionType, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Returns the current body in a specified format. * @@ -8792,11 +8792,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @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 Office.AsyncResult. + * @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 Office.AsyncResult. * The body is provided in the requested format in the asyncResult.value property. */ - getAsync(coercionType: Office.CoercionType, callback: (result: AsyncResult) => void): void; + getAsync(coercionType: Office.CoercionType, callback: (result: Office.AsyncResult) => void): void; /** * Gets a value that indicates whether the content is in HTML or text format. @@ -8808,12 +8808,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 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) => void): void; + getTypeAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds the specified content to the beginning of the item body. * @@ -8836,18 +8836,18 @@ declare namespace Office { * * `prependAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions): void;` * - * `prependAsync(data: string, callback: (result: AsyncResult) => void): void;` + * `prependAsync(data: string, callback: (result: Office.AsyncResult) => void): void;` * * `prependAsync(data: string): void;` * - * @param data The string to be inserted at the beginning of the body. The string is limited to 1,000,000 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param data - The string to be inserted at the beginning of the body. The string is limited to 1,000,000 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. * 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 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; + prependAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds the specified content to the beginning of the item body. * @@ -8866,8 +8866,8 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters. * - * @param data The string to be inserted at the beginning of the body. The string is limited to 1,000,000 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param data - The string to be inserted at the beginning of the body. The string is limited to 1,000,000 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. * coercionType: The desired format for the body. The string in the data parameter will be converted to this format. */ @@ -8888,11 +8888,11 @@ declare namespace Office { * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters. * - * @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 Office.AsyncResult. + * @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 Office.AsyncResult. * Any errors encountered will be provided in the asyncResult.error property. */ - prependAsync(data: string, callback: (result: AsyncResult) => void): void; + prependAsync(data: string, callback: (result: Office.AsyncResult) => void): void; /** * Adds the specified content to the beginning of the item body. * @@ -8909,7 +8909,7 @@ declare namespace Office { * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters. * - * @param data The string to be inserted at the beginning of the body. The string is limited to 1,000,000 characters. + * @param data - The string to be inserted at the beginning of the body. The string is limited to 1,000,000 characters. */ prependAsync(data: string): void; /** @@ -8935,18 +8935,18 @@ declare namespace Office { * * `setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions): void;` * - * `setAsync(data: string, callback: (result: AsyncResult) => void): void;` + * `setAsync(data: string, callback: (result: Office.AsyncResult) => void): void;` * * `setAsync(data: string): void;` * - * @param data The string that will replace the existing body. The string is limited to 1,000,000 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param data - The string that will replace the existing body. The string is limited to 1,000,000 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. * 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 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; + setAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Replaces the entire body with the specified text. * @@ -8966,8 +8966,8 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters.InvalidFormatError - The options.coercionType parameter is set to Office.CoercionType.Html and the message body is in plain text. * - * @param data The string that will replace the existing body. The string is limited to 1,000,000 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param data - The string that will replace the existing body. The string is limited to 1,000,000 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. * coercionType: The desired format for the body. The string in the data parameter will be converted to this format. */ @@ -8991,11 +8991,11 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters.InvalidFormatError - The options.coercionType parameter is set to Office.CoercionType.Html and the message body is in plain text. * - * @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 Office.AsyncResult. + * @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 Office.AsyncResult. * Any errors encountered will be provided in the asyncResult.error property. */ - setAsync(data: string, callback: (result: AsyncResult) => void): void; + setAsync(data: string, callback: (result: Office.AsyncResult) => void): void; /** * Replaces the entire body with the specified text. * @@ -9015,7 +9015,7 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters.InvalidFormatError - The options.coercionType parameter is set to Office.CoercionType.Html and the message body is in plain text. * - * @param data The string that will replace the existing body. The string is limited to 1,000,000 characters. + * @param data - The string that will replace the existing body. The string is limited to 1,000,000 characters. */ setAsync(data: string): void; @@ -9042,18 +9042,18 @@ declare namespace Office { * * `setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions): void;` * - * `setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void;` + * `setSelectedDataAsync(data: string, callback: (result: Office.AsyncResult) => void): void;` * * `setSelectedDataAsync(data: string): void;` * - * @param data The string that will replace the existing body. The string is limited to 1,000,000 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param data - The string that will replace the existing body. The string is limited to 1,000,000 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. * 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 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; + setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Replaces the selection in the body with the specified text. * @@ -9073,8 +9073,8 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters.InvalidFormatError - The options.coercionType parameter is set to Office.CoercionType.Html and the message body is in plain text. * - * @param data The string that will replace the existing body. The string is limited to 1,000,000 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param data - The string that will replace the existing body. The string is limited to 1,000,000 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. * coercionType: The desired format for the body. The string in the data parameter will be converted to this format. */ @@ -9098,11 +9098,11 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters.InvalidFormatError - The options.coercionType parameter is set to Office.CoercionType.Html and the message body is in plain text. * - * @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 Office.AsyncResult. + * @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 Office.AsyncResult. * Any errors encountered will be provided in the asyncResult.error property. */ - setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void; + setSelectedDataAsync(data: string, callback: (result: Office.AsyncResult) => void): void; /** * Replaces the selection in the body with the specified text. * @@ -9122,7 +9122,7 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters.InvalidFormatError - The options.coercionType parameter is set to Office.CoercionType.Html and the message body is in plain text. * - * @param data The string that will replace the existing body. The string is limited to 1,000,000 characters. + * @param data - The string that will replace the existing body. The string is limited to 1,000,000 characters. */ setSelectedDataAsync(data: string): void; } @@ -9183,7 +9183,7 @@ declare namespace Office { interface CustomProperties { /** * Returns the value of the specified custom property. - * @param name The name of the custom property to be returned. + * @param name - The name of the custom property to be returned. * @returns The value of the specified custom property. * * [Api set: Mailbox 1.0] @@ -9210,15 +9210,15 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param name The name of the property to be set. - * @param value The value of the property to be set. + * @param name - The name of the property to be set. + * @param value - The value of the property to be set. */ set(name: string, value: string): void; /** * Removes the specified property from the custom property collection. * * To make the removal of the property permanent, you must call the saveAsync method of the CustomProperties object. - * @param name The name of the property to be removed. + * @param name - The name of the property to be removed. * * [Api set: Mailbox 1.0] * @@ -9240,9 +9240,9 @@ declare namespace Office { * If the add-in calls saveAsync while in the disconnected state, saveAsync would return an error. * 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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. - * @param asyncContext Optional. Any state data that is passed to the callback method. + * @param asyncContext - Optional. Any state data that is passed to the callback method. * * [Api set: Mailbox 1.0] * @@ -9251,7 +9251,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - saveAsync(callback?: (result: AsyncResult) => void, asyncContext?: any): void; + saveAsync(callback?: (result: Office.AsyncResult) => void, asyncContext?: any): void; } /** * Provides diagnostic information to an Outlook add-in. @@ -9341,11 +9341,11 @@ declare namespace Office { * This property applies to only an attendee of an appointment, as represented by the optionalAttendees or requiredAttendees property. * This property returns undefined in other scenarios. */ - appointmentResponse: Office.MailboxEnums.ResponseType; + appointmentResponse: MailboxEnums.ResponseType; /** * Gets the email address type of a recipient. */ - recipientType: Office.MailboxEnums.RecipientType; + recipientType: MailboxEnums.RecipientType; } /** * Represents an email account on an Exchange Server. @@ -9438,7 +9438,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose */ - export interface From { + interface From { /** * Gets the from value of a message. * @@ -9455,14 +9455,14 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `getAsync(callback?: (result: AsyncResult) => void): void;` + * `getAsync(callback?: (result: Office.AsyncResult) => void): void;` * - * @param options An object literal that contains one or more of the following properties. + * @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 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) => void): void; + getAsync(options: Office.AsyncContextOptions, callback: (result: Office.AsyncResult) => void): void; /** * Gets the from value of a message. * @@ -9478,10 +9478,10 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @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. + * @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) => void): void; + getAsync(callback?: (result: Office.AsyncResult) => void): void; } /** @@ -9499,7 +9499,7 @@ declare namespace Office { * * @beta */ - export interface InternetHeaders { + interface InternetHeaders { /** * Given an array of internet header names, this method returns a dictionary containing those internet headers and their values. * If the add-in requests an x-header that is not available, that x-header will not be returned in the results. @@ -9513,17 +9513,17 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `getAsync(names: string[], callback: (result: AsyncResult) => void): void;` + * `getAsync(names: string[], callback: (result: Office.AsyncResult) => void): void;` * - * @param names The names of the internet headers to be returned. - * @param options Optional. An object literal that contains one or more of the following properties: + * @param names - The names of the internet headers to be returned. + * @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 Office.AsyncResult 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 Office.AsyncResult object. * * @beta */ - getAsync(names: string[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getAsync(names: string[], options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Given an array of internet header names, this method returns a dictionary containing those internet headers and their values. * If the add-in requests an x-header that is not available, that x-header will not be returned in the results. @@ -9535,13 +9535,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param names The names of the internet headers to be returned. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult object. + * @param names - The names of the internet headers to be returned. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. * * @beta */ - getAsync(names: string[], callback?: (result: AsyncResult) => void): void; + getAsync(names: string[], callback?: (result: Office.AsyncResult) => void): void; /** * Given an array of internet header names, this method removes the specified headers from the internet header collection. * @@ -9554,17 +9554,17 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `removeAsync(names: string[], callback: (result: AsyncResult) => void): void;` + * `removeAsync(names: string[], callback: (result: Office.AsyncResult) => void): void;` * - * @param names The names of the internet headers to be removed. - * @param options Optional. An object literal that contains one or more of the following properties: + * @param names - The names of the internet headers to be removed. + * @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 Office.AsyncResult 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 Office.AsyncResult object. * * @beta */ - removeAsync(names: string[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + removeAsync(names: string[], options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Given an array of internet header names, this method removes the specified headers from the internet header collection. * @@ -9575,13 +9575,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param names The names of the internet headers to be removed. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult object. + * @param names - The names of the internet headers to be removed. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. * * @beta */ - removeAsync(names: string[], callback?: (result: AsyncResult) => void): void; + removeAsync(names: string[], callback?: (result: Office.AsyncResult) => void): void; /** * Sets the specified internet headers to the specified values. * @@ -9597,18 +9597,18 @@ declare namespace Office { * * In addition to this signature, this method also has the following signatures: * - * `setAsync(headers: string, callback: (result: AsyncResult) => void): void;` + * `setAsync(headers: string, callback: (result: Office.AsyncResult) => void): void;` * - * @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 + * @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 * internet headers and values being the values of the internet headers. - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 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. * * @beta */ - setAsync(headers: Object, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + setAsync(headers: Object, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Sets the specified internet headers to the specified values. * @@ -9622,14 +9622,14 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @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 + * @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 * internet headers and values being the values of the internet headers. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type 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. * * @beta */ - setAsync(headers: Object, callback?: (result: AsyncResult) => void): void; + setAsync(headers: Object, callback?: (result: Office.AsyncResult) => void): void; } /** @@ -9643,7 +9643,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose */ - export interface Organizer { + interface Organizer { /** * Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails} in the asyncResult.value property. * @@ -9654,12 +9654,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param options An object literal that contains one or more of the following properties. + * @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 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 asyncResult object. * The `value` property of the result is message's organizer value, as an EmailAddressDetails object. */ - getAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; } /** @@ -9688,7 +9688,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer */ - body: Office.Body; + body: Body; /** * Gets the date and time that an item was created. Read mode only. * @@ -9746,7 +9746,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer */ - itemType: Office.MailboxEnums.ItemType; + itemType: MailboxEnums.ItemType; /** * Gets or sets the {@link Office.Location} of an appointment. The location property returns a Location object that provides methods that are * used to get and set the location of the appointment. @@ -9771,7 +9771,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer */ - notificationMessages: Office.NotificationMessages; + notificationMessages: NotificationMessages; /** * Provides access to the optional attendees of an event. The type of object and level of access depends on the mode of the current item. * The optionalAttendees property returns an {@link Office.Recipients} object that provides methods to get or update the optional attendees @@ -9799,7 +9799,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer */ - organizer: Office.Organizer; + organizer: Organizer; /** * Gets or sets the recurrence pattern of an appointment. * @@ -9913,18 +9913,18 @@ declare namespace Office { * * `addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions): void;` * - * `addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: AsyncResult) => void): void;` + * `addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: Office.AsyncResult) => void): void;` * - * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 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. * 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 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 uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. */ - addFileAttachmentAsync(uri: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addFileAttachmentAsync(uri: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds a file to a message or appointment as an attachment. * @@ -9941,8 +9941,8 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 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. */ addFileAttachmentAsync(uri: string, attachmentName: string): void; /** @@ -9961,9 +9961,9 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 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. * isInline: If true, indicates that the attachment will be shown inline in the message body and should not be displayed in the attachment list. */ @@ -9984,17 +9984,17 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 asyncResult. + * @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 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. */ - addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: AsyncResult) => void): void; + addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: Office.AsyncResult) => void): void; /** * Adds a file to a message or appointment as an attachment. * - * The addFileAttachmentFromBase64Async method uploads the file from the base64 encoding and attaches it to the item in the compose form. This method returns the attachment identifier in the AsyncResult.value object. + * The addFileAttachmentFromBase64Async method uploads the file from the base64 encoding and attaches it to the item in the compose form. This method returns the attachment identifier in the asyncResult.value object. * * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. * @@ -10007,18 +10007,18 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @param base64File The base64 encoded content of an image or file to be added to an email or event. - * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param base64File - The base64 encoded content of an image or file to be added to an email or event. + * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 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. * 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 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 uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. * * @beta */ - addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an event handler for a supported event. * @@ -10035,17 +10035,17 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void;` + * `addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an event handler for a supported event. * @@ -10060,13 +10060,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. * @@ -10095,17 +10095,17 @@ declare namespace Office { * * `addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions): void;` * - * `addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: AsyncResult) => void): void;` + * `addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: Office.AsyncResult) => void): void;` * - * @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 options An object literal that contains one or more of the following properties. + * @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 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 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. */ - addItemAttachmentAsync(itemId: any, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addItemAttachmentAsync(itemId: any, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. * @@ -10128,8 +10128,8 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 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. */ addItemAttachmentAsync(itemId: any, attachmentName: string): void; /** @@ -10154,9 +10154,9 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 options An object literal that contains one or more of the following properties. + * @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 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. */ addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions): void; @@ -10182,13 +10182,13 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 Office.AsyncResult. + * @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 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. */ - addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: AsyncResult) => void): void; + addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: Office.AsyncResult) => void): void; /** * Closes the current item that is being composed * @@ -10220,15 +10220,15 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @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 the call fails, the asyncResult.error property will contain and error code with the reason for * the failure. * * @beta */ - getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Gets initialization data passed when the add-in is activated by an actionable message. * @@ -10244,15 +10244,15 @@ declare namespace Office { * * More information on {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | actionable messages}. * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 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. * * @beta */ - getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * @@ -10273,13 +10273,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer * - * @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string , removing any HTML tags present. + * @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 options An object literal that contains one or more of the following properties. + * @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 AsyncResult. + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. */ - getSelectedDataAsync(coercionType: Office.CoercionType, options: Office.AsyncContextOptions, callback: (result: AsyncResult) => void): void; + getSelectedDataAsync(coercionType: Office.CoercionType, options: Office.AsyncContextOptions, callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * @@ -10300,12 +10300,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer * - * @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string , removing any HTML tags present. + * @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 + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - getSelectedDataAsync(coercionType: Office.CoercionType, callback: (result: AsyncResult) => void): void; + getSelectedDataAsync(coercionType: Office.CoercionType, callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously loads custom properties for this add-in on the selected item. * @@ -10325,12 +10325,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. - * @param userContext Optional. Developers can provide any object they wish to access in the callback function. + * @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. */ - loadCustomPropertiesAsync(callback: (result: AsyncResult) => void, userContext?: any): void; + loadCustomPropertiesAsync(callback: (result: Office.AsyncResult) => void, userContext?: any): void; /** * Removes an attachment from a message or appointment. * @@ -10356,15 +10356,15 @@ declare namespace Office { * * `removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions): void;` * - * `removeAttachmentAsync(attachmentId: string, callback: (result: AsyncResult) => void): void;` + * `removeAttachmentAsync(attachmentId: string, callback: (result: Office.AsyncResult) => void): void;` * - * @param attachmentId The identifier of the attachment to remove. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param attachmentId - The identifier of the attachment to remove. + * @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 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(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + removeAttachmentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Removes an attachment from a message or appointment. * @@ -10384,7 +10384,7 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment to remove. + * @param attachmentId - The identifier of the attachment to remove. */ removeAttachmentAsync(attachmentId: string): void; /** @@ -10406,8 +10406,8 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment to remove. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param attachmentId - The identifier of the attachment to remove. + * @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. */ removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions): void; @@ -10431,12 +10431,12 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment to remove. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * @param attachmentId - The identifier of the attachment to remove. + * @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(attachmentId: string, callback: (result: AsyncResult) => void): void; + removeAttachmentAsync(attachmentId: string, callback: (result: Office.AsyncResult) => void): void; /** * Removes the event handlers for a supported event type. * @@ -10453,15 +10453,15 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `removeHandlerAsync(eventType:EventType, callback?: (result: AsyncResult) => void): void;` + * `removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should revoke the handler. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param eventType - The event that should revoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - removeHandlerAsync(eventType:EventType, options?: any, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Removes the event handlers for a supported event type. * @@ -10476,11 +10476,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer * - * @param eventType The event that should revoke the handler. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult object. + * @param eventType - The event that should revoke the handler. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. */ - removeHandlerAsync(eventType:EventType, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. * @@ -10518,13 +10518,13 @@ declare namespace Office { * * `saveAsync(options: Office.AsyncContextOptions): void;` * - * `saveAsync(callback: (result: AsyncResult) => void): void;` + * `saveAsync(callback: (result: Office.AsyncResult) => void): void;` * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 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; + saveAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. * @@ -10589,7 +10589,7 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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. */ saveAsync(options: Office.AsyncContextOptions): void; @@ -10623,9 +10623,9 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type 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; + saveAsync(callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * @@ -10649,11 +10649,11 @@ declare namespace Office { * * `setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions): void;` * - * `setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void;` + * `setSelectedDataAsync(data: string, callback: (result: Office.AsyncResult) => void): void;` * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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: If text, the current style is applied in Outlook Web App and Outlook. * If the field is an HTML editor, only the text data is inserted, even if the data is HTML. @@ -10662,10 +10662,10 @@ declare namespace Office { * If the field is a text field, an InvalidDataFormat error is returned. * 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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: AsyncResult) => void): void; + setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * @@ -10683,7 +10683,7 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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. */ setSelectedDataAsync(data: string): void; @@ -10704,9 +10704,9 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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: If text, the current style is applied in Outlook Web App and Outlook. * If the field is an HTML editor, only the text data is inserted, even if the data is HTML. @@ -10733,12 +10733,12 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void; + setSelectedDataAsync(data: string, callback: (result: Office.AsyncResult) => void): void; } /** @@ -10763,7 +10763,7 @@ declare namespace Office { * {@link https://support.office.com/article/Blocked-attachments-in-Outlook-434752E1-02D3-4E90-9124-8B81E49A8519 | Blocked attachments in Outlook}. * */ - attachments: Office.AttachmentDetails[]; + attachments: AttachmentDetails[]; /** * Gets an object that provides methods for manipulating the body of an item. * @@ -10775,7 +10775,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee */ - body: Office.Body; + body: Body; /** * Gets the date and time that an item was created. Read mode only. * @@ -10861,7 +10861,7 @@ declare namespace Office { * * The itemId property is not available in compose mode. * If an item identifier is required, the saveAsync method can be used to save the item to the store, which will return the item identifier - * in the AsyncResult.value parameter in the callback function. + * in the asyncResult.value parameter in the callback function. * * Note: The identifier returned by the itemId property is the same as the Exchange Web Services item identifier. * The itemId property is not identical to the Outlook Entry ID or the ID used by the Outlook REST API. @@ -10890,7 +10890,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee */ - itemType: Office.MailboxEnums.ItemType; + itemType: MailboxEnums.ItemType; /** * Gets the location of an appointment. * @@ -10931,7 +10931,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee */ - notificationMessages: Office.NotificationMessages; + notificationMessages: NotificationMessages; /** * Provides access to the optional attendees of an event. The type of object and level of access depends on the mode of the current item. * @@ -11065,17 +11065,17 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: AsyncResult) => void): void;` + * `addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType: Office.EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an event handler for a supported event. @@ -11091,13 +11091,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void; /** * Displays a reply form that includes the sender and all recipients of the selected message or the organizer and all attendees of the * selected appointment. @@ -11119,7 +11119,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee * - * @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 + * @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 * OR * An {@link Office.ReplyFormData} object that contains body or attachment data and a callback function */ @@ -11145,7 +11145,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee * - * @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. + * @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. * OR * An {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. */ @@ -11166,19 +11166,19 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `getInitializationContextAsync(callback?: (result: AsyncResult) => void): void;` + * `getInitializationContextAsync(callback?: (result: Office.AsyncResult) => void): void;` * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 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. * * @beta */ - getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Gets initialization data passed when the add-in is {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}. * @@ -11192,15 +11192,15 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee * - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult 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 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. * * @beta */ - getInitializationContextAsync(callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(callback?: (result: Office.AsyncResult) => void): void; /** * Gets the entities found in the selected item's body. * @@ -11222,7 +11222,7 @@ declare namespace Office { * * [Api set: Mailbox 1.0] * - * @param entityType One of the EntityType enumeration values. + * @param entityType - One of the EntityType enumeration values. * * @returns * If the value passed in entityType is not a valid member of the EntityType enumeration, the method returns null. @@ -11279,7 +11279,7 @@ declare namespace Office { * * */ - getEntitiesByType(entityType: Office.MailboxEnums.EntityType): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; + getEntitiesByType(entityType: MailboxEnums.EntityType): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; /** * Returns well-known entities in the selected item that pass the named filter defined in the manifest XML file. * @@ -11296,7 +11296,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee * - * @param name The name of the ItemHasKnownEntity rule element that defines the filter to match. + * @param name - The name of the ItemHasKnownEntity rule element that defines the filter to match. * @returns If there is no ItemHasKnownEntity element in the manifest with a FilterName element value that matches the name parameter, * the method returns null. * If the name parameter does match an ItemHasKnownEntity element in the manifest, but there are no entities in the current item that match, @@ -11355,7 +11355,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee * - * @param name The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. + * @param name - The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. */ getRegExMatchesByName(name: string): string[]; /** @@ -11371,7 +11371,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee * - * @param name The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. + * @param name - The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. */ getSelectedEntities(): Entities; /** @@ -11423,12 +11423,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. - * @param userContext Optional. Developers can provide any object they wish to access in the callback function. + * @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. */ - loadCustomPropertiesAsync(callback: (result: AsyncResult) => void, userContext?: any): void; + loadCustomPropertiesAsync(callback: (result: Office.AsyncResult) => void, userContext?: any): void; /** * Removes the event handlers for a supported event type. @@ -11446,15 +11446,15 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `removeHandlerAsync(eventType:EventType, callback?: (result: AsyncResult) => void): void;` + * `removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should revoke the handler. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param eventType - The event that should revoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - removeHandlerAsync(eventType:EventType, options?: any, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Removes the event handlers for a supported event type. * @@ -11469,11 +11469,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee * - * @param eventType The event that should revoke the handler. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult object. + * @param eventType - The event that should revoke the handler. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. */ - removeHandlerAsync(eventType:EventType, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void; } /** @@ -11499,7 +11499,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - body: Office.Body; + body: Body; /** * Gets the date and time that an item was created. Read mode only. * @@ -11540,7 +11540,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - itemType: Office.MailboxEnums.ItemType; + itemType: MailboxEnums.ItemType; /** * Gets the notification messages for an item. * @@ -11552,7 +11552,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - notificationMessages: Office.NotificationMessages; + notificationMessages: NotificationMessages; /** * Gets or sets the recurrence pattern of an appointment. Gets the recurrence pattern of a meeting request. @@ -11575,7 +11575,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - recurrence: Office.Recurrence; + recurrence: Recurrence; /** * Gets the id of the series that an instance belongs to. @@ -11617,17 +11617,17 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: AsyncResult) => void): void;` + * `addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType: Office.EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an event handler for a supported event. @@ -11643,16 +11643,16 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void; /** - * Gets an attachment from a message or appointment and returns it as an `Office.AttachmentContent` object. + * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object. * * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or @@ -11670,16 +11670,16 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment you want to get. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param attachmentId - The identifier of the attachment you want to get. + * @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 Office.AsyncResult object. If the call fails, the asyncResult.error property will contain and error code + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. If the call fails, the asyncResult.error property will contain and error code * with the reason for the failure. * * @beta */ - getAttachmentContentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getAttachmentContentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Gets initialization data passed when the add-in is {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}. @@ -11697,19 +11697,19 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `getInitializationContextAsync(callback?: (result: AsyncResult) => void): void;` + * `getInitializationContextAsync(callback?: (result: Office.AsyncResult) => void): void;` * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 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. * * @beta */ - getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Gets the properties of an appointment or message in a shared folder, calendar, or mailbox. @@ -11723,17 +11723,17 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `getAsync(callback: (result: AsyncResult) => void): void;` + * `getAsync(callback: (result: Office.AsyncResult) => void): void;` * - * @param options An object literal that contains one or more of the following properties. + * @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 + * @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 properties of the shared item. * * @beta */ - getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (result: AsyncResult) => void): void; + getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (result: Office.AsyncResult) => void): void; /** * Gets the properties of an appointment or message in a shared folder, calendar, or mailbox. @@ -11745,13 +11745,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of + * @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 properties of the shared item. * * @beta */ - getSharedPropertiesAsync(callback: (result: AsyncResult) => void): void; + getSharedPropertiesAsync(callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously loads custom properties for this add-in on the selected item. @@ -11772,12 +11772,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. - * @param userContext Optional. Developers can provide any object they wish to access in the callback function. + * @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. */ - loadCustomPropertiesAsync(callback: (result: AsyncResult) => void, userContext?: any): void; + loadCustomPropertiesAsync(callback: (result: Office.AsyncResult) => void, userContext?: any): void; /** * Removes the event handlers for a supported event type. @@ -11795,15 +11795,15 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `removeHandlerAsync(eventType: Office.EventType, callback?: (result: AsyncResult) => void): void;` + * `removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should revoke the handler. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param eventType - The event that should revoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - removeHandlerAsync(eventType: Office.EventType, options?: any, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Removes the event handlers for a supported event type. @@ -11819,11 +11819,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param eventType The event that should revoke the handler. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult object. + * @param eventType - The event that should revoke the handler. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. */ - removeHandlerAsync(eventType: Office.EventType, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void; } /** * The compose mode of {@link Office.Item | Office.context.mailbox.item}. @@ -11870,20 +11870,20 @@ declare namespace Office { * * `addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions): void;` * - * `addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: AsyncResult) => void): void;` + * `addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: Office.AsyncResult) => void): void;` * - * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 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. * 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 asyncResult. On success, the attachment identifier will be provided in the asyncResult.value property. + * @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 uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of * the error. */ - addFileAttachmentAsync(uri: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addFileAttachmentAsync(uri: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds a file to a message or appointment as an attachment. * @@ -11900,8 +11900,8 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 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. */ addFileAttachmentAsync(uri: string, attachmentName: string): void; /** @@ -11920,9 +11920,9 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 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. * isInline: If true, indicates that the attachment will be shown inline in the message body, and should not be displayed in the * attachment list. @@ -11944,19 +11944,19 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 + * @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 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. */ - addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: AsyncResult) => void): void; + addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: Office.AsyncResult) => void): void; /** * Adds a file to a message or appointment as an attachment. * - * The addFileAttachmentFromBase64Async method uploads the file from the base64 encoding and attaches it to the item in the compose form. This method returns the attachment identifier in the AsyncResult.value object. + * The addFileAttachmentFromBase64Async method uploads the file from the base64 encoding and attaches it to the item in the compose form. This method returns the attachment identifier in the asyncResult.value object. * * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. * @@ -11969,18 +11969,18 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @param base64File The base64 encoded content of an image or file to be added to an email or event. - * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param base64File - The base64 encoded content of an image or file to be added to an email or event. + * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 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. * 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 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 uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. * * @beta */ - addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. @@ -12010,18 +12010,18 @@ declare namespace Office { * * `addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions): void;` * - * `addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: AsyncResult) => void): void;` + * `addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: Office.AsyncResult) => void): void;` * - * @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 options An object literal that contains one or more of the following properties. + * @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 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 + * @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. */ - addItemAttachmentAsync(itemId: any, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addItemAttachmentAsync(itemId: any, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. * @@ -12044,8 +12044,8 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 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. */ addItemAttachmentAsync(itemId: any, attachmentName: string): void; /** @@ -12070,9 +12070,9 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 options An object literal that contains one or more of the following properties. + * @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 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. */ addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions): void; @@ -12098,14 +12098,14 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 + * @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 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. */ - addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: AsyncResult) => void): void; + addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: Office.AsyncResult) => void): void; /** * Closes the current item that is being composed @@ -12138,15 +12138,15 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @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 the call fails, the asyncResult.error property will contain and error code with the reason for * the failure. * * @beta */ - getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Gets initialization data passed when the add-in is activated by an actionable message. * @@ -12162,9 +12162,9 @@ declare namespace Office { * * More information on {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | actionable messages}. * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @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 @@ -12172,7 +12172,7 @@ declare namespace Office { * * @beta */ - getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * @@ -12193,12 +12193,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string , removing any HTML tags present. + * @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 + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - getSelectedDataAsync(coercionType: Office.CoercionType, callback: (result: AsyncResult) => void): void; + getSelectedDataAsync(coercionType: Office.CoercionType, callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * @@ -12219,14 +12219,14 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string, removing any HTML tags present. + * @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 options An object literal that contains one or more of the following properties. + * @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 + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - getSelectedDataAsync(coercionType: Office.CoercionType, options: Office.AsyncContextOptions, callback: (result: AsyncResult) => void): void; + getSelectedDataAsync(coercionType: Office.CoercionType, options: Office.AsyncContextOptions, callback: (result: Office.AsyncResult) => void): void; /** * Removes an attachment from a message or appointment. * @@ -12252,16 +12252,16 @@ declare namespace Office { * * `removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions): void;` * - * `removeAttachmentAsync(attachmentId: string, callback: (result: AsyncResult) => void): void;` + * `removeAttachmentAsync(attachmentId: string, callback: (result: Office.AsyncResult) => void): void;` * - * @param attachmentId The identifier of the attachment to remove. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param attachmentId - The identifier of the attachment to remove. + * @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 + * @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(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + removeAttachmentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Removes an attachment from a message or appointment. * @@ -12281,7 +12281,7 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment to remove. + * @param attachmentId - The identifier of the attachment to remove. */ removeAttachmentAsync(attachmentId: string): void; /** @@ -12303,8 +12303,8 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment to remove. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param attachmentId - The identifier of the attachment to remove. + * @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. */ removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions): void; @@ -12327,12 +12327,12 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment 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}. + * @param attachmentId - The identifier of the attachment to remove. + * @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(attachmentId: string, callback: (result: AsyncResult) => void): void; + removeAttachmentAsync(attachmentId: string, callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. @@ -12371,15 +12371,15 @@ declare namespace Office { * * `saveAsync(options: Office.AsyncContextOptions): void;` * - * `saveAsync(callback: (result: AsyncResult) => void): void;` + * `saveAsync(callback: (result: Office.AsyncResult) => void): void;` * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @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. */ - saveAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + saveAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. * @@ -12444,7 +12444,7 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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. */ saveAsync(options: Office.AsyncContextOptions): void; @@ -12479,11 +12479,11 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * @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. */ - saveAsync(callback: (result: AsyncResult) => void): void; + saveAsync(callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * @@ -12507,11 +12507,11 @@ declare namespace Office { * * `setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions): void;` * - * `setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void;` + * `setSelectedDataAsync(data: string, callback: (result: Office.AsyncResult) => void): void;` * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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: If text, the current style is applied in Outlook Web App and Outlook. * If the field is an HTML editor, only the text data is inserted, even if the data is HTML. @@ -12520,10 +12520,10 @@ declare namespace Office { * If the field is a text field, an InvalidDataFormat error is returned. * 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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: AsyncResult) => void): void; + setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * @@ -12541,7 +12541,7 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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. */ setSelectedDataAsync(data: string): void; @@ -12562,9 +12562,9 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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: If text, the current style is applied in Outlook Web App and Outlook. * If the field is an HTML editor, only the text data is inserted, even if the data is HTML. @@ -12592,12 +12592,12 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void; + setSelectedDataAsync(data: string, callback: (result: Office.AsyncResult) => void): void; } /** * The read mode of {@link Office.Item | Office.context.mailbox.item}. @@ -12621,7 +12621,7 @@ declare namespace Office { * {@link https://support.office.com/article/Blocked-attachments-in-Outlook-434752E1-02D3-4E90-9124-8B81E49A8519 | Blocked attachments in Outlook}. * */ - attachments: Office.AttachmentDetails[]; + attachments: AttachmentDetails[]; /** * Gets the Exchange Web Services item class of the selected item. * @@ -12664,7 +12664,7 @@ declare namespace Office { * * The itemId property is not available in compose mode. * If an item identifier is required, the saveAsync method can be used to save the item to the store, which will return the item identifier - * in the AsyncResult.value parameter in the callback function. + * in the asyncResult.value parameter in the callback function. * * Note: The identifier returned by the itemId property is the same as the Exchange Web Services item identifier. * The itemId property is not identical to the Outlook Entry ID or the ID used by the Outlook REST API. @@ -12732,7 +12732,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Read * - * @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 + * @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 * OR * An {@link Office.ReplyFormData} object that contains body or attachment data and a callback function */ @@ -12758,7 +12758,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Read * - * @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. + * @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. * OR * An {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. */ @@ -12779,19 +12779,19 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `getInitializationContextAsync(callback?: (result: AsyncResult) => void): void;` + * `getInitializationContextAsync(callback?: (result: Office.AsyncResult) => void): void;` * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 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. * * @beta */ - getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Gets initialization data passed when the add-in is {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}. * @@ -12806,15 +12806,15 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Read * - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult 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 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. * * @beta */ - getInitializationContextAsync(callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(callback?: (result: Office.AsyncResult) => void): void; /** * Gets the entities found in the selected item's body. * @@ -12836,7 +12836,7 @@ declare namespace Office { * * [Api set: Mailbox 1.0] * - * @param entityType One of the EntityType enumeration values. + * @param entityType - One of the EntityType enumeration values. * * @returns * If the value passed in entityType is not a valid member of the EntityType enumeration, the method returns null. @@ -12894,7 +12894,7 @@ declare namespace Office { * * */ - getEntitiesByType(entityType: Office.MailboxEnums.EntityType): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; + getEntitiesByType(entityType: MailboxEnums.EntityType): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; /** * Returns well-known entities in the selected item that pass the named filter defined in the manifest XML file. * @@ -12911,7 +12911,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Read * - * @param name The name of the ItemHasKnownEntity rule element that defines the filter to match. + * @param name - The name of the ItemHasKnownEntity rule element that defines the filter to match. * @returns If there is no ItemHasKnownEntity element in the manifest with a FilterName element value that matches the name parameter, * the method returns null. * If the name parameter does match an ItemHasKnownEntity element in the manifest, but there are no entities in the current item that match, @@ -12970,7 +12970,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Read * - * @param name The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. + * @param name - The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. */ getRegExMatchesByName(name: string): string[]; /** @@ -12986,7 +12986,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Read * - * @param name The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. + * @param name - The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. */ getSelectedEntities(): Entities; /** @@ -13076,7 +13076,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose */ - body: Office.Body; + body: Body; /** * Provides access to the Cc (carbon copy) recipients of a message. The type of object and level of access depends on the mode of the * current item. @@ -13154,7 +13154,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose */ - from: Office.From; + from: From; /** * Sets the internet headers of a message. * @@ -13170,7 +13170,7 @@ declare namespace Office { * * @beta */ - internetHeaders: Office.InternetHeaders; + internetHeaders: InternetHeaders; /** * Gets the type of item that an instance represents. * @@ -13185,7 +13185,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose */ - itemType: Office.MailboxEnums.ItemType; + itemType: MailboxEnums.ItemType; /** * Gets the notification messages for an item. * @@ -13197,7 +13197,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose */ - notificationMessages: Office.NotificationMessages; + notificationMessages: NotificationMessages; /** * Gets or sets the recurrence pattern of an appointment. Gets the recurrence pattern of a meeting request. * Read and compose modes for appointment items. Read mode for meeting request items. @@ -13297,20 +13297,20 @@ declare namespace Office { * * `addFileAttachmentAsync(uri: string, attachmentName: string, options: AsyncContextOptions): void;` * - * `addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: AsyncResult) => void): void;` + * `addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: Office.AsyncResult) => void): void;` * - * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 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. * 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 + * @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 uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of * the error. */ - addFileAttachmentAsync(uri: string, attachmentName: string, options?: AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addFileAttachmentAsync(uri: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds a file to a message or appointment as an attachment. * @@ -13327,8 +13327,8 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 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. */ addFileAttachmentAsync(uri: string, attachmentName: string): void; /** @@ -13347,13 +13347,13 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 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. * isInline: If true, indicates that the attachment will be shown inline in the message body and should not be displayed in the attachment list. */ - addFileAttachmentAsync(uri: string, attachmentName: string, options: AsyncContextOptions): void; + addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions): void; /** * Adds a file to a message or appointment as an attachment. * @@ -13370,18 +13370,18 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 + * @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 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. */ - addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: AsyncResult) => void): void; + addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: Office.AsyncResult) => void): void; /** * Adds a file to a message or appointment as an attachment. * - * The addFileAttachmentFromBase64Async method uploads the file from the base64 encoding and attaches it to the item in the compose form. This method returns the attachment identifier in the AsyncResult.value object. + * The addFileAttachmentFromBase64Async method uploads the file from the base64 encoding and attaches it to the item in the compose form. This method returns the attachment identifier in the asyncResult.value object. * * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. * @@ -13394,18 +13394,18 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @param base64File The base64 encoded content of an image or file to be added to an email or event. - * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param base64File - The base64 encoded content of an image or file to be added to an email or event. + * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 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. * 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 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 uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. * * @beta */ - addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an event handler for a supported event. * @@ -13422,17 +13422,17 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void;` + * `addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an event handler for a supported event. * @@ -13447,13 +13447,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. * @@ -13482,18 +13482,18 @@ declare namespace Office { * * `addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions): void;` * - * `addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: AsyncResult) => void): void;` + * `addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: Office.AsyncResult) => void): void;` * - * @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 options An object literal that contains one or more of the following properties. + * @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 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 AsyncResult. On success, the attachment identifier will be provided in the asyncResult.value property. + * @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. */ - addItemAttachmentAsync(itemId: any, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addItemAttachmentAsync(itemId: any, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. * @@ -13516,8 +13516,8 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 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. */ addItemAttachmentAsync(itemId: any, attachmentName: string): void; /** @@ -13542,9 +13542,9 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 options An object literal that contains one or more of the following properties. + * @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 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. */ addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions): void; @@ -13570,14 +13570,14 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 + * @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 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. */ - addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: AsyncResult) => void): void; + addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: Office.AsyncResult) => void): void; /** * Closes the current item that is being composed * @@ -13609,15 +13609,15 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @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 the call fails, the asyncResult.error property will contain and error code with the reason for * the failure. * * @beta */ - getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Gets initialization data passed when the add-in is activated by an actionable message. * @@ -13634,9 +13634,9 @@ declare namespace Office { * * More information on {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | actionable messages}. * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @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 @@ -13644,7 +13644,7 @@ declare namespace Office { * * @beta */ - getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * @@ -13665,12 +13665,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose * - * @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string, removing any HTML tags present. + * @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 + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - getSelectedDataAsync(coercionType: Office.CoercionType, callback: (result: AsyncResult) => void): void; + getSelectedDataAsync(coercionType: Office.CoercionType, callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * @@ -13691,14 +13691,14 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose * - * @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string, removing any HTML tags present. + * @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 options An object literal that contains one or more of the following properties. + * @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 + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - getSelectedDataAsync(coercionType: Office.CoercionType, options: Office.AsyncContextOptions, callback: (result: AsyncResult) => void): void; + getSelectedDataAsync(coercionType: Office.CoercionType, options: Office.AsyncContextOptions, callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously loads custom properties for this add-in on the selected item. * @@ -13718,12 +13718,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. - * @param userContext Optional. Developers can provide any object they wish to access in the callback function. + * @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. */ - loadCustomPropertiesAsync(callback: (result: AsyncResult) => void, userContext?: any): void; + loadCustomPropertiesAsync(callback: (result: Office.AsyncResult) => void, userContext?: any): void; /** * Removes an attachment from a message or appointment. * @@ -13749,16 +13749,16 @@ declare namespace Office { * * `removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions): void;` * - * `removeAttachmentAsync(attachmentId: string, callback: (result: AsyncResult) => void): void;` + * `removeAttachmentAsync(attachmentId: string, callback: (result: Office.AsyncResult) => void): void;` * - * @param attachmentId The identifier of the attachment to remove. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param attachmentId - The identifier of the attachment to remove. + * @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 + * @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(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + removeAttachmentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Removes an attachment from a message or appointment. * @@ -13778,7 +13778,7 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment to remove. + * @param attachmentId - The identifier of the attachment to remove. */ removeAttachmentAsync(attachmentId: string): void; /** @@ -13800,8 +13800,8 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment to remove. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param attachmentId - The identifier of the attachment to remove. + * @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. */ removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions): void; @@ -13824,12 +13824,12 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment to remove. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * @param attachmentId - The identifier of the attachment to remove. + * @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(attachmentId: string, callback: (result: AsyncResult) => void): void; + removeAttachmentAsync(attachmentId: string, callback: (result: Office.AsyncResult) => void): void; /** * Removes the event handlers for a supported event type. * @@ -13846,15 +13846,15 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `removeHandlerAsync(eventType:EventType, callback?: (result: AsyncResult) => void): void;` + * `removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should revoke the handler. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param eventType - The event that should revoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - removeHandlerAsync(eventType:EventType, options?: any, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Removes the event handlers for a supported event type. * @@ -13869,11 +13869,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose * - * @param eventType The event that should revoke the handler. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult object. + * @param eventType - The event that should revoke the handler. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. */ - removeHandlerAsync(eventType:EventType, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. * @@ -13911,14 +13911,14 @@ declare namespace Office { * * `saveAsync(options: Office.AsyncContextOptions): void;` * - * `saveAsync(callback: (result: AsyncResult) => void): void;` + * `saveAsync(callback: (result: Office.AsyncResult) => void): void;` * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @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; + saveAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. * @@ -13982,7 +13982,7 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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. */ saveAsync(options: Office.AsyncContextOptions): void; @@ -14017,10 +14017,10 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * @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; + saveAsync(callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * @@ -14044,11 +14044,11 @@ declare namespace Office { * * `setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions): void;` * - * `setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void;` + * `setSelectedDataAsync(data: string, callback: (result: Office.AsyncResult) => void): void;` * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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: If text, the current style is applied in Outlook Web App and Outlook. * If the field is an HTML editor, only the text data is inserted, even if the data is HTML. @@ -14056,10 +14056,10 @@ declare namespace Office { * applied in Outlook. If the field is a text field, an InvalidDataFormat error is returned. * 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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: AsyncResult) => void): void; + setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * @@ -14077,7 +14077,7 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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. */ setSelectedDataAsync(data: string): void; @@ -14098,9 +14098,9 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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: If text, the current style is applied in Outlook Web App and Outlook. * If the field is an HTML editor, only the text data is inserted, even if the data is HTML. @@ -14127,12 +14127,12 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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 - * typeOffice.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. */ - setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void; + setSelectedDataAsync(data: string, callback: (result: Office.AsyncResult) => void): void; } /** * The message read mode of {@link Office.Item | Office.context.mailbox.item}. @@ -14157,7 +14157,7 @@ declare namespace Office { * {@link https://support.office.com/article/Blocked-attachments-in-Outlook-434752E1-02D3-4E90-9124-8B81E49A8519 | Blocked attachments in Outlook}. * */ - attachments: Office.AttachmentDetails[]; + attachments: AttachmentDetails[]; /** * Gets an object that provides methods for manipulating the body of an item. * @@ -14169,7 +14169,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read */ - body: Office.Body; + body: Body; /** * Provides access to the Cc (carbon copy) recipients of a message. The type of object and level of access depends on the mode of the * current item. @@ -14265,7 +14265,7 @@ declare namespace Office { * * @beta */ - internetHeaders: Office.InternetHeaders; + internetHeaders: InternetHeaders; /** * Gets the Internet message identifier for an email message. * @@ -14320,7 +14320,7 @@ declare namespace Office { * * The itemId property is not available in compose mode. * If an item identifier is required, the saveAsync method can be used to save the item to the store, which will return the item identifier - * in the AsyncResult.value parameter in the callback function. + * in the asyncResult.value parameter in the callback function. * * Note: The identifier returned by the itemId property is the same as the Exchange Web Services item identifier. * The itemId property is not identical to the Outlook Entry ID or the ID used by the Outlook REST API. @@ -14350,7 +14350,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read */ - itemType: Office.MailboxEnums.ItemType; + itemType: MailboxEnums.ItemType; /** * Gets the subject of an item, with all prefixes removed (including RE: and FWD:). * @@ -14378,7 +14378,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - notificationMessages: Office.NotificationMessages; + notificationMessages: NotificationMessages; /** * Gets the recurrence pattern of an appointment. Gets the recurrence pattern of a meeting request. * Read and compose modes for appointment items. Read mode for meeting request items. @@ -14490,17 +14490,17 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void;` + * `addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an event handler for a supported event. @@ -14516,13 +14516,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void; /** * Displays a reply form that includes the sender and all recipients of the selected message or the organizer and all attendees of the * selected appointment. @@ -14544,7 +14544,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read * - * @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 + * @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 * OR * An {@link Office.ReplyFormData} object that contains body or attachment data and a callback function */ @@ -14570,7 +14570,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read * - * @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. + * @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. * OR * An {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. */ @@ -14592,19 +14592,19 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `getInitializationContextAsync(callback?: (result: AsyncResult) => void): void;` + * `getInitializationContextAsync(callback?: (result: Office.AsyncResult) => void): void;` * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 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. * * @beta */ - getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Gets initialization data passed when the add-in is * {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}. @@ -14620,15 +14620,15 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read * - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult 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 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. * * @beta */ - getInitializationContextAsync(callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(callback?: (result: Office.AsyncResult) => void): void; /** * Gets the entities found in the selected item's body. * @@ -14650,7 +14650,7 @@ declare namespace Office { * * [Api set: Mailbox 1.0] * - * @param entityType One of the EntityType enumeration values. + * @param entityType - One of the EntityType enumeration values. * * @returns * If the value passed in entityType is not a valid member of the EntityType enumeration, the method returns null. @@ -14709,7 +14709,7 @@ declare namespace Office { * * */ - getEntitiesByType(entityType: Office.MailboxEnums.EntityType): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; + getEntitiesByType(entityType: MailboxEnums.EntityType): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; /** * Returns well-known entities in the selected item that pass the named filter defined in the manifest XML file. * @@ -14726,7 +14726,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read * - * @param name The name of the ItemHasKnownEntity rule element that defines the filter to match. + * @param name - The name of the ItemHasKnownEntity rule element that defines the filter to match. * @returns If there is no ItemHasKnownEntity element in the manifest with a FilterName element value that matches the name parameter, * the method returns null. * If the name parameter does match an ItemHasKnownEntity element in the manifest, but there are no entities in the current item that match, @@ -14785,7 +14785,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read * - * @param name The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. + * @param name - The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. */ getRegExMatchesByName(name: string): string[]; /** @@ -14801,7 +14801,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read * - * @param name The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. + * @param name - The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. */ getSelectedEntities(): Entities; /** @@ -14853,12 +14853,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. - * @param userContext Optional. Developers can provide any object they wish to access in the callback function. + * @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. */ - loadCustomPropertiesAsync(callback: (result: AsyncResult) => void, userContext?: any): void; + loadCustomPropertiesAsync(callback: (result: Office.AsyncResult) => void, userContext?: any): void; /** * Removes the event handlers for a supported event type. * @@ -14875,15 +14875,15 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `removeHandlerAsync(eventType:EventType, callback?: (result: AsyncResult) => void): void;` + * `removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should revoke the handler. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param eventType - The event that should revoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - removeHandlerAsync(eventType:EventType, options?: any, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Removes the event handlers for a supported event type. * @@ -14898,11 +14898,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read * - * @param eventType The event that should revoke the handler. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult object. + * @param eventType - The event that should revoke the handler. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. */ - removeHandlerAsync(eventType:EventType, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void; } /** @@ -14967,9 +14967,9 @@ declare namespace Office { * The getAsync method starts an asynchronous call to the Exchange server to get the location of an appointment. * The location of the appointment is provided as a string in the asyncResult.value property. * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. * * [Api set: Mailbox 1.1] @@ -14981,17 +14981,17 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `getAsync(callback: (result: AsyncResult) => void): void;` + * `getAsync(callback: (result: Office.AsyncResult) => void): void;` * */ - getAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Gets the location of an appointment. * * The getAsync method starts an asynchronous call to the Exchange server to get the location of an appointment. * 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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. * * [Api set: Mailbox 1.1] @@ -15001,17 +15001,17 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose */ - getAsync(callback: (result: AsyncResult) => void): void; + getAsync(callback: (result: Office.AsyncResult) => void): void; /** * Sets the location of an appointment. * * The setAsync method starts an asynchronous call to the Exchange server to set the location of an appointment. * Setting the location of an appointment overwrites the current location. * - * @param location The location of the appointment. The string is limited to 255 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param location - The location of the appointment. The string is limited to 255 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 + * @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 setting the location fails, the asyncResult.error property will contain an error code. * * [Api set: Mailbox 1.1] @@ -15029,16 +15029,16 @@ declare namespace Office { * * `setAsync(location: string, options: Office.AsyncContextOptions): void;` * - * `setAsync(location: string, callback: (result: AsyncResult) => void): void;` + * `setAsync(location: string, callback: (result: Office.AsyncResult) => void): void;` */ - setAsync(location: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + setAsync(location: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Sets the location of an appointment. * * The setAsync method starts an asynchronous call to the Exchange server to set the location of an appointment. * Setting the location of an appointment overwrites the current location. * - * @param location The location of the appointment. The string is limited to 255 characters. + * @param location - The location of the appointment. The string is limited to 255 characters. * * [Api set: Mailbox 1.1] * @@ -15056,8 +15056,8 @@ declare namespace Office { * The setAsync method starts an asynchronous call to the Exchange server to set the location of an appointment. * Setting the location of an appointment overwrites the current location. * - * @param location The location of the appointment. The string is limited to 255 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param location - The location of the appointment. The string is limited to 255 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. * * [Api set: Mailbox 1.1] @@ -15076,8 +15076,8 @@ declare namespace Office { * The setAsync method starts an asynchronous call to the Exchange server to set the location of an appointment. * Setting the location of an appointment overwrites the current location. * - * @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 + * @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 Office.AsyncResult. If setting the location fails, the asyncResult.error property will contain an error code. * * [Api set: Mailbox 1.1] @@ -15089,7 +15089,7 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The location parameter is longer than 255 characters. */ - setAsync(location: string, callback: (result: AsyncResult) => void): void; + setAsync(location: string, callback: (result: Office.AsyncResult) => void): void; } /** * Provides access to the Outlook Add-in object model for Microsoft Outlook and Microsoft Outlook on the web. @@ -15137,7 +15137,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - diagnostics: Office.Diagnostics; + diagnostics: Diagnostics; /** * Gets the URL of the Exchange Web Services (EWS) endpoint for this email account. Read mode only. * @@ -15189,7 +15189,7 @@ declare namespace Office { * * More information is under {@link Office.UserProfile} */ - userProfile: Office.UserProfile; + userProfile: UserProfile; /** * Adds an event handler for a supported event. * @@ -15203,14 +15203,14 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 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 + * @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 Office.AsyncResult. */ - addHandlerAsync(eventType: Office.EventType, handler: (type: EventType) => void, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: (type: Office.EventType) => void, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Converts an item ID formatted for REST into EWS format. * @@ -15227,10 +15227,10 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param itemId An item ID formatted for the Outlook REST APIs. - * @param restVersion A value indicating the version of the Outlook REST API used to retrieve the item ID. + * @param itemId - An item ID formatted for the Outlook REST APIs. + * @param restVersion - A value indicating the version of the Outlook REST API used to retrieve the item ID. */ - convertToEwsId(itemId: string, restVersion: Office.MailboxEnums.RestVersion): string; + convertToEwsId(itemId: string, restVersion: MailboxEnums.RestVersion): string; /** * Gets a dictionary containing time information in local client time. * @@ -15252,7 +15252,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param timeValue A Date object. + * @param timeValue - A Date object. */ convertToLocalClientTime(timeValue: Date): LocalClientTime; /** @@ -15272,10 +15272,10 @@ declare namespace Office { * {@link https://docs.microsoft.com/previous-versions/office/office-365-api/api/version-2.0/mail-rest-operations | Outlook Mail API} or the {@link https://graph.microsoft.io/ | Microsoft Graph}. * The convertToRestId method converts an EWS-formatted ID into the proper format for REST. * - * @param itemId An item ID formatted for Exchange Web Services (EWS) - * @param restVersion A value indicating the version of the Outlook REST API that the converted ID will be used with. + * @param itemId - An item ID formatted for Exchange Web Services (EWS) + * @param restVersion - A value indicating the version of the Outlook REST API that the converted ID will be used with. */ - convertToRestId(itemId: string, restVersion: Office.MailboxEnums.RestVersion): string; + convertToRestId(itemId: string, restVersion: MailboxEnums.RestVersion): string; /** * Gets a Date object from a dictionary containing time information. * @@ -15290,7 +15290,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param input The local time value to convert. + * @param input - The local time value to convert. * @returns A Date object with the time expressed in UTC. */ convertToUtcClientTime(input: LocalClientTime): Date; @@ -15319,7 +15319,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param itemId The Exchange Web Services (EWS) identifier for an existing calendar appointment. + * @param itemId - The Exchange Web Services (EWS) identifier for an existing calendar appointment. */ displayAppointmentForm(itemId: string): void; /** @@ -15345,7 +15345,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param itemId The Exchange Web Services (EWS) identifier for an existing message. + * @param itemId - The Exchange Web Services (EWS) identifier for an existing message. */ displayMessageForm(itemId: string): void; /** @@ -15374,7 +15374,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Read * - * @param parameters An AppointmentForm describing the new appointment. All properties are optional. + * @param parameters - An AppointmentForm describing the new appointment. All properties are optional. */ displayNewAppointmentForm(parameters: AppointmentForm): void; /** @@ -15393,7 +15393,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Read * - * @param parameters A dictionary containing all values to be filled in for the user in the new form. All parameters are optional. + * @param parameters - A dictionary containing all values to be filled in for the user in the new form. All parameters are optional. * * toRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails} object * for each of the recipients on the To line. The array is limited to a maximum of 100 entries. @@ -15458,18 +15458,18 @@ declare namespace Office { * * In addition to this signature, the method has the following signatures: * - * `getCallbackTokenAsync(callback: (result: AsyncResult) => void): void;` + * `getCallbackTokenAsync(callback: (result: Office.AsyncResult) => void): void;` * - * `getCallbackTokenAsync(callback: (result: AsyncResult) => void, userContext?: any): void;` + * `getCallbackTokenAsync(callback: (result: Office.AsyncResult) => void, userContext?: any): void;` * - * @param options An object literal that contains one or more of the following properties. + * @param options - An object literal that contains one or more of the following properties. * 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 + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. The token is provided as a string in the `asyncResult.value` property. * If there was an error, then the `asyncResult.error` and `asyncResult.diagnostics` properties may provide additional information. */ - getCallbackTokenAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (result: AsyncResult) => void): void; + getCallbackTokenAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (result: Office.AsyncResult) => void): void; /** * Gets a string that contains a token used to get an attachment or item from an Exchange Server. * @@ -15493,11 +15493,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose and read * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type 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 token is provided as a string in the `asyncResult.value` property. * If there was an error, then the `asyncResult.error` and `asyncResult.diagnostics` properties may provide additional information. */ - getCallbackTokenAsync(callback: (result: AsyncResult) => void): void; + getCallbackTokenAsync(callback: (result: Office.AsyncResult) => void): void; /** * Gets a string that contains a token used to get an attachment or item from an Exchange Server. * @@ -15521,12 +15521,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose and read * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. The token is provided as a string in the `asyncResult.value` property. * If there was an error, then the `asyncResult.error` and `asyncResult.diagnostics` properties may provide additional information. - * @param userContext Optional. Any state data that is passed to the asynchronous method. + * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ - getCallbackTokenAsync(callback: (result: AsyncResult) => void, userContext?: any): void; + getCallbackTokenAsync(callback: (result: Office.AsyncResult) => void, userContext?: any): void; /** * Gets a token identifying the user and the Office Add-in. * @@ -15543,13 +15543,13 @@ declare namespace Office { * The getUserIdentityTokenAsync method returns a token that you can use to identify and * {@link https://docs.microsoft.com/outlook/add-ins/authentication | 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 + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. * The token is provided as a string in the `asyncResult.value` property. * If there was an error, then the `asyncResult.error` and `asyncResult.diagnostics` properties may provide additional information. - * @param userContext Optional. Any state data that is passed to the asynchronous method.| + * @param userContext - Optional. Any state data that is passed to the asynchronous method.| */ - getUserIdentityTokenAsync(callback: (result: AsyncResult) => void, userContext?: any): void; + getUserIdentityTokenAsync(callback: (result: Office.AsyncResult) => void, userContext?: any): void; /** * Makes an asynchronous request to an Exchange Web Services (EWS) service on the Exchange server that hosts the user's mailbox. * @@ -15596,13 +15596,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose and read * - * @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 Office.AsyncResult. + * @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 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. + * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ - makeEwsRequestAsync(data: any, callback: (result: AsyncResult) => void, userContext?: any): void; + makeEwsRequestAsync(data: any, callback: (result: Office.AsyncResult) => void, userContext?: any): void; /** * Removes the event handlers for a supported event type. * @@ -15616,12 +15616,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param eventType The event that should revoke the handler. - * @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 + * @param eventType - The event that should revoke the handler. + * @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 Office.AsyncResult. */ - removeHandlerAsync(eventType: Office.EventType, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; } /** @@ -15688,7 +15688,7 @@ declare namespace Office { * Including them will result in an ArgumentException. * If type is ProgressIndicator, the developer should remove or replace the progress indicator when the action is complete. */ - type: Office.MailboxEnums.ItemNotificationMessageType; + type: MailboxEnums.ItemNotificationMessageType; /** * A reference to an icon that is defined in the manifest in the Resources section. It appears in the infobar area. * It is only applicable if the type is InformationalMessage. Specifying this parameter for an unsupported type results in an exception. @@ -15723,13 +15723,13 @@ declare namespace Office { * * There are a maximum of 5 notifications per message. Setting more will return a NumberOfNotificationMessagesExceeded error. * - * @param key A developer-specified key used to reference this notification message. + * @param key - A developer-specified key used to reference this notification message. * Developers can use it to modify this message later. It can't be longer than 32 characters. - * @param JSONmessage A JSON object that contains the notification message to be added to the item. + * @param JSONmessage - A JSON object that contains the notification message to be added to the item. * It contains a NotificationMessageDetails object. - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. * * [Api set: Mailbox 1.3] @@ -15745,18 +15745,18 @@ declare namespace Office { * * `addAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions): void;` * - * `addAsync(key: string, JSONmessage: NotificationMessageDetails, callback: (result: AsyncResult) => void): void;` + * `addAsync(key: string, JSONmessage: NotificationMessageDetails, callback: (result: Office.AsyncResult) => void): void;` * */ - addAsync(key: string, JSONmessage: NotificationMessageDetails, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addAsync(key: string, JSONmessage: NotificationMessageDetails, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds a notification to an item. * * There are a maximum of 5 notifications per message. Setting more will return a NumberOfNotificationMessagesExceeded error. * - * @param key A developer-specified key used to reference this notification message. Developers can use it to modify this message later. + * @param key - A developer-specified key used to reference this notification message. Developers can use it to modify this message later. * It can't be longer than 32 characters. - * @param JSONmessage A JSON object that contains the notification message to be added to the item. + * @param JSONmessage - A JSON object that contains the notification message to be added to the item. * It contains a NotificationMessageDetails object. * * [Api set: Mailbox 1.3] @@ -15772,11 +15772,11 @@ declare namespace Office { * * There are a maximum of 5 notifications per message. Setting more will return a NumberOfNotificationMessagesExceeded error. * - * @param key A developer-specified key used to reference this notification message. Developers can use it to modify this message later. + * @param key - A developer-specified key used to reference this notification message. Developers can use it to modify this message later. * It can't be longer than 32 characters. - * @param JSONmessage A JSON object that contains the notification message to be added to the item. + * @param JSONmessage - A JSON object that contains the notification message to be added to the item. * It contains a NotificationMessageDetails object. - * @param options Optional. An object literal that contains one or more of the following properties. + * @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. * * [Api set: Mailbox 1.3] @@ -15792,11 +15792,11 @@ declare namespace Office { * * There are a maximum of 5 notifications per message. Setting more will return a NumberOfNotificationMessagesExceeded error. * - * @param key A developer-specified key used to reference this notification message. Developers can use it to modify this message later. + * @param key - A developer-specified key used to reference this notification message. Developers can use it to modify this message later. * It can't be longer than 32 characters. - * @param JSONmessage A JSON object that contains the notification message to be added to the item. + * @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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. * * [Api set: Mailbox 1.3] @@ -15806,7 +15806,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - addAsync(key: string, JSONmessage: NotificationMessageDetails, callback: (result: AsyncResult) => void): void; + addAsync(key: string, JSONmessage: NotificationMessageDetails, callback: (result: Office.AsyncResult) => void): void; /** * Returns all keys and messages for an item. * @@ -15819,14 +15819,14 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `getAllAsync(callback: (result: AsyncResult) => void): void;` + * `getAllAsync(callback: (result: Office.AsyncResult) => void): void;` * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 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) => void): void; + getAllAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Returns all keys and messages for an item. * @@ -15837,10 +15837,10 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type 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) => void): void; + getAllAsync(callback: (result: Office.AsyncResult) => void): void; /** * Removes a notification message for an item. * @@ -15857,15 +15857,15 @@ declare namespace Office { * * `removeAsync(key: string, options: Office.AsyncContextOptions): void;` * - * `removeAsync(key: string, callback: (result: AsyncResult) => void): void;` + * `removeAsync(key: string, callback: (result: Office.AsyncResult) => void): void;` * - * @param key The key for the notification message to remove. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param key - The key for the notification message to remove. + * @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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - removeAsync(key: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + removeAsync(key: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Removes a notification message for an item. * @@ -15876,7 +15876,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param key The key for the notification message to remove. + * @param key - The key for the notification message to remove. */ removeAsync(key: string): void; /** @@ -15889,8 +15889,8 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param key The key for the notification message to remove. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param key - The key for the notification message to remove. + * @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. */ removeAsync(key: string, options: Office.AsyncContextOptions): void; @@ -15904,11 +15904,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @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 + * @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 Office.AsyncResult. */ - removeAsync(key: string, callback: (result: AsyncResult) => void): void; + removeAsync(key: string, callback: (result: Office.AsyncResult) => void): void; /** * Replaces a notification message that has a given key with another message. * @@ -15927,17 +15927,17 @@ declare namespace Office { * * `replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions): void;` * - * `replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback: (result: AsyncResult) => void): void;` + * `replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback: (result: Office.AsyncResult) => void): void;` * - * @param key The key for the notification message to replace. It can't be longer than 32 characters. - * @param JSONmessage A JSON object that contains the new notification message to replace the existing message. + * @param key - The key for the notification message to replace. It can't be longer than 32 characters. + * @param JSONmessage - A JSON object that contains the new notification message to replace the existing message. * It contains a NotificationMessageDetails object. - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Replaces a notification message that has a given key with another message. * @@ -15950,8 +15950,8 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param key The key for the notification message to replace. It can't be longer than 32 characters. - * @param JSONmessage A JSON object that contains the new notification message to replace the existing message. + * @param key - The key for the notification message to replace. It can't be longer than 32 characters. + * @param JSONmessage - A JSON object that contains the new notification message to replace the existing message. * It contains a NotificationMessageDetails object. */ replaceAsync(key: string, JSONmessage: NotificationMessageDetails): void; @@ -15967,10 +15967,10 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param key The key for the notification message to replace. It can't be longer than 32 characters. - * @param JSONmessage A JSON object that contains the new notification message to replace the existing message. + * @param key - The key for the notification message to replace. It can't be longer than 32 characters. + * @param JSONmessage - A JSON object that contains the new notification message to replace the existing message. * It contains a NotificationMessageDetails object. - * @param options Optional. An object literal that contains one or more of the following properties. + * @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. */ replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions): void; @@ -15986,13 +15986,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param key The key for the notification message to replace. It can't be longer than 32 characters. - * @param JSONmessage A JSON object that contains the new notification message to replace the existing message. + * @param key - The key for the notification message to replace. It can't be longer than 32 characters. + * @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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback: (result: AsyncResult) => void): void; + replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback: (result: Office.AsyncResult) => void): void; } /** * Represents a phone number identified in an item. Read mode only. @@ -16056,15 +16056,15 @@ declare namespace Office { * * `addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options: Office.AsyncContextOptions): void;` * - * `addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], callback: (result: AsyncResult) => void): void;` + * `addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], callback: (result: Office.AsyncResult) => void): void;` * - * @param recipients The recipients to add to the recipients list. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param recipients - The recipients to add to the recipients list. + * @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 + * @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 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; + addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds a recipient list to the existing recipients for an appointment or message. * @@ -16085,7 +16085,7 @@ declare namespace Office { * * ErrorsNumberOfRecipientsExceeded - The number of recipients exceeded 100 entries. * - * @param recipients The recipients to add to the recipients list. + * @param recipients - The recipients to add to the recipients list. */ addAsync(recipients: (string | EmailUser | EmailAddressDetails)[]): void; /** @@ -16108,8 +16108,8 @@ declare namespace Office { * * ErrorsNumberOfRecipientsExceeded - The number of recipients exceeded 100 entries. * - * @param recipients The recipients to add to the recipients list. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param recipients - The recipients to add to the recipients list. + * @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. */ addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options: Office.AsyncContextOptions): void; @@ -16133,11 +16133,11 @@ declare namespace Office { * * ErrorsNumberOfRecipientsExceeded - The number of recipients exceeded 100 entries. * - * @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 + * @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 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; + addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], callback: (result: Office.AsyncResult) => void): void; /** * Gets a recipient list for an appointment or message. * @@ -16152,15 +16152,15 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `getAsync(callback: (result: AsyncResult) => void): void;` + * `getAsync(callback: (result: Office.AsyncResult) => void): void;` * - * @param options An object literal that contains one or more of the following properties. + * @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 + * @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 an array of EmailAddressDetails objects. */ - getAsync(options: Office.AsyncContextOptions, callback: (result: AsyncResult) => void): void; + getAsync(options: Office.AsyncContextOptions, callback: (result: Office.AsyncResult) => void): void; /** * Gets a recipient list for an appointment or message. * @@ -16173,11 +16173,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of + * @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 an array of EmailAddressDetails objects. */ - getAsync(callback: (result: AsyncResult) => void): void; + getAsync(callback: (result: Office.AsyncResult) => void): void; /** * Sets a recipient list for an appointment or message. * @@ -16206,17 +16206,17 @@ declare namespace Office { * * `setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options: Office.AsyncContextOptions): void;` * - * `setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], callback: (result: AsyncResult) => void): void;` + * `setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], callback: (result: Office.AsyncResult) => void): void;` * - * @param recipients The recipients to add to the recipients list. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param recipients - The recipients to add to the recipients list. + * @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 + * @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 setting the recipients fails the asyncResult.error property will contain a code that indicates any error that occurred * while adding the data. */ - setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Sets a recipient list for an appointment or message. * @@ -16239,7 +16239,7 @@ declare namespace Office { * * ErrorsNumberOfRecipientsExceeded - The number of recipients exceeded 100 entries. * - * @param recipients The recipients to add to the recipients list. + * @param recipients - The recipients to add to the recipients list. */ setAsync(recipients: (string | EmailUser | EmailAddressDetails)[]): void; /** @@ -16264,8 +16264,8 @@ declare namespace Office { * * ErrorsNumberOfRecipientsExceeded - The number of recipients exceeded 100 entries. * - * @param recipients The recipients to add to the recipients list. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param recipients - The recipients to add to the recipients list. + * @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. */ setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options: Office.AsyncContextOptions): void; @@ -16291,13 +16291,13 @@ declare namespace Office { * * ErrorsNumberOfRecipientsExceeded - The number of recipients exceeded 100 entries. * - * @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 + * @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 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. */ - setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], callback: (result: AsyncResult) => void): void; + setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], callback: (result: Office.AsyncResult) => void): void; } @@ -16354,7 +16354,7 @@ declare namespace Office { * * */ - export interface Recurrence { + interface Recurrence { /** * Gets or sets the properties of the recurring appointment series. * @@ -16366,7 +16366,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - recurrenceProperties: Office.RecurrenceProperties; + recurrenceProperties: RecurrenceProperties; /** * Gets or sets the properties of the recurring appointment series. * @@ -16378,7 +16378,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - recurrenceTimeZone: Office.RecurrenceTimeZone; + recurrenceTimeZone: RecurrenceTimeZone; /** * Gets or sets the type of the recurring appointment series. @@ -16391,7 +16391,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - recurrenceType: Office.MailboxEnums.RecurrenceType; + recurrenceType: MailboxEnums.RecurrenceType; /** * The {@link Office.SeriesTime} object enables you to manage the start and end dates of the recurring appointment series and the usual start @@ -16406,7 +16406,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - seriesTime: Office.SeriesTime; + seriesTime: SeriesTime; /** * Returns the current recurrence object of an appointment series. @@ -16423,15 +16423,15 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `getAsync(callback?: (result: AsyncResult) => void): void;` + * `getAsync(callback?: (result: Office.AsyncResult) => void): void;` * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 Office.AsyncResult object. * The `value` property of the result is a Recurrence object. */ - getAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Returns the current recurrence object of an appointment series. @@ -16446,11 +16446,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult 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 Office.AsyncResult object. * The `value` property of the result is a Recurrence object. */ - getAsync(callback?: (result: AsyncResult) => void): void; + getAsync(callback?: (result: Office.AsyncResult) => void): void; /** * Sets the recurrence pattern of an appointment series. @@ -16469,15 +16469,15 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `setAsync(recurrencePattern: Recurrence, callback?: (result: AsyncResult) => void): void;` + * `setAsync(recurrencePattern: Recurrence, callback?: (result: Office.AsyncResult) => void): void;` * - * @param recurrencePattern A recurrence object. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param recurrencePattern - A recurrence object. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - setAsync(recurrencePattern: Recurrence, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + setAsync(recurrencePattern: Recurrence, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Sets the recurrence pattern of an appointment series. @@ -16494,11 +16494,11 @@ declare namespace Office { * * ErrorsInvalidEndTime - The appointment end time is before its start time. * - * @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 Office.AsyncResult object. + * @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 Office.AsyncResult object. */ - setAsync(recurrencePattern: Recurrence, callback?: (result: AsyncResult) => void): void; + setAsync(recurrencePattern: Recurrence, callback?: (result: Office.AsyncResult) => void): void; } /** @@ -16512,7 +16512,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - export interface RecurrenceProperties { + interface RecurrenceProperties { /** * Represents the period between instances of the same recurring series. */ @@ -16524,24 +16524,24 @@ declare namespace Office { /** * Represents the day of the week or type of day, for example, weekend day vs weekday. */ - dayOfWeek: Office.MailboxEnums.Days; + dayOfWeek: MailboxEnums.Days; /** * Represents the set of days for this recurrence. Valid values are: 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', and 'Sun'. */ - days: Office.MailboxEnums.Days[]; + days: MailboxEnums.Days[]; /** * Represents the number of the week in the selected month e.g. 'first' for first week of the month. */ - weekNumber: Office.MailboxEnums.WeekNumber; + weekNumber: MailboxEnums.WeekNumber; /** * Represents the month. */ - month: Office.MailboxEnums.Month; + month: MailboxEnums.Month; /** * Represents your chosen first day of the week otherwise the default is the value in the current user's settings. * Valid values are: 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', and 'Sun'. */ - firstDayOfWeek: Office.MailboxEnums.Days; + firstDayOfWeek: MailboxEnums.Days; } /** @@ -16555,11 +16555,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - export interface RecurrenceTimeZone { + interface RecurrenceTimeZone { /** * Represents the name of the recurrence time zone. */ - name: Office.MailboxEnums.RecurrenceTimeZone; + name: MailboxEnums.RecurrenceTimeZone; /** * Integer value representing the difference in minutes between the local time zone and UTC at the date that the meeting series began. @@ -16570,7 +16570,7 @@ declare namespace Office { /** * A file or item attachment. Used when displaying a reply form. */ - export interface ReplyFormAttachment { + interface ReplyFormAttachment { /** * Indicates the type of attachment. Must be file for a file attachment or item for an item attachment. */ @@ -16608,9 +16608,9 @@ 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 Office.AsyncResult object. + *asyncResult, which is an Office.AsyncResult object. */ - callback?: (result: AsyncResult) => void; + callback?: (result: Office.AsyncResult) => void; } /** * The settings created by using the methods of the RoamingSettings object are saved per add-in and per user. @@ -16647,7 +16647,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param name The case-sensitive name of the setting to retrieve. + * @param name - The case-sensitive name of the setting to retrieve. * @returns Type: String | Number | Boolean | Object | Array */ get(name: string): any; @@ -16661,7 +16661,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param name The case-sensitive name of the setting to remove. + * @param name - The case-sensitive name of the setting to remove. */ remove(name: string): void; /** @@ -16678,10 +16678,10 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * @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; + saveAsync(callback?: (result: Office.AsyncResult) => void): void; /** * Sets or creates the specified setting. * @@ -16699,8 +16699,8 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param name The case-sensitive name of the setting to set or create. - * @param value Specifies the value to be stored. + * @param name - The case-sensitive name of the setting to set or create. + * @param value - Specifies the value to be stored. */ set(name: string, value: any): void; } @@ -16790,7 +16790,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param minutes The length of the appointment in minutes. + * @param minutes - The length of the appointment in minutes. */ setDuration(minutes: number): void; @@ -16811,9 +16811,9 @@ declare namespace Office { * `setEndDate(date: string): void;` (Where date is the end date of the recurring appointment series represented in the * {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD"). * - * @param year The year value of the end date. - * @param month The month value of the end date. Valid range is 0-11 where 0 represents the 1st month and 11 represents the 12th month. - * @param day The day value of the end date. + * @param year - The year value of the end date. + * @param month - The month value of the end date. Valid range is 0-11 where 0 represents the 1st month and 11 represents the 12th month. + * @param day - The day value of the end date. */ setEndDate(year: number, month: number, day: number): void; /** @@ -16828,7 +16828,7 @@ declare namespace Office { * * ErrorsInvalid date format - The date is not in an acceptable format. * - * @param date End date of the recurring appointment series represented in the {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD". + * @param date - End date of the recurring appointment series represented in the {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD". */ setEndDate(date: string): void; /** @@ -16847,9 +16847,9 @@ declare namespace Office { * * `setStartDate(date: string): void;` (Where date is the start date of the recurring appointment series represented in the {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD"). * - * @param year The year value of the start date. - * @param month The month value of the start date. Valid range is 0-11 where 0 represents the 1st month and 11 represents the 12th month. - * @param day The day value of the start date. + * @param year - The year value of the start date. + * @param month - The month value of the start date. Valid range is 0-11 where 0 represents the 1st month and 11 represents the 12th month. + * @param day - The day value of the start date. */ setStartDate(year:number, month:number, day:number): void; @@ -16865,7 +16865,7 @@ declare namespace Office { * * ErrorsInvalid date format - The date is not in an acceptable format. * - * @param date Start date of the recurring appointment series represented in the {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD". + * @param date - Start date of the recurring appointment series represented in the {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD". */ setStartDate(date:string): void; @@ -16886,8 +16886,8 @@ declare namespace Office { * * `setStartTime(time: string): void;` (Where time is the start time of all instances represented by standard datetime string format: "THH:mm:ss:mmm"). * - * @param hours The hour value of the start time. Valid range: 0-24. - * @param minutes The minute value of the start time. Valid range: 0-59. + * @param hours - The hour value of the start time. Valid range: 0-24. + * @param minutes - The minute value of the start time. Valid range: 0-59. */ setStartTime(hours: number, minutes: number): void; @@ -16904,7 +16904,7 @@ declare namespace Office { * * ErrorsInvalid time format - The time is not in an acceptable format. * - * @param time Start time of all instances represented by standard datetime string format: "THH:mm:ss:mmm". + * @param time - Start time of all instances represented by standard datetime string format: "THH:mm:ss:mmm". */ setStartTime(time: string): void; } @@ -16933,7 +16933,7 @@ declare namespace Office { /** * The permissions that the delegate has on a shared folder. */ - delegatePermissions: Office.MailboxEnums.DelegatePermissions; + delegatePermissions: MailboxEnums.DelegatePermissions; } /** @@ -16961,15 +16961,15 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `getAsync(callback: (result: AsyncResult) => void): void;` + * `getAsync(callback: (result: Office.AsyncResult) => void): void;` * - * @param options An object literal that contains one or more of the following properties. + * @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 + * @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 subject of the item. */ - getAsync(options: Office.AsyncContextOptions, callback: (result: AsyncResult) => void): void; + getAsync(options: Office.AsyncContextOptions, callback: (result: Office.AsyncResult) => void): void; /** * Gets the subject of an appointment or message. * @@ -16982,10 +16982,10 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type 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 subject of the item. */ - getAsync(callback: (result: AsyncResult) => void): void; + getAsync(callback: (result: Office.AsyncResult) => void): void; /** * Sets the subject of an appointment or message. * @@ -17007,15 +17007,15 @@ declare namespace Office { * * `setAsync(subject: string, options: Office.AsyncContextOptions): void;` * - * `setAsync(subject: string, callback: (result: AsyncResult) => void): void;` + * `setAsync(subject: string, callback: (result: Office.AsyncResult) => void): void;` * - * @param subject The subject of the appointment or message. The string is limited to 255 characters. - * @param options An object literal that contains one or more of the following properties. + * @param subject - The subject of the appointment or message. The string is limited to 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 + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * 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; + setAsync(subject: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Sets the subject of an appointment or message. * @@ -17031,7 +17031,7 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The subject parameter is longer than 255 characters. * - * @param subject The subject of the appointment or message. The string is limited to 255 characters. + * @param subject - The subject of the appointment or message. The string is limited to 255 characters. */ setAsync(data: string): void; /** @@ -17049,8 +17049,8 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The subject parameter is longer than 255 characters. * - * @param subject The subject of the appointment or message. The string is limited to 255 characters. - * @param options An object literal that contains one or more of the following properties. + * @param subject - The subject of the appointment or message. The string is limited to 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. */ setAsync(data: string, options: Office.AsyncContextOptions): void; @@ -17069,11 +17069,11 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The subject parameter is longer than 255 characters. * - * @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 + * @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 Office.AsyncResult. If setting the subject fails, the asyncResult.error property will contain an error code. */ - setAsync(data: string, callback: (result: AsyncResult) => void): void; + setAsync(data: string, callback: (result: Office.AsyncResult) => void): void; } /** @@ -17125,14 +17125,14 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `getAsync(callback: (result: AsyncResult) => void): void;` + * `getAsync(callback: (result: Office.AsyncResult) => void): void;` * - * @param options An object literal that contains one or more of the following properties. + * @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 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 a Date object. */ - getAsync(options: Office.AsyncContextOptions, callback: (result: AsyncResult) => void): void; + getAsync(options: Office.AsyncContextOptions, callback: (result: Office.AsyncResult) => void): void; /** * Gets the start or end time of an appointment. * @@ -17146,10 +17146,10 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type 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 a Date object. */ - getAsync(callback: (result: AsyncResult) => void): void; + getAsync(callback: (result: Office.AsyncResult) => void): void; /** * Sets the start or end time of an appointment. * @@ -17173,16 +17173,16 @@ declare namespace Office { * * `setAsync(dateTime: Date, options: Office.AsyncContextOptions): void;` * - * `setAsync(dateTime: Date, callback: (result: AsyncResult) => void): void;` + * `setAsync(dateTime: Date, callback: (result: Office.AsyncResult) => void): void;` * - * @param dateTime A date-time object in Coordinated Universal Time (UTC). - * @param options An object literal that contains one or more of the following properties. + * @param dateTime - A date-time object in Coordinated Universal Time (UTC). + * @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 + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * 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; + setAsync(dateTime: Date, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Sets the start or end time of an appointment. * @@ -17200,7 +17200,7 @@ declare namespace Office { * * ErrorsInvalidEndTime - The appointment end time is before the appointment start time. * - * @param dateTime A date-time object in Coordinated Universal Time (UTC). + * @param dateTime - A date-time object in Coordinated Universal Time (UTC). */ setAsync(dateTime: Date): void; /** @@ -17220,8 +17220,8 @@ declare namespace Office { * * ErrorsInvalidEndTime - The appointment end time is before the appointment start time. * - * @param dateTime A date-time object in Coordinated Universal Time (UTC). - * @param options An object literal that contains one or more of the following properties. + * @param dateTime - A date-time object in Coordinated Universal Time (UTC). + * @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. */ setAsync(dateTime: Date, options: Office.AsyncContextOptions): void; @@ -17242,12 +17242,12 @@ declare namespace Office { * * ErrorsInvalidEndTime - The appointment end time is before the appointment start time. * - * @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 + * @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 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; + setAsync(dateTime: Date, callback: (result: Office.AsyncResult) => void): void; } /** diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 3046c98234..05a1655c13 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -8499,7 +8499,7 @@ declare namespace Office { } } interface CoercionTypeOptions { - coercionType?: CoercionType; + coercionType?: Office.CoercionType; } enum SourceProperty { /** @@ -8697,7 +8697,7 @@ declare namespace Office { * * For cloud attachments, the formatting is a URL string. */ - format: Office.MailboxEnums.AttachmentContentFormat; + format: MailboxEnums.AttachmentContentFormat; } /** * Represents an attachment on an item from the server. Read mode only. @@ -8715,7 +8715,7 @@ declare namespace Office { /** * Gets a value that indicates the type of an attachment. */ - attachmentType: Office.MailboxEnums.AttachmentType; + attachmentType: MailboxEnums.AttachmentType; /** * Gets the MIME content type of the attachment. */ @@ -8767,15 +8767,15 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `getAsync(coercionType: Office.CoercionType, callback: (result: AsyncResult) => void): void;` + * `getAsync(coercionType: Office.CoercionType, callback: (result: Office.AsyncResult) => void): void;` * - * @param coercionType The format for the returned body. - * @param options Optional. An object literal that contains one or more of the following properties: + * @param coercionType - The format for the returned body. + * @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 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, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getAsync(coercionType: Office.CoercionType, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Returns the current body in a specified format. * @@ -8792,11 +8792,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @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 Office.AsyncResult. + * @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 Office.AsyncResult. * The body is provided in the requested format in the asyncResult.value property. */ - getAsync(coercionType: Office.CoercionType, callback: (result: AsyncResult) => void): void; + getAsync(coercionType: Office.CoercionType, callback: (result: Office.AsyncResult) => void): void; /** * Gets a value that indicates whether the content is in HTML or text format. @@ -8808,12 +8808,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 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) => void): void; + getTypeAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds the specified content to the beginning of the item body. * @@ -8836,18 +8836,18 @@ declare namespace Office { * * `prependAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions): void;` * - * `prependAsync(data: string, callback: (result: AsyncResult) => void): void;` + * `prependAsync(data: string, callback: (result: Office.AsyncResult) => void): void;` * * `prependAsync(data: string): void;` * - * @param data The string to be inserted at the beginning of the body. The string is limited to 1,000,000 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param data - The string to be inserted at the beginning of the body. The string is limited to 1,000,000 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. * 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 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; + prependAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds the specified content to the beginning of the item body. * @@ -8866,8 +8866,8 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters. * - * @param data The string to be inserted at the beginning of the body. The string is limited to 1,000,000 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param data - The string to be inserted at the beginning of the body. The string is limited to 1,000,000 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. * coercionType: The desired format for the body. The string in the data parameter will be converted to this format. */ @@ -8888,11 +8888,11 @@ declare namespace Office { * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters. * - * @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 Office.AsyncResult. + * @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 Office.AsyncResult. * Any errors encountered will be provided in the asyncResult.error property. */ - prependAsync(data: string, callback: (result: AsyncResult) => void): void; + prependAsync(data: string, callback: (result: Office.AsyncResult) => void): void; /** * Adds the specified content to the beginning of the item body. * @@ -8909,7 +8909,7 @@ declare namespace Office { * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters. * - * @param data The string to be inserted at the beginning of the body. The string is limited to 1,000,000 characters. + * @param data - The string to be inserted at the beginning of the body. The string is limited to 1,000,000 characters. */ prependAsync(data: string): void; /** @@ -8935,18 +8935,18 @@ declare namespace Office { * * `setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions): void;` * - * `setAsync(data: string, callback: (result: AsyncResult) => void): void;` + * `setAsync(data: string, callback: (result: Office.AsyncResult) => void): void;` * * `setAsync(data: string): void;` * - * @param data The string that will replace the existing body. The string is limited to 1,000,000 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param data - The string that will replace the existing body. The string is limited to 1,000,000 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. * 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 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; + setAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Replaces the entire body with the specified text. * @@ -8966,8 +8966,8 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters.InvalidFormatError - The options.coercionType parameter is set to Office.CoercionType.Html and the message body is in plain text. * - * @param data The string that will replace the existing body. The string is limited to 1,000,000 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param data - The string that will replace the existing body. The string is limited to 1,000,000 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. * coercionType: The desired format for the body. The string in the data parameter will be converted to this format. */ @@ -8991,11 +8991,11 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters.InvalidFormatError - The options.coercionType parameter is set to Office.CoercionType.Html and the message body is in plain text. * - * @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 Office.AsyncResult. + * @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 Office.AsyncResult. * Any errors encountered will be provided in the asyncResult.error property. */ - setAsync(data: string, callback: (result: AsyncResult) => void): void; + setAsync(data: string, callback: (result: Office.AsyncResult) => void): void; /** * Replaces the entire body with the specified text. * @@ -9015,7 +9015,7 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters.InvalidFormatError - The options.coercionType parameter is set to Office.CoercionType.Html and the message body is in plain text. * - * @param data The string that will replace the existing body. The string is limited to 1,000,000 characters. + * @param data - The string that will replace the existing body. The string is limited to 1,000,000 characters. */ setAsync(data: string): void; @@ -9042,18 +9042,18 @@ declare namespace Office { * * `setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions): void;` * - * `setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void;` + * `setSelectedDataAsync(data: string, callback: (result: Office.AsyncResult) => void): void;` * * `setSelectedDataAsync(data: string): void;` * - * @param data The string that will replace the existing body. The string is limited to 1,000,000 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param data - The string that will replace the existing body. The string is limited to 1,000,000 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. * 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 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; + setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Replaces the selection in the body with the specified text. * @@ -9073,8 +9073,8 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters.InvalidFormatError - The options.coercionType parameter is set to Office.CoercionType.Html and the message body is in plain text. * - * @param data The string that will replace the existing body. The string is limited to 1,000,000 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param data - The string that will replace the existing body. The string is limited to 1,000,000 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. * coercionType: The desired format for the body. The string in the data parameter will be converted to this format. */ @@ -9098,11 +9098,11 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters.InvalidFormatError - The options.coercionType parameter is set to Office.CoercionType.Html and the message body is in plain text. * - * @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 Office.AsyncResult. + * @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 Office.AsyncResult. * Any errors encountered will be provided in the asyncResult.error property. */ - setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void; + setSelectedDataAsync(data: string, callback: (result: Office.AsyncResult) => void): void; /** * Replaces the selection in the body with the specified text. * @@ -9122,7 +9122,7 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters.InvalidFormatError - The options.coercionType parameter is set to Office.CoercionType.Html and the message body is in plain text. * - * @param data The string that will replace the existing body. The string is limited to 1,000,000 characters. + * @param data - The string that will replace the existing body. The string is limited to 1,000,000 characters. */ setSelectedDataAsync(data: string): void; } @@ -9183,7 +9183,7 @@ declare namespace Office { interface CustomProperties { /** * Returns the value of the specified custom property. - * @param name The name of the custom property to be returned. + * @param name - The name of the custom property to be returned. * @returns The value of the specified custom property. * * [Api set: Mailbox 1.0] @@ -9210,15 +9210,15 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param name The name of the property to be set. - * @param value The value of the property to be set. + * @param name - The name of the property to be set. + * @param value - The value of the property to be set. */ set(name: string, value: string): void; /** * Removes the specified property from the custom property collection. * * To make the removal of the property permanent, you must call the saveAsync method of the CustomProperties object. - * @param name The name of the property to be removed. + * @param name - The name of the property to be removed. * * [Api set: Mailbox 1.0] * @@ -9240,9 +9240,9 @@ declare namespace Office { * If the add-in calls saveAsync while in the disconnected state, saveAsync would return an error. * 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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. - * @param asyncContext Optional. Any state data that is passed to the callback method. + * @param asyncContext - Optional. Any state data that is passed to the callback method. * * [Api set: Mailbox 1.0] * @@ -9251,7 +9251,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - saveAsync(callback?: (result: AsyncResult) => void, asyncContext?: any): void; + saveAsync(callback?: (result: Office.AsyncResult) => void, asyncContext?: any): void; } /** * Provides diagnostic information to an Outlook add-in. @@ -9341,11 +9341,11 @@ declare namespace Office { * This property applies to only an attendee of an appointment, as represented by the optionalAttendees or requiredAttendees property. * This property returns undefined in other scenarios. */ - appointmentResponse: Office.MailboxEnums.ResponseType; + appointmentResponse: MailboxEnums.ResponseType; /** * Gets the email address type of a recipient. */ - recipientType: Office.MailboxEnums.RecipientType; + recipientType: MailboxEnums.RecipientType; } /** * Represents an email account on an Exchange Server. @@ -9438,7 +9438,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose */ - export interface From { + interface From { /** * Gets the from value of a message. * @@ -9455,14 +9455,14 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `getAsync(callback?: (result: AsyncResult) => void): void;` + * `getAsync(callback?: (result: Office.AsyncResult) => void): void;` * - * @param options An object literal that contains one or more of the following properties. + * @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 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) => void): void; + getAsync(options: Office.AsyncContextOptions, callback: (result: Office.AsyncResult) => void): void; /** * Gets the from value of a message. * @@ -9478,10 +9478,10 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @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. + * @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) => void): void; + getAsync(callback?: (result: Office.AsyncResult) => void): void; } /** @@ -9499,7 +9499,7 @@ declare namespace Office { * * @beta */ - export interface InternetHeaders { + interface InternetHeaders { /** * Given an array of internet header names, this method returns a dictionary containing those internet headers and their values. * If the add-in requests an x-header that is not available, that x-header will not be returned in the results. @@ -9513,17 +9513,17 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `getAsync(names: string[], callback: (result: AsyncResult) => void): void;` + * `getAsync(names: string[], callback: (result: Office.AsyncResult) => void): void;` * - * @param names The names of the internet headers to be returned. - * @param options Optional. An object literal that contains one or more of the following properties: + * @param names - The names of the internet headers to be returned. + * @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 Office.AsyncResult 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 Office.AsyncResult object. * * @beta */ - getAsync(names: string[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getAsync(names: string[], options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Given an array of internet header names, this method returns a dictionary containing those internet headers and their values. * If the add-in requests an x-header that is not available, that x-header will not be returned in the results. @@ -9535,13 +9535,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param names The names of the internet headers to be returned. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult object. + * @param names - The names of the internet headers to be returned. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. * * @beta */ - getAsync(names: string[], callback?: (result: AsyncResult) => void): void; + getAsync(names: string[], callback?: (result: Office.AsyncResult) => void): void; /** * Given an array of internet header names, this method removes the specified headers from the internet header collection. * @@ -9554,17 +9554,17 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `removeAsync(names: string[], callback: (result: AsyncResult) => void): void;` + * `removeAsync(names: string[], callback: (result: Office.AsyncResult) => void): void;` * - * @param names The names of the internet headers to be removed. - * @param options Optional. An object literal that contains one or more of the following properties: + * @param names - The names of the internet headers to be removed. + * @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 Office.AsyncResult 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 Office.AsyncResult object. * * @beta */ - removeAsync(names: string[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + removeAsync(names: string[], options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Given an array of internet header names, this method removes the specified headers from the internet header collection. * @@ -9575,13 +9575,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param names The names of the internet headers to be removed. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult object. + * @param names - The names of the internet headers to be removed. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. * * @beta */ - removeAsync(names: string[], callback?: (result: AsyncResult) => void): void; + removeAsync(names: string[], callback?: (result: Office.AsyncResult) => void): void; /** * Sets the specified internet headers to the specified values. * @@ -9597,18 +9597,18 @@ declare namespace Office { * * In addition to this signature, this method also has the following signatures: * - * `setAsync(headers: string, callback: (result: AsyncResult) => void): void;` + * `setAsync(headers: string, callback: (result: Office.AsyncResult) => void): void;` * - * @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 + * @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 * internet headers and values being the values of the internet headers. - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 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. * * @beta */ - setAsync(headers: Object, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + setAsync(headers: Object, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Sets the specified internet headers to the specified values. * @@ -9622,14 +9622,14 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @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 + * @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 * internet headers and values being the values of the internet headers. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type 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. * * @beta */ - setAsync(headers: Object, callback?: (result: AsyncResult) => void): void; + setAsync(headers: Object, callback?: (result: Office.AsyncResult) => void): void; } /** @@ -9643,7 +9643,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose */ - export interface Organizer { + interface Organizer { /** * Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails} in the asyncResult.value property. * @@ -9654,12 +9654,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param options An object literal that contains one or more of the following properties. + * @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 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 asyncResult object. * The `value` property of the result is message's organizer value, as an EmailAddressDetails object. */ - getAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; } /** @@ -9688,7 +9688,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer */ - body: Office.Body; + body: Body; /** * Gets the date and time that an item was created. Read mode only. * @@ -9746,7 +9746,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer */ - itemType: Office.MailboxEnums.ItemType; + itemType: MailboxEnums.ItemType; /** * Gets or sets the {@link Office.Location} of an appointment. The location property returns a Location object that provides methods that are * used to get and set the location of the appointment. @@ -9771,7 +9771,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer */ - notificationMessages: Office.NotificationMessages; + notificationMessages: NotificationMessages; /** * Provides access to the optional attendees of an event. The type of object and level of access depends on the mode of the current item. * The optionalAttendees property returns an {@link Office.Recipients} object that provides methods to get or update the optional attendees @@ -9799,7 +9799,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer */ - organizer: Office.Organizer; + organizer: Organizer; /** * Gets or sets the recurrence pattern of an appointment. * @@ -9913,18 +9913,18 @@ declare namespace Office { * * `addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions): void;` * - * `addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: AsyncResult) => void): void;` + * `addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: Office.AsyncResult) => void): void;` * - * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 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. * 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 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 uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. */ - addFileAttachmentAsync(uri: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addFileAttachmentAsync(uri: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds a file to a message or appointment as an attachment. * @@ -9941,8 +9941,8 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 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. */ addFileAttachmentAsync(uri: string, attachmentName: string): void; /** @@ -9961,9 +9961,9 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 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. * isInline: If true, indicates that the attachment will be shown inline in the message body and should not be displayed in the attachment list. */ @@ -9984,17 +9984,17 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 asyncResult. + * @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 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. */ - addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: AsyncResult) => void): void; + addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: Office.AsyncResult) => void): void; /** * Adds a file to a message or appointment as an attachment. * - * The addFileAttachmentFromBase64Async method uploads the file from the base64 encoding and attaches it to the item in the compose form. This method returns the attachment identifier in the AsyncResult.value object. + * The addFileAttachmentFromBase64Async method uploads the file from the base64 encoding and attaches it to the item in the compose form. This method returns the attachment identifier in the asyncResult.value object. * * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. * @@ -10007,18 +10007,18 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @param base64File The base64 encoded content of an image or file to be added to an email or event. - * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param base64File - The base64 encoded content of an image or file to be added to an email or event. + * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 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. * 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 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 uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. * * @beta */ - addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an event handler for a supported event. * @@ -10035,17 +10035,17 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void;` + * `addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an event handler for a supported event. * @@ -10060,13 +10060,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. * @@ -10095,17 +10095,17 @@ declare namespace Office { * * `addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions): void;` * - * `addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: AsyncResult) => void): void;` + * `addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: Office.AsyncResult) => void): void;` * - * @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 options An object literal that contains one or more of the following properties. + * @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 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 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. */ - addItemAttachmentAsync(itemId: any, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addItemAttachmentAsync(itemId: any, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. * @@ -10128,8 +10128,8 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 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. */ addItemAttachmentAsync(itemId: any, attachmentName: string): void; /** @@ -10154,9 +10154,9 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 options An object literal that contains one or more of the following properties. + * @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 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. */ addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions): void; @@ -10182,13 +10182,13 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 Office.AsyncResult. + * @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 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. */ - addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: AsyncResult) => void): void; + addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: Office.AsyncResult) => void): void; /** * Closes the current item that is being composed * @@ -10220,15 +10220,15 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @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 the call fails, the asyncResult.error property will contain and error code with the reason for * the failure. * * @beta */ - getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Gets initialization data passed when the add-in is activated by an actionable message. * @@ -10244,15 +10244,15 @@ declare namespace Office { * * More information on {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | actionable messages}. * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 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. * * @beta */ - getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * @@ -10273,13 +10273,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer * - * @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string , removing any HTML tags present. + * @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 options An object literal that contains one or more of the following properties. + * @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 AsyncResult. + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. */ - getSelectedDataAsync(coercionType: Office.CoercionType, options: Office.AsyncContextOptions, callback: (result: AsyncResult) => void): void; + getSelectedDataAsync(coercionType: Office.CoercionType, options: Office.AsyncContextOptions, callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * @@ -10300,12 +10300,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer * - * @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string , removing any HTML tags present. + * @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 + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - getSelectedDataAsync(coercionType: Office.CoercionType, callback: (result: AsyncResult) => void): void; + getSelectedDataAsync(coercionType: Office.CoercionType, callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously loads custom properties for this add-in on the selected item. * @@ -10325,12 +10325,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. - * @param userContext Optional. Developers can provide any object they wish to access in the callback function. + * @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. */ - loadCustomPropertiesAsync(callback: (result: AsyncResult) => void, userContext?: any): void; + loadCustomPropertiesAsync(callback: (result: Office.AsyncResult) => void, userContext?: any): void; /** * Removes an attachment from a message or appointment. * @@ -10356,15 +10356,15 @@ declare namespace Office { * * `removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions): void;` * - * `removeAttachmentAsync(attachmentId: string, callback: (result: AsyncResult) => void): void;` + * `removeAttachmentAsync(attachmentId: string, callback: (result: Office.AsyncResult) => void): void;` * - * @param attachmentId The identifier of the attachment to remove. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param attachmentId - The identifier of the attachment to remove. + * @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 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(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + removeAttachmentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Removes an attachment from a message or appointment. * @@ -10384,7 +10384,7 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment to remove. + * @param attachmentId - The identifier of the attachment to remove. */ removeAttachmentAsync(attachmentId: string): void; /** @@ -10406,8 +10406,8 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment to remove. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param attachmentId - The identifier of the attachment to remove. + * @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. */ removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions): void; @@ -10431,12 +10431,12 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment to remove. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * @param attachmentId - The identifier of the attachment to remove. + * @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(attachmentId: string, callback: (result: AsyncResult) => void): void; + removeAttachmentAsync(attachmentId: string, callback: (result: Office.AsyncResult) => void): void; /** * Removes the event handlers for a supported event type. * @@ -10453,15 +10453,15 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `removeHandlerAsync(eventType:EventType, callback?: (result: AsyncResult) => void): void;` + * `removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should revoke the handler. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param eventType - The event that should revoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - removeHandlerAsync(eventType:EventType, options?: any, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Removes the event handlers for a supported event type. * @@ -10476,11 +10476,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer * - * @param eventType The event that should revoke the handler. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult object. + * @param eventType - The event that should revoke the handler. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. */ - removeHandlerAsync(eventType:EventType, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. * @@ -10518,13 +10518,13 @@ declare namespace Office { * * `saveAsync(options: Office.AsyncContextOptions): void;` * - * `saveAsync(callback: (result: AsyncResult) => void): void;` + * `saveAsync(callback: (result: Office.AsyncResult) => void): void;` * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 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; + saveAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. * @@ -10589,7 +10589,7 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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. */ saveAsync(options: Office.AsyncContextOptions): void; @@ -10623,9 +10623,9 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type 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; + saveAsync(callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * @@ -10649,11 +10649,11 @@ declare namespace Office { * * `setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions): void;` * - * `setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void;` + * `setSelectedDataAsync(data: string, callback: (result: Office.AsyncResult) => void): void;` * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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: If text, the current style is applied in Outlook Web App and Outlook. * If the field is an HTML editor, only the text data is inserted, even if the data is HTML. @@ -10662,10 +10662,10 @@ declare namespace Office { * If the field is a text field, an InvalidDataFormat error is returned. * 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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: AsyncResult) => void): void; + setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * @@ -10683,7 +10683,7 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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. */ setSelectedDataAsync(data: string): void; @@ -10704,9 +10704,9 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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: If text, the current style is applied in Outlook Web App and Outlook. * If the field is an HTML editor, only the text data is inserted, even if the data is HTML. @@ -10733,12 +10733,12 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void; + setSelectedDataAsync(data: string, callback: (result: Office.AsyncResult) => void): void; } /** @@ -10763,7 +10763,7 @@ declare namespace Office { * {@link https://support.office.com/article/Blocked-attachments-in-Outlook-434752E1-02D3-4E90-9124-8B81E49A8519 | Blocked attachments in Outlook}. * */ - attachments: Office.AttachmentDetails[]; + attachments: AttachmentDetails[]; /** * Gets an object that provides methods for manipulating the body of an item. * @@ -10775,7 +10775,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee */ - body: Office.Body; + body: Body; /** * Gets the date and time that an item was created. Read mode only. * @@ -10861,7 +10861,7 @@ declare namespace Office { * * The itemId property is not available in compose mode. * If an item identifier is required, the saveAsync method can be used to save the item to the store, which will return the item identifier - * in the AsyncResult.value parameter in the callback function. + * in the asyncResult.value parameter in the callback function. * * Note: The identifier returned by the itemId property is the same as the Exchange Web Services item identifier. * The itemId property is not identical to the Outlook Entry ID or the ID used by the Outlook REST API. @@ -10890,7 +10890,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee */ - itemType: Office.MailboxEnums.ItemType; + itemType: MailboxEnums.ItemType; /** * Gets the location of an appointment. * @@ -10931,7 +10931,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee */ - notificationMessages: Office.NotificationMessages; + notificationMessages: NotificationMessages; /** * Provides access to the optional attendees of an event. The type of object and level of access depends on the mode of the current item. * @@ -11065,17 +11065,17 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: AsyncResult) => void): void;` + * `addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType: Office.EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an event handler for a supported event. @@ -11091,13 +11091,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void; /** * Displays a reply form that includes the sender and all recipients of the selected message or the organizer and all attendees of the * selected appointment. @@ -11119,7 +11119,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee * - * @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 + * @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 * OR * An {@link Office.ReplyFormData} object that contains body or attachment data and a callback function */ @@ -11145,7 +11145,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee * - * @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. + * @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. * OR * An {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. */ @@ -11166,19 +11166,19 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `getInitializationContextAsync(callback?: (result: AsyncResult) => void): void;` + * `getInitializationContextAsync(callback?: (result: Office.AsyncResult) => void): void;` * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 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. * * @beta */ - getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Gets initialization data passed when the add-in is {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}. * @@ -11192,15 +11192,15 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee * - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult 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 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. * * @beta */ - getInitializationContextAsync(callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(callback?: (result: Office.AsyncResult) => void): void; /** * Gets the entities found in the selected item's body. * @@ -11222,7 +11222,7 @@ declare namespace Office { * * [Api set: Mailbox 1.0] * - * @param entityType One of the EntityType enumeration values. + * @param entityType - One of the EntityType enumeration values. * * @returns * If the value passed in entityType is not a valid member of the EntityType enumeration, the method returns null. @@ -11279,7 +11279,7 @@ declare namespace Office { * * */ - getEntitiesByType(entityType: Office.MailboxEnums.EntityType): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; + getEntitiesByType(entityType: MailboxEnums.EntityType): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; /** * Returns well-known entities in the selected item that pass the named filter defined in the manifest XML file. * @@ -11296,7 +11296,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee * - * @param name The name of the ItemHasKnownEntity rule element that defines the filter to match. + * @param name - The name of the ItemHasKnownEntity rule element that defines the filter to match. * @returns If there is no ItemHasKnownEntity element in the manifest with a FilterName element value that matches the name parameter, * the method returns null. * If the name parameter does match an ItemHasKnownEntity element in the manifest, but there are no entities in the current item that match, @@ -11355,7 +11355,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee * - * @param name The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. + * @param name - The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. */ getRegExMatchesByName(name: string): string[]; /** @@ -11371,7 +11371,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee * - * @param name The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. + * @param name - The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. */ getSelectedEntities(): Entities; /** @@ -11423,12 +11423,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. - * @param userContext Optional. Developers can provide any object they wish to access in the callback function. + * @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. */ - loadCustomPropertiesAsync(callback: (result: AsyncResult) => void, userContext?: any): void; + loadCustomPropertiesAsync(callback: (result: Office.AsyncResult) => void, userContext?: any): void; /** * Removes the event handlers for a supported event type. @@ -11446,15 +11446,15 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `removeHandlerAsync(eventType:EventType, callback?: (result: AsyncResult) => void): void;` + * `removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should revoke the handler. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param eventType - The event that should revoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - removeHandlerAsync(eventType:EventType, options?: any, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Removes the event handlers for a supported event type. * @@ -11469,11 +11469,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee * - * @param eventType The event that should revoke the handler. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult object. + * @param eventType - The event that should revoke the handler. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. */ - removeHandlerAsync(eventType:EventType, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void; } /** @@ -11499,7 +11499,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - body: Office.Body; + body: Body; /** * Gets the date and time that an item was created. Read mode only. * @@ -11540,7 +11540,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - itemType: Office.MailboxEnums.ItemType; + itemType: MailboxEnums.ItemType; /** * Gets the notification messages for an item. * @@ -11552,7 +11552,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - notificationMessages: Office.NotificationMessages; + notificationMessages: NotificationMessages; /** * Gets or sets the recurrence pattern of an appointment. Gets the recurrence pattern of a meeting request. @@ -11575,7 +11575,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - recurrence: Office.Recurrence; + recurrence: Recurrence; /** * Gets the id of the series that an instance belongs to. @@ -11617,17 +11617,17 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: AsyncResult) => void): void;` + * `addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType: Office.EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an event handler for a supported event. @@ -11643,16 +11643,16 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void; /** - * Gets an attachment from a message or appointment and returns it as an `Office.AttachmentContent` object. + * Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object. * * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or @@ -11670,16 +11670,16 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment you want to get. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param attachmentId - The identifier of the attachment you want to get. + * @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 Office.AsyncResult object. If the call fails, the asyncResult.error property will contain and error code + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. If the call fails, the asyncResult.error property will contain and error code * with the reason for the failure. * * @beta */ - getAttachmentContentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getAttachmentContentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Gets initialization data passed when the add-in is {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}. @@ -11697,19 +11697,19 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `getInitializationContextAsync(callback?: (result: AsyncResult) => void): void;` + * `getInitializationContextAsync(callback?: (result: Office.AsyncResult) => void): void;` * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 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. * * @beta */ - getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Gets the properties of an appointment or message in a shared folder, calendar, or mailbox. @@ -11723,17 +11723,17 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `getAsync(callback: (result: AsyncResult) => void): void;` + * `getAsync(callback: (result: Office.AsyncResult) => void): void;` * - * @param options An object literal that contains one or more of the following properties. + * @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 + * @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 properties of the shared item. * * @beta */ - getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (result: AsyncResult) => void): void; + getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (result: Office.AsyncResult) => void): void; /** * Gets the properties of an appointment or message in a shared folder, calendar, or mailbox. @@ -11745,13 +11745,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of + * @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 properties of the shared item. * * @beta */ - getSharedPropertiesAsync(callback: (result: AsyncResult) => void): void; + getSharedPropertiesAsync(callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously loads custom properties for this add-in on the selected item. @@ -11772,12 +11772,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. - * @param userContext Optional. Developers can provide any object they wish to access in the callback function. + * @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. */ - loadCustomPropertiesAsync(callback: (result: AsyncResult) => void, userContext?: any): void; + loadCustomPropertiesAsync(callback: (result: Office.AsyncResult) => void, userContext?: any): void; /** * Removes the event handlers for a supported event type. @@ -11795,15 +11795,15 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `removeHandlerAsync(eventType: Office.EventType, callback?: (result: AsyncResult) => void): void;` + * `removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should revoke the handler. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param eventType - The event that should revoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - removeHandlerAsync(eventType: Office.EventType, options?: any, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Removes the event handlers for a supported event type. @@ -11819,11 +11819,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param eventType The event that should revoke the handler. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult object. + * @param eventType - The event that should revoke the handler. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. */ - removeHandlerAsync(eventType: Office.EventType, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void; } /** * The compose mode of {@link Office.Item | Office.context.mailbox.item}. @@ -11870,20 +11870,20 @@ declare namespace Office { * * `addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions): void;` * - * `addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: AsyncResult) => void): void;` + * `addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: Office.AsyncResult) => void): void;` * - * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 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. * 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 asyncResult. On success, the attachment identifier will be provided in the asyncResult.value property. + * @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 uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of * the error. */ - addFileAttachmentAsync(uri: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addFileAttachmentAsync(uri: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds a file to a message or appointment as an attachment. * @@ -11900,8 +11900,8 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 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. */ addFileAttachmentAsync(uri: string, attachmentName: string): void; /** @@ -11920,9 +11920,9 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 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. * isInline: If true, indicates that the attachment will be shown inline in the message body, and should not be displayed in the * attachment list. @@ -11944,19 +11944,19 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 + * @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 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. */ - addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: AsyncResult) => void): void; + addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: Office.AsyncResult) => void): void; /** * Adds a file to a message or appointment as an attachment. * - * The addFileAttachmentFromBase64Async method uploads the file from the base64 encoding and attaches it to the item in the compose form. This method returns the attachment identifier in the AsyncResult.value object. + * The addFileAttachmentFromBase64Async method uploads the file from the base64 encoding and attaches it to the item in the compose form. This method returns the attachment identifier in the asyncResult.value object. * * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. * @@ -11969,18 +11969,18 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @param base64File The base64 encoded content of an image or file to be added to an email or event. - * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param base64File - The base64 encoded content of an image or file to be added to an email or event. + * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 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. * 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 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 uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. * * @beta */ - addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. @@ -12010,18 +12010,18 @@ declare namespace Office { * * `addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions): void;` * - * `addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: AsyncResult) => void): void;` + * `addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: Office.AsyncResult) => void): void;` * - * @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 options An object literal that contains one or more of the following properties. + * @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 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 + * @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. */ - addItemAttachmentAsync(itemId: any, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addItemAttachmentAsync(itemId: any, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. * @@ -12044,8 +12044,8 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 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. */ addItemAttachmentAsync(itemId: any, attachmentName: string): void; /** @@ -12070,9 +12070,9 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 options An object literal that contains one or more of the following properties. + * @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 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. */ addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions): void; @@ -12098,14 +12098,14 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 + * @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 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. */ - addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: AsyncResult) => void): void; + addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: Office.AsyncResult) => void): void; /** * Closes the current item that is being composed @@ -12138,15 +12138,15 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @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 the call fails, the asyncResult.error property will contain and error code with the reason for * the failure. * * @beta */ - getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Gets initialization data passed when the add-in is activated by an actionable message. * @@ -12162,9 +12162,9 @@ declare namespace Office { * * More information on {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | actionable messages}. * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @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 @@ -12172,7 +12172,7 @@ declare namespace Office { * * @beta */ - getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * @@ -12193,12 +12193,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string , removing any HTML tags present. + * @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 + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - getSelectedDataAsync(coercionType: Office.CoercionType, callback: (result: AsyncResult) => void): void; + getSelectedDataAsync(coercionType: Office.CoercionType, callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * @@ -12219,14 +12219,14 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string, removing any HTML tags present. + * @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 options An object literal that contains one or more of the following properties. + * @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 + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - getSelectedDataAsync(coercionType: Office.CoercionType, options: Office.AsyncContextOptions, callback: (result: AsyncResult) => void): void; + getSelectedDataAsync(coercionType: Office.CoercionType, options: Office.AsyncContextOptions, callback: (result: Office.AsyncResult) => void): void; /** * Removes an attachment from a message or appointment. * @@ -12252,16 +12252,16 @@ declare namespace Office { * * `removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions): void;` * - * `removeAttachmentAsync(attachmentId: string, callback: (result: AsyncResult) => void): void;` + * `removeAttachmentAsync(attachmentId: string, callback: (result: Office.AsyncResult) => void): void;` * - * @param attachmentId The identifier of the attachment to remove. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param attachmentId - The identifier of the attachment to remove. + * @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 + * @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(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + removeAttachmentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Removes an attachment from a message or appointment. * @@ -12281,7 +12281,7 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment to remove. + * @param attachmentId - The identifier of the attachment to remove. */ removeAttachmentAsync(attachmentId: string): void; /** @@ -12303,8 +12303,8 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment to remove. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param attachmentId - The identifier of the attachment to remove. + * @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. */ removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions): void; @@ -12327,12 +12327,12 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment 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}. + * @param attachmentId - The identifier of the attachment to remove. + * @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(attachmentId: string, callback: (result: AsyncResult) => void): void; + removeAttachmentAsync(attachmentId: string, callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. @@ -12371,15 +12371,15 @@ declare namespace Office { * * `saveAsync(options: Office.AsyncContextOptions): void;` * - * `saveAsync(callback: (result: AsyncResult) => void): void;` + * `saveAsync(callback: (result: Office.AsyncResult) => void): void;` * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @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. */ - saveAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + saveAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. * @@ -12444,7 +12444,7 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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. */ saveAsync(options: Office.AsyncContextOptions): void; @@ -12479,11 +12479,11 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * @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. */ - saveAsync(callback: (result: AsyncResult) => void): void; + saveAsync(callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * @@ -12507,11 +12507,11 @@ declare namespace Office { * * `setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions): void;` * - * `setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void;` + * `setSelectedDataAsync(data: string, callback: (result: Office.AsyncResult) => void): void;` * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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: If text, the current style is applied in Outlook Web App and Outlook. * If the field is an HTML editor, only the text data is inserted, even if the data is HTML. @@ -12520,10 +12520,10 @@ declare namespace Office { * If the field is a text field, an InvalidDataFormat error is returned. * 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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: AsyncResult) => void): void; + setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * @@ -12541,7 +12541,7 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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. */ setSelectedDataAsync(data: string): void; @@ -12562,9 +12562,9 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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: If text, the current style is applied in Outlook Web App and Outlook. * If the field is an HTML editor, only the text data is inserted, even if the data is HTML. @@ -12592,12 +12592,12 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void; + setSelectedDataAsync(data: string, callback: (result: Office.AsyncResult) => void): void; } /** * The read mode of {@link Office.Item | Office.context.mailbox.item}. @@ -12621,7 +12621,7 @@ declare namespace Office { * {@link https://support.office.com/article/Blocked-attachments-in-Outlook-434752E1-02D3-4E90-9124-8B81E49A8519 | Blocked attachments in Outlook}. * */ - attachments: Office.AttachmentDetails[]; + attachments: AttachmentDetails[]; /** * Gets the Exchange Web Services item class of the selected item. * @@ -12664,7 +12664,7 @@ declare namespace Office { * * The itemId property is not available in compose mode. * If an item identifier is required, the saveAsync method can be used to save the item to the store, which will return the item identifier - * in the AsyncResult.value parameter in the callback function. + * in the asyncResult.value parameter in the callback function. * * Note: The identifier returned by the itemId property is the same as the Exchange Web Services item identifier. * The itemId property is not identical to the Outlook Entry ID or the ID used by the Outlook REST API. @@ -12732,7 +12732,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Read * - * @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 + * @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 * OR * An {@link Office.ReplyFormData} object that contains body or attachment data and a callback function */ @@ -12758,7 +12758,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Read * - * @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. + * @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. * OR * An {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. */ @@ -12779,19 +12779,19 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `getInitializationContextAsync(callback?: (result: AsyncResult) => void): void;` + * `getInitializationContextAsync(callback?: (result: Office.AsyncResult) => void): void;` * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 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. * * @beta */ - getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Gets initialization data passed when the add-in is {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}. * @@ -12806,15 +12806,15 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Read * - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult 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 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. * * @beta */ - getInitializationContextAsync(callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(callback?: (result: Office.AsyncResult) => void): void; /** * Gets the entities found in the selected item's body. * @@ -12836,7 +12836,7 @@ declare namespace Office { * * [Api set: Mailbox 1.0] * - * @param entityType One of the EntityType enumeration values. + * @param entityType - One of the EntityType enumeration values. * * @returns * If the value passed in entityType is not a valid member of the EntityType enumeration, the method returns null. @@ -12894,7 +12894,7 @@ declare namespace Office { * * */ - getEntitiesByType(entityType: Office.MailboxEnums.EntityType): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; + getEntitiesByType(entityType: MailboxEnums.EntityType): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; /** * Returns well-known entities in the selected item that pass the named filter defined in the manifest XML file. * @@ -12911,7 +12911,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Read * - * @param name The name of the ItemHasKnownEntity rule element that defines the filter to match. + * @param name - The name of the ItemHasKnownEntity rule element that defines the filter to match. * @returns If there is no ItemHasKnownEntity element in the manifest with a FilterName element value that matches the name parameter, * the method returns null. * If the name parameter does match an ItemHasKnownEntity element in the manifest, but there are no entities in the current item that match, @@ -12970,7 +12970,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Read * - * @param name The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. + * @param name - The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. */ getRegExMatchesByName(name: string): string[]; /** @@ -12986,7 +12986,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Read * - * @param name The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. + * @param name - The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. */ getSelectedEntities(): Entities; /** @@ -13076,7 +13076,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose */ - body: Office.Body; + body: Body; /** * Provides access to the Cc (carbon copy) recipients of a message. The type of object and level of access depends on the mode of the * current item. @@ -13154,7 +13154,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose */ - from: Office.From; + from: From; /** * Sets the internet headers of a message. * @@ -13170,7 +13170,7 @@ declare namespace Office { * * @beta */ - internetHeaders: Office.InternetHeaders; + internetHeaders: InternetHeaders; /** * Gets the type of item that an instance represents. * @@ -13185,7 +13185,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose */ - itemType: Office.MailboxEnums.ItemType; + itemType: MailboxEnums.ItemType; /** * Gets the notification messages for an item. * @@ -13197,7 +13197,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose */ - notificationMessages: Office.NotificationMessages; + notificationMessages: NotificationMessages; /** * Gets or sets the recurrence pattern of an appointment. Gets the recurrence pattern of a meeting request. * Read and compose modes for appointment items. Read mode for meeting request items. @@ -13297,20 +13297,20 @@ declare namespace Office { * * `addFileAttachmentAsync(uri: string, attachmentName: string, options: AsyncContextOptions): void;` * - * `addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: AsyncResult) => void): void;` + * `addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: Office.AsyncResult) => void): void;` * - * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 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. * 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 + * @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 uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of * the error. */ - addFileAttachmentAsync(uri: string, attachmentName: string, options?: AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addFileAttachmentAsync(uri: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds a file to a message or appointment as an attachment. * @@ -13327,8 +13327,8 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 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. */ addFileAttachmentAsync(uri: string, attachmentName: string): void; /** @@ -13347,13 +13347,13 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 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. * isInline: If true, indicates that the attachment will be shown inline in the message body and should not be displayed in the attachment list. */ - addFileAttachmentAsync(uri: string, attachmentName: string, options: AsyncContextOptions): void; + addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions): void; /** * Adds a file to a message or appointment as an attachment. * @@ -13370,18 +13370,18 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 + * @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 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. */ - addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: AsyncResult) => void): void; + addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: Office.AsyncResult) => void): void; /** * Adds a file to a message or appointment as an attachment. * - * The addFileAttachmentFromBase64Async method uploads the file from the base64 encoding and attaches it to the item in the compose form. This method returns the attachment identifier in the AsyncResult.value object. + * The addFileAttachmentFromBase64Async method uploads the file from the base64 encoding and attaches it to the item in the compose form. This method returns the attachment identifier in the asyncResult.value object. * * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. * @@ -13394,18 +13394,18 @@ declare namespace Office { * * ErrorsAttachmentSizeExceeded - The attachment is larger than allowed.FileTypeNotSupported - The attachment has an extension that is not allowed.NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @param base64File The base64 encoded content of an image or file to be added to an email or event. - * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param base64File - The base64 encoded content of an image or file to be added to an email or event. + * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 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. * 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 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 uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. * * @beta */ - addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an event handler for a supported event. * @@ -13422,17 +13422,17 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void;` + * `addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an event handler for a supported event. * @@ -13447,13 +13447,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. * @@ -13482,18 +13482,18 @@ declare namespace Office { * * `addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions): void;` * - * `addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: AsyncResult) => void): void;` + * `addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: Office.AsyncResult) => void): void;` * - * @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 options An object literal that contains one or more of the following properties. + * @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 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 AsyncResult. On success, the attachment identifier will be provided in the asyncResult.value property. + * @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. */ - addItemAttachmentAsync(itemId: any, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addItemAttachmentAsync(itemId: any, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. * @@ -13516,8 +13516,8 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 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. */ addItemAttachmentAsync(itemId: any, attachmentName: string): void; /** @@ -13542,9 +13542,9 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 options An object literal that contains one or more of the following properties. + * @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 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. */ addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions): void; @@ -13570,14 +13570,14 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * @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 + * @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 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. */ - addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: AsyncResult) => void): void; + addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: Office.AsyncResult) => void): void; /** * Closes the current item that is being composed * @@ -13609,15 +13609,15 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @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 the call fails, the asyncResult.error property will contain and error code with the reason for * the failure. * * @beta */ - getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Gets initialization data passed when the add-in is activated by an actionable message. * @@ -13634,9 +13634,9 @@ declare namespace Office { * * More information on {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | actionable messages}. * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @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 @@ -13644,7 +13644,7 @@ declare namespace Office { * * @beta */ - getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * @@ -13665,12 +13665,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose * - * @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string, removing any HTML tags present. + * @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 + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - getSelectedDataAsync(coercionType: Office.CoercionType, callback: (result: AsyncResult) => void): void; + getSelectedDataAsync(coercionType: Office.CoercionType, callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * @@ -13691,14 +13691,14 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose * - * @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string, removing any HTML tags present. + * @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 options An object literal that contains one or more of the following properties. + * @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 + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - getSelectedDataAsync(coercionType: Office.CoercionType, options: Office.AsyncContextOptions, callback: (result: AsyncResult) => void): void; + getSelectedDataAsync(coercionType: Office.CoercionType, options: Office.AsyncContextOptions, callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously loads custom properties for this add-in on the selected item. * @@ -13718,12 +13718,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. - * @param userContext Optional. Developers can provide any object they wish to access in the callback function. + * @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. */ - loadCustomPropertiesAsync(callback: (result: AsyncResult) => void, userContext?: any): void; + loadCustomPropertiesAsync(callback: (result: Office.AsyncResult) => void, userContext?: any): void; /** * Removes an attachment from a message or appointment. * @@ -13749,16 +13749,16 @@ declare namespace Office { * * `removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions): void;` * - * `removeAttachmentAsync(attachmentId: string, callback: (result: AsyncResult) => void): void;` + * `removeAttachmentAsync(attachmentId: string, callback: (result: Office.AsyncResult) => void): void;` * - * @param attachmentId The identifier of the attachment to remove. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param attachmentId - The identifier of the attachment to remove. + * @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 + * @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(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + removeAttachmentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Removes an attachment from a message or appointment. * @@ -13778,7 +13778,7 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment to remove. + * @param attachmentId - The identifier of the attachment to remove. */ removeAttachmentAsync(attachmentId: string): void; /** @@ -13800,8 +13800,8 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment to remove. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param attachmentId - The identifier of the attachment to remove. + * @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. */ removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions): void; @@ -13824,12 +13824,12 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param attachmentId The identifier of the attachment to remove. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * @param attachmentId - The identifier of the attachment to remove. + * @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(attachmentId: string, callback: (result: AsyncResult) => void): void; + removeAttachmentAsync(attachmentId: string, callback: (result: Office.AsyncResult) => void): void; /** * Removes the event handlers for a supported event type. * @@ -13846,15 +13846,15 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `removeHandlerAsync(eventType:EventType, callback?: (result: AsyncResult) => void): void;` + * `removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should revoke the handler. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param eventType - The event that should revoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - removeHandlerAsync(eventType:EventType, options?: any, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Removes the event handlers for a supported event type. * @@ -13869,11 +13869,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose * - * @param eventType The event that should revoke the handler. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult object. + * @param eventType - The event that should revoke the handler. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. */ - removeHandlerAsync(eventType:EventType, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. * @@ -13911,14 +13911,14 @@ declare namespace Office { * * `saveAsync(options: Office.AsyncContextOptions): void;` * - * `saveAsync(callback: (result: AsyncResult) => void): void;` + * `saveAsync(callback: (result: Office.AsyncResult) => void): void;` * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @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; + saveAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. * @@ -13982,7 +13982,7 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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. */ saveAsync(options: Office.AsyncContextOptions): void; @@ -14017,10 +14017,10 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * @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; + saveAsync(callback: (result: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * @@ -14044,11 +14044,11 @@ declare namespace Office { * * `setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions): void;` * - * `setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void;` + * `setSelectedDataAsync(data: string, callback: (result: Office.AsyncResult) => void): void;` * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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: If text, the current style is applied in Outlook Web App and Outlook. * If the field is an HTML editor, only the text data is inserted, even if the data is HTML. @@ -14056,10 +14056,10 @@ declare namespace Office { * applied in Outlook. If the field is a text field, an InvalidDataFormat error is returned. * 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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: AsyncResult) => void): void; + setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * @@ -14077,7 +14077,7 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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. */ setSelectedDataAsync(data: string): void; @@ -14098,9 +14098,9 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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: If text, the current style is applied in Outlook Web App and Outlook. * If the field is an HTML editor, only the text data is inserted, even if the data is HTML. @@ -14127,12 +14127,12 @@ declare namespace Office { * * ErrorsInvalidAttachmentId - The attachment identifier does not exist. * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. + * @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 - * typeOffice.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. */ - setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void; + setSelectedDataAsync(data: string, callback: (result: Office.AsyncResult) => void): void; } /** * The message read mode of {@link Office.Item | Office.context.mailbox.item}. @@ -14157,7 +14157,7 @@ declare namespace Office { * {@link https://support.office.com/article/Blocked-attachments-in-Outlook-434752E1-02D3-4E90-9124-8B81E49A8519 | Blocked attachments in Outlook}. * */ - attachments: Office.AttachmentDetails[]; + attachments: AttachmentDetails[]; /** * Gets an object that provides methods for manipulating the body of an item. * @@ -14169,7 +14169,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read */ - body: Office.Body; + body: Body; /** * Provides access to the Cc (carbon copy) recipients of a message. The type of object and level of access depends on the mode of the * current item. @@ -14265,7 +14265,7 @@ declare namespace Office { * * @beta */ - internetHeaders: Office.InternetHeaders; + internetHeaders: InternetHeaders; /** * Gets the Internet message identifier for an email message. * @@ -14320,7 +14320,7 @@ declare namespace Office { * * The itemId property is not available in compose mode. * If an item identifier is required, the saveAsync method can be used to save the item to the store, which will return the item identifier - * in the AsyncResult.value parameter in the callback function. + * in the asyncResult.value parameter in the callback function. * * Note: The identifier returned by the itemId property is the same as the Exchange Web Services item identifier. * The itemId property is not identical to the Outlook Entry ID or the ID used by the Outlook REST API. @@ -14350,7 +14350,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read */ - itemType: Office.MailboxEnums.ItemType; + itemType: MailboxEnums.ItemType; /** * Gets the subject of an item, with all prefixes removed (including RE: and FWD:). * @@ -14378,7 +14378,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - notificationMessages: Office.NotificationMessages; + notificationMessages: NotificationMessages; /** * Gets the recurrence pattern of an appointment. Gets the recurrence pattern of a meeting request. * Read and compose modes for appointment items. Read mode for meeting request items. @@ -14490,17 +14490,17 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void;` + * `addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Adds an event handler for a supported event. @@ -14516,13 +14516,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: Office.AsyncResult) => void): void; /** * Displays a reply form that includes the sender and all recipients of the selected message or the organizer and all attendees of the * selected appointment. @@ -14544,7 +14544,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read * - * @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 + * @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 * OR * An {@link Office.ReplyFormData} object that contains body or attachment data and a callback function */ @@ -14570,7 +14570,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read * - * @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. + * @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. * OR * An {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. */ @@ -14592,19 +14592,19 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `getInitializationContextAsync(callback?: (result: AsyncResult) => void): void;` + * `getInitializationContextAsync(callback?: (result: Office.AsyncResult) => void): void;` * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 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. * * @beta */ - getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Gets initialization data passed when the add-in is * {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}. @@ -14620,15 +14620,15 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read * - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult 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 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. * * @beta */ - getInitializationContextAsync(callback?: (result: AsyncResult) => void): void; + getInitializationContextAsync(callback?: (result: Office.AsyncResult) => void): void; /** * Gets the entities found in the selected item's body. * @@ -14650,7 +14650,7 @@ declare namespace Office { * * [Api set: Mailbox 1.0] * - * @param entityType One of the EntityType enumeration values. + * @param entityType - One of the EntityType enumeration values. * * @returns * If the value passed in entityType is not a valid member of the EntityType enumeration, the method returns null. @@ -14709,7 +14709,7 @@ declare namespace Office { * * */ - getEntitiesByType(entityType: Office.MailboxEnums.EntityType): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; + getEntitiesByType(entityType: MailboxEnums.EntityType): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; /** * Returns well-known entities in the selected item that pass the named filter defined in the manifest XML file. * @@ -14726,7 +14726,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read * - * @param name The name of the ItemHasKnownEntity rule element that defines the filter to match. + * @param name - The name of the ItemHasKnownEntity rule element that defines the filter to match. * @returns If there is no ItemHasKnownEntity element in the manifest with a FilterName element value that matches the name parameter, * the method returns null. * If the name parameter does match an ItemHasKnownEntity element in the manifest, but there are no entities in the current item that match, @@ -14785,7 +14785,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read * - * @param name The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. + * @param name - The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. */ getRegExMatchesByName(name: string): string[]; /** @@ -14801,7 +14801,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read * - * @param name The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. + * @param name - The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. */ getSelectedEntities(): Entities; /** @@ -14853,12 +14853,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. - * @param userContext Optional. Developers can provide any object they wish to access in the callback function. + * @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. */ - loadCustomPropertiesAsync(callback: (result: AsyncResult) => void, userContext?: any): void; + loadCustomPropertiesAsync(callback: (result: Office.AsyncResult) => void, userContext?: any): void; /** * Removes the event handlers for a supported event type. * @@ -14875,15 +14875,15 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `removeHandlerAsync(eventType:EventType, callback?: (result: AsyncResult) => void): void;` + * `removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void;` * - * @param eventType The event that should revoke the handler. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param eventType - The event that should revoke the handler. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - removeHandlerAsync(eventType:EventType, options?: any, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, options?: any, callback?: (result: Office.AsyncResult) => void): void; /** * Removes the event handlers for a supported event type. * @@ -14898,11 +14898,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read * - * @param eventType The event that should revoke the handler. - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult object. + * @param eventType - The event that should revoke the handler. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. */ - removeHandlerAsync(eventType:EventType, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, callback?: (result: Office.AsyncResult) => void): void; } /** @@ -14967,9 +14967,9 @@ declare namespace Office { * The getAsync method starts an asynchronous call to the Exchange server to get the location of an appointment. * The location of the appointment is provided as a string in the asyncResult.value property. * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. * * [Api set: Mailbox 1.1] @@ -14981,17 +14981,17 @@ declare namespace Office { * * In addition to this signature, the method also has the following signature: * - * `getAsync(callback: (result: AsyncResult) => void): void;` + * `getAsync(callback: (result: Office.AsyncResult) => void): void;` * */ - getAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Gets the location of an appointment. * * The getAsync method starts an asynchronous call to the Exchange server to get the location of an appointment. * 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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. * * [Api set: Mailbox 1.1] @@ -15001,17 +15001,17 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose */ - getAsync(callback: (result: AsyncResult) => void): void; + getAsync(callback: (result: Office.AsyncResult) => void): void; /** * Sets the location of an appointment. * * The setAsync method starts an asynchronous call to the Exchange server to set the location of an appointment. * Setting the location of an appointment overwrites the current location. * - * @param location The location of the appointment. The string is limited to 255 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param location - The location of the appointment. The string is limited to 255 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 + * @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 setting the location fails, the asyncResult.error property will contain an error code. * * [Api set: Mailbox 1.1] @@ -15029,16 +15029,16 @@ declare namespace Office { * * `setAsync(location: string, options: Office.AsyncContextOptions): void;` * - * `setAsync(location: string, callback: (result: AsyncResult) => void): void;` + * `setAsync(location: string, callback: (result: Office.AsyncResult) => void): void;` */ - setAsync(location: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + setAsync(location: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Sets the location of an appointment. * * The setAsync method starts an asynchronous call to the Exchange server to set the location of an appointment. * Setting the location of an appointment overwrites the current location. * - * @param location The location of the appointment. The string is limited to 255 characters. + * @param location - The location of the appointment. The string is limited to 255 characters. * * [Api set: Mailbox 1.1] * @@ -15056,8 +15056,8 @@ declare namespace Office { * The setAsync method starts an asynchronous call to the Exchange server to set the location of an appointment. * Setting the location of an appointment overwrites the current location. * - * @param location The location of the appointment. The string is limited to 255 characters. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param location - The location of the appointment. The string is limited to 255 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. * * [Api set: Mailbox 1.1] @@ -15076,8 +15076,8 @@ declare namespace Office { * The setAsync method starts an asynchronous call to the Exchange server to set the location of an appointment. * Setting the location of an appointment overwrites the current location. * - * @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 + * @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 Office.AsyncResult. If setting the location fails, the asyncResult.error property will contain an error code. * * [Api set: Mailbox 1.1] @@ -15089,7 +15089,7 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The location parameter is longer than 255 characters. */ - setAsync(location: string, callback: (result: AsyncResult) => void): void; + setAsync(location: string, callback: (result: Office.AsyncResult) => void): void; } /** * Provides access to the Outlook Add-in object model for Microsoft Outlook and Microsoft Outlook on the web. @@ -15137,7 +15137,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - diagnostics: Office.Diagnostics; + diagnostics: Diagnostics; /** * Gets the URL of the Exchange Web Services (EWS) endpoint for this email account. Read mode only. * @@ -15189,7 +15189,7 @@ declare namespace Office { * * More information is under {@link Office.UserProfile} */ - userProfile: Office.UserProfile; + userProfile: UserProfile; /** * Adds an event handler for a supported event. * @@ -15203,14 +15203,14 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param eventType The event that should invoke the handler. - * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. + * @param eventType - The event that should invoke the handler. + * @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 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 + * @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 Office.AsyncResult. */ - addHandlerAsync(eventType: Office.EventType, handler: (type: EventType) => void, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: Office.EventType, handler: (type: Office.EventType) => void, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Converts an item ID formatted for REST into EWS format. * @@ -15227,10 +15227,10 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param itemId An item ID formatted for the Outlook REST APIs. - * @param restVersion A value indicating the version of the Outlook REST API used to retrieve the item ID. + * @param itemId - An item ID formatted for the Outlook REST APIs. + * @param restVersion - A value indicating the version of the Outlook REST API used to retrieve the item ID. */ - convertToEwsId(itemId: string, restVersion: Office.MailboxEnums.RestVersion): string; + convertToEwsId(itemId: string, restVersion: MailboxEnums.RestVersion): string; /** * Gets a dictionary containing time information in local client time. * @@ -15252,7 +15252,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param timeValue A Date object. + * @param timeValue - A Date object. */ convertToLocalClientTime(timeValue: Date): LocalClientTime; /** @@ -15272,10 +15272,10 @@ declare namespace Office { * {@link https://docs.microsoft.com/previous-versions/office/office-365-api/api/version-2.0/mail-rest-operations | Outlook Mail API} or the {@link https://graph.microsoft.io/ | Microsoft Graph}. * The convertToRestId method converts an EWS-formatted ID into the proper format for REST. * - * @param itemId An item ID formatted for Exchange Web Services (EWS) - * @param restVersion A value indicating the version of the Outlook REST API that the converted ID will be used with. + * @param itemId - An item ID formatted for Exchange Web Services (EWS) + * @param restVersion - A value indicating the version of the Outlook REST API that the converted ID will be used with. */ - convertToRestId(itemId: string, restVersion: Office.MailboxEnums.RestVersion): string; + convertToRestId(itemId: string, restVersion: MailboxEnums.RestVersion): string; /** * Gets a Date object from a dictionary containing time information. * @@ -15290,7 +15290,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param input The local time value to convert. + * @param input - The local time value to convert. * @returns A Date object with the time expressed in UTC. */ convertToUtcClientTime(input: LocalClientTime): Date; @@ -15319,7 +15319,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param itemId The Exchange Web Services (EWS) identifier for an existing calendar appointment. + * @param itemId - The Exchange Web Services (EWS) identifier for an existing calendar appointment. */ displayAppointmentForm(itemId: string): void; /** @@ -15345,7 +15345,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param itemId The Exchange Web Services (EWS) identifier for an existing message. + * @param itemId - The Exchange Web Services (EWS) identifier for an existing message. */ displayMessageForm(itemId: string): void; /** @@ -15374,7 +15374,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Read * - * @param parameters An AppointmentForm describing the new appointment. All properties are optional. + * @param parameters - An AppointmentForm describing the new appointment. All properties are optional. */ displayNewAppointmentForm(parameters: AppointmentForm): void; /** @@ -15393,7 +15393,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Read * - * @param parameters A dictionary containing all values to be filled in for the user in the new form. All parameters are optional. + * @param parameters - A dictionary containing all values to be filled in for the user in the new form. All parameters are optional. * * toRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails} object * for each of the recipients on the To line. The array is limited to a maximum of 100 entries. @@ -15458,18 +15458,18 @@ declare namespace Office { * * In addition to this signature, the method has the following signatures: * - * `getCallbackTokenAsync(callback: (result: AsyncResult) => void): void;` + * `getCallbackTokenAsync(callback: (result: Office.AsyncResult) => void): void;` * - * `getCallbackTokenAsync(callback: (result: AsyncResult) => void, userContext?: any): void;` + * `getCallbackTokenAsync(callback: (result: Office.AsyncResult) => void, userContext?: any): void;` * - * @param options An object literal that contains one or more of the following properties. + * @param options - An object literal that contains one or more of the following properties. * 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 + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. The token is provided as a string in the `asyncResult.value` property. * If there was an error, then the `asyncResult.error` and `asyncResult.diagnostics` properties may provide additional information. */ - getCallbackTokenAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (result: AsyncResult) => void): void; + getCallbackTokenAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (result: Office.AsyncResult) => void): void; /** * Gets a string that contains a token used to get an attachment or item from an Exchange Server. * @@ -15493,11 +15493,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose and read * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type 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 token is provided as a string in the `asyncResult.value` property. * If there was an error, then the `asyncResult.error` and `asyncResult.diagnostics` properties may provide additional information. */ - getCallbackTokenAsync(callback: (result: AsyncResult) => void): void; + getCallbackTokenAsync(callback: (result: Office.AsyncResult) => void): void; /** * Gets a string that contains a token used to get an attachment or item from an Exchange Server. * @@ -15521,12 +15521,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose and read * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. The token is provided as a string in the `asyncResult.value` property. * If there was an error, then the `asyncResult.error` and `asyncResult.diagnostics` properties may provide additional information. - * @param userContext Optional. Any state data that is passed to the asynchronous method. + * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ - getCallbackTokenAsync(callback: (result: AsyncResult) => void, userContext?: any): void; + getCallbackTokenAsync(callback: (result: Office.AsyncResult) => void, userContext?: any): void; /** * Gets a token identifying the user and the Office Add-in. * @@ -15543,13 +15543,13 @@ declare namespace Office { * The getUserIdentityTokenAsync method returns a token that you can use to identify and * {@link https://docs.microsoft.com/outlook/add-ins/authentication | 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 + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. * The token is provided as a string in the `asyncResult.value` property. * If there was an error, then the `asyncResult.error` and `asyncResult.diagnostics` properties may provide additional information. - * @param userContext Optional. Any state data that is passed to the asynchronous method.| + * @param userContext - Optional. Any state data that is passed to the asynchronous method.| */ - getUserIdentityTokenAsync(callback: (result: AsyncResult) => void, userContext?: any): void; + getUserIdentityTokenAsync(callback: (result: Office.AsyncResult) => void, userContext?: any): void; /** * Makes an asynchronous request to an Exchange Web Services (EWS) service on the Exchange server that hosts the user's mailbox. * @@ -15596,13 +15596,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose and read * - * @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 Office.AsyncResult. + * @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 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. + * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ - makeEwsRequestAsync(data: any, callback: (result: AsyncResult) => void, userContext?: any): void; + makeEwsRequestAsync(data: any, callback: (result: Office.AsyncResult) => void, userContext?: any): void; /** * Removes the event handlers for a supported event type. * @@ -15616,12 +15616,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param eventType The event that should revoke the handler. - * @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 + * @param eventType - The event that should revoke the handler. + * @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 Office.AsyncResult. */ - removeHandlerAsync(eventType: Office.EventType, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + removeHandlerAsync(eventType: Office.EventType, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; } /** @@ -15688,7 +15688,7 @@ declare namespace Office { * Including them will result in an ArgumentException. * If type is ProgressIndicator, the developer should remove or replace the progress indicator when the action is complete. */ - type: Office.MailboxEnums.ItemNotificationMessageType; + type: MailboxEnums.ItemNotificationMessageType; /** * A reference to an icon that is defined in the manifest in the Resources section. It appears in the infobar area. * It is only applicable if the type is InformationalMessage. Specifying this parameter for an unsupported type results in an exception. @@ -15723,13 +15723,13 @@ declare namespace Office { * * There are a maximum of 5 notifications per message. Setting more will return a NumberOfNotificationMessagesExceeded error. * - * @param key A developer-specified key used to reference this notification message. + * @param key - A developer-specified key used to reference this notification message. * Developers can use it to modify this message later. It can't be longer than 32 characters. - * @param JSONmessage A JSON object that contains the notification message to be added to the item. + * @param JSONmessage - A JSON object that contains the notification message to be added to the item. * It contains a NotificationMessageDetails object. - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. * * [Api set: Mailbox 1.3] @@ -15745,18 +15745,18 @@ declare namespace Office { * * `addAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions): void;` * - * `addAsync(key: string, JSONmessage: NotificationMessageDetails, callback: (result: AsyncResult) => void): void;` + * `addAsync(key: string, JSONmessage: NotificationMessageDetails, callback: (result: Office.AsyncResult) => void): void;` * */ - addAsync(key: string, JSONmessage: NotificationMessageDetails, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addAsync(key: string, JSONmessage: NotificationMessageDetails, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds a notification to an item. * * There are a maximum of 5 notifications per message. Setting more will return a NumberOfNotificationMessagesExceeded error. * - * @param key A developer-specified key used to reference this notification message. Developers can use it to modify this message later. + * @param key - A developer-specified key used to reference this notification message. Developers can use it to modify this message later. * It can't be longer than 32 characters. - * @param JSONmessage A JSON object that contains the notification message to be added to the item. + * @param JSONmessage - A JSON object that contains the notification message to be added to the item. * It contains a NotificationMessageDetails object. * * [Api set: Mailbox 1.3] @@ -15772,11 +15772,11 @@ declare namespace Office { * * There are a maximum of 5 notifications per message. Setting more will return a NumberOfNotificationMessagesExceeded error. * - * @param key A developer-specified key used to reference this notification message. Developers can use it to modify this message later. + * @param key - A developer-specified key used to reference this notification message. Developers can use it to modify this message later. * It can't be longer than 32 characters. - * @param JSONmessage A JSON object that contains the notification message to be added to the item. + * @param JSONmessage - A JSON object that contains the notification message to be added to the item. * It contains a NotificationMessageDetails object. - * @param options Optional. An object literal that contains one or more of the following properties. + * @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. * * [Api set: Mailbox 1.3] @@ -15792,11 +15792,11 @@ declare namespace Office { * * There are a maximum of 5 notifications per message. Setting more will return a NumberOfNotificationMessagesExceeded error. * - * @param key A developer-specified key used to reference this notification message. Developers can use it to modify this message later. + * @param key - A developer-specified key used to reference this notification message. Developers can use it to modify this message later. * It can't be longer than 32 characters. - * @param JSONmessage A JSON object that contains the notification message to be added to the item. + * @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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. * * [Api set: Mailbox 1.3] @@ -15806,7 +15806,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - addAsync(key: string, JSONmessage: NotificationMessageDetails, callback: (result: AsyncResult) => void): void; + addAsync(key: string, JSONmessage: NotificationMessageDetails, callback: (result: Office.AsyncResult) => void): void; /** * Returns all keys and messages for an item. * @@ -15819,14 +15819,14 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `getAllAsync(callback: (result: AsyncResult) => void): void;` + * `getAllAsync(callback: (result: Office.AsyncResult) => void): void;` * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 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) => void): void; + getAllAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Returns all keys and messages for an item. * @@ -15837,10 +15837,10 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type 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) => void): void; + getAllAsync(callback: (result: Office.AsyncResult) => void): void; /** * Removes a notification message for an item. * @@ -15857,15 +15857,15 @@ declare namespace Office { * * `removeAsync(key: string, options: Office.AsyncContextOptions): void;` * - * `removeAsync(key: string, callback: (result: AsyncResult) => void): void;` + * `removeAsync(key: string, callback: (result: Office.AsyncResult) => void): void;` * - * @param key The key for the notification message to remove. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param key - The key for the notification message to remove. + * @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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - removeAsync(key: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + removeAsync(key: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Removes a notification message for an item. * @@ -15876,7 +15876,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param key The key for the notification message to remove. + * @param key - The key for the notification message to remove. */ removeAsync(key: string): void; /** @@ -15889,8 +15889,8 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param key The key for the notification message to remove. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param key - The key for the notification message to remove. + * @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. */ removeAsync(key: string, options: Office.AsyncContextOptions): void; @@ -15904,11 +15904,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @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 + * @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 Office.AsyncResult. */ - removeAsync(key: string, callback: (result: AsyncResult) => void): void; + removeAsync(key: string, callback: (result: Office.AsyncResult) => void): void; /** * Replaces a notification message that has a given key with another message. * @@ -15927,17 +15927,17 @@ declare namespace Office { * * `replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions): void;` * - * `replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback: (result: AsyncResult) => void): void;` + * `replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback: (result: Office.AsyncResult) => void): void;` * - * @param key The key for the notification message to replace. It can't be longer than 32 characters. - * @param JSONmessage A JSON object that contains the new notification message to replace the existing message. + * @param key - The key for the notification message to replace. It can't be longer than 32 characters. + * @param JSONmessage - A JSON object that contains the new notification message to replace the existing message. * It contains a NotificationMessageDetails object. - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Replaces a notification message that has a given key with another message. * @@ -15950,8 +15950,8 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param key The key for the notification message to replace. It can't be longer than 32 characters. - * @param JSONmessage A JSON object that contains the new notification message to replace the existing message. + * @param key - The key for the notification message to replace. It can't be longer than 32 characters. + * @param JSONmessage - A JSON object that contains the new notification message to replace the existing message. * It contains a NotificationMessageDetails object. */ replaceAsync(key: string, JSONmessage: NotificationMessageDetails): void; @@ -15967,10 +15967,10 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param key The key for the notification message to replace. It can't be longer than 32 characters. - * @param JSONmessage A JSON object that contains the new notification message to replace the existing message. + * @param key - The key for the notification message to replace. It can't be longer than 32 characters. + * @param JSONmessage - A JSON object that contains the new notification message to replace the existing message. * It contains a NotificationMessageDetails object. - * @param options Optional. An object literal that contains one or more of the following properties. + * @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. */ replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions): void; @@ -15986,13 +15986,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param key The key for the notification message to replace. It can't be longer than 32 characters. - * @param JSONmessage A JSON object that contains the new notification message to replace the existing message. + * @param key - The key for the notification message to replace. It can't be longer than 32 characters. + * @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 + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. */ - replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback: (result: AsyncResult) => void): void; + replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback: (result: Office.AsyncResult) => void): void; } /** * Represents a phone number identified in an item. Read mode only. @@ -16056,15 +16056,15 @@ declare namespace Office { * * `addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options: Office.AsyncContextOptions): void;` * - * `addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], callback: (result: AsyncResult) => void): void;` + * `addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], callback: (result: Office.AsyncResult) => void): void;` * - * @param recipients The recipients to add to the recipients list. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param recipients - The recipients to add to the recipients list. + * @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 + * @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 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; + addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Adds a recipient list to the existing recipients for an appointment or message. * @@ -16085,7 +16085,7 @@ declare namespace Office { * * ErrorsNumberOfRecipientsExceeded - The number of recipients exceeded 100 entries. * - * @param recipients The recipients to add to the recipients list. + * @param recipients - The recipients to add to the recipients list. */ addAsync(recipients: (string | EmailUser | EmailAddressDetails)[]): void; /** @@ -16108,8 +16108,8 @@ declare namespace Office { * * ErrorsNumberOfRecipientsExceeded - The number of recipients exceeded 100 entries. * - * @param recipients The recipients to add to the recipients list. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param recipients - The recipients to add to the recipients list. + * @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. */ addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options: Office.AsyncContextOptions): void; @@ -16133,11 +16133,11 @@ declare namespace Office { * * ErrorsNumberOfRecipientsExceeded - The number of recipients exceeded 100 entries. * - * @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 + * @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 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; + addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], callback: (result: Office.AsyncResult) => void): void; /** * Gets a recipient list for an appointment or message. * @@ -16152,15 +16152,15 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `getAsync(callback: (result: AsyncResult) => void): void;` + * `getAsync(callback: (result: Office.AsyncResult) => void): void;` * - * @param options An object literal that contains one or more of the following properties. + * @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 + * @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 an array of EmailAddressDetails objects. */ - getAsync(options: Office.AsyncContextOptions, callback: (result: AsyncResult) => void): void; + getAsync(options: Office.AsyncContextOptions, callback: (result: Office.AsyncResult) => void): void; /** * Gets a recipient list for an appointment or message. * @@ -16173,11 +16173,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of + * @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 an array of EmailAddressDetails objects. */ - getAsync(callback: (result: AsyncResult) => void): void; + getAsync(callback: (result: Office.AsyncResult) => void): void; /** * Sets a recipient list for an appointment or message. * @@ -16206,17 +16206,17 @@ declare namespace Office { * * `setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options: Office.AsyncContextOptions): void;` * - * `setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], callback: (result: AsyncResult) => void): void;` + * `setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], callback: (result: Office.AsyncResult) => void): void;` * - * @param recipients The recipients to add to the recipients list. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param recipients - The recipients to add to the recipients list. + * @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 + * @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 setting the recipients fails the asyncResult.error property will contain a code that indicates any error that occurred * while adding the data. */ - setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Sets a recipient list for an appointment or message. * @@ -16239,7 +16239,7 @@ declare namespace Office { * * ErrorsNumberOfRecipientsExceeded - The number of recipients exceeded 100 entries. * - * @param recipients The recipients to add to the recipients list. + * @param recipients - The recipients to add to the recipients list. */ setAsync(recipients: (string | EmailUser | EmailAddressDetails)[]): void; /** @@ -16264,8 +16264,8 @@ declare namespace Office { * * ErrorsNumberOfRecipientsExceeded - The number of recipients exceeded 100 entries. * - * @param recipients The recipients to add to the recipients list. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param recipients - The recipients to add to the recipients list. + * @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. */ setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options: Office.AsyncContextOptions): void; @@ -16291,13 +16291,13 @@ declare namespace Office { * * ErrorsNumberOfRecipientsExceeded - The number of recipients exceeded 100 entries. * - * @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 + * @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 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. */ - setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], callback: (result: AsyncResult) => void): void; + setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], callback: (result: Office.AsyncResult) => void): void; } @@ -16354,7 +16354,7 @@ declare namespace Office { * * */ - export interface Recurrence { + interface Recurrence { /** * Gets or sets the properties of the recurring appointment series. * @@ -16366,7 +16366,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - recurrenceProperties: Office.RecurrenceProperties; + recurrenceProperties: RecurrenceProperties; /** * Gets or sets the properties of the recurring appointment series. * @@ -16378,7 +16378,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - recurrenceTimeZone: Office.RecurrenceTimeZone; + recurrenceTimeZone: RecurrenceTimeZone; /** * Gets or sets the type of the recurring appointment series. @@ -16391,7 +16391,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - recurrenceType: Office.MailboxEnums.RecurrenceType; + recurrenceType: MailboxEnums.RecurrenceType; /** * The {@link Office.SeriesTime} object enables you to manage the start and end dates of the recurring appointment series and the usual start @@ -16406,7 +16406,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - seriesTime: Office.SeriesTime; + seriesTime: SeriesTime; /** * Returns the current recurrence object of an appointment series. @@ -16423,15 +16423,15 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `getAsync(callback?: (result: AsyncResult) => void): void;` + * `getAsync(callback?: (result: Office.AsyncResult) => void): void;` * - * @param options Optional. An object literal that contains one or more of the following properties. + * @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 Office.AsyncResult 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 Office.AsyncResult object. * The `value` property of the result is a Recurrence object. */ - getAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + getAsync(options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Returns the current recurrence object of an appointment series. @@ -16446,11 +16446,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, - * asyncResult, which is an Office.AsyncResult 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 Office.AsyncResult object. * The `value` property of the result is a Recurrence object. */ - getAsync(callback?: (result: AsyncResult) => void): void; + getAsync(callback?: (result: Office.AsyncResult) => void): void; /** * Sets the recurrence pattern of an appointment series. @@ -16469,15 +16469,15 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `setAsync(recurrencePattern: Recurrence, callback?: (result: AsyncResult) => void): void;` + * `setAsync(recurrencePattern: Recurrence, callback?: (result: Office.AsyncResult) => void): void;` * - * @param recurrencePattern A recurrence object. - * @param options Optional. An object literal that contains one or more of the following properties. + * @param recurrencePattern - A recurrence object. + * @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 Office.AsyncResult 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 Office.AsyncResult object. */ - setAsync(recurrencePattern: Recurrence, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + setAsync(recurrencePattern: Recurrence, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Sets the recurrence pattern of an appointment series. @@ -16494,11 +16494,11 @@ declare namespace Office { * * ErrorsInvalidEndTime - The appointment end time is before its start time. * - * @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 Office.AsyncResult object. + * @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 Office.AsyncResult object. */ - setAsync(recurrencePattern: Recurrence, callback?: (result: AsyncResult) => void): void; + setAsync(recurrencePattern: Recurrence, callback?: (result: Office.AsyncResult) => void): void; } /** @@ -16512,7 +16512,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - export interface RecurrenceProperties { + interface RecurrenceProperties { /** * Represents the period between instances of the same recurring series. */ @@ -16524,24 +16524,24 @@ declare namespace Office { /** * Represents the day of the week or type of day, for example, weekend day vs weekday. */ - dayOfWeek: Office.MailboxEnums.Days; + dayOfWeek: MailboxEnums.Days; /** * Represents the set of days for this recurrence. Valid values are: 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', and 'Sun'. */ - days: Office.MailboxEnums.Days[]; + days: MailboxEnums.Days[]; /** * Represents the number of the week in the selected month e.g. 'first' for first week of the month. */ - weekNumber: Office.MailboxEnums.WeekNumber; + weekNumber: MailboxEnums.WeekNumber; /** * Represents the month. */ - month: Office.MailboxEnums.Month; + month: MailboxEnums.Month; /** * Represents your chosen first day of the week otherwise the default is the value in the current user's settings. * Valid values are: 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', and 'Sun'. */ - firstDayOfWeek: Office.MailboxEnums.Days; + firstDayOfWeek: MailboxEnums.Days; } /** @@ -16555,11 +16555,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - export interface RecurrenceTimeZone { + interface RecurrenceTimeZone { /** * Represents the name of the recurrence time zone. */ - name: Office.MailboxEnums.RecurrenceTimeZone; + name: MailboxEnums.RecurrenceTimeZone; /** * Integer value representing the difference in minutes between the local time zone and UTC at the date that the meeting series began. @@ -16570,7 +16570,7 @@ declare namespace Office { /** * A file or item attachment. Used when displaying a reply form. */ - export interface ReplyFormAttachment { + interface ReplyFormAttachment { /** * Indicates the type of attachment. Must be file for a file attachment or item for an item attachment. */ @@ -16608,9 +16608,9 @@ 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 Office.AsyncResult object. + *asyncResult, which is an Office.AsyncResult object. */ - callback?: (result: AsyncResult) => void; + callback?: (result: Office.AsyncResult) => void; } /** * The settings created by using the methods of the RoamingSettings object are saved per add-in and per user. @@ -16647,7 +16647,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param name The case-sensitive name of the setting to retrieve. + * @param name - The case-sensitive name of the setting to retrieve. * @returns Type: String | Number | Boolean | Object | Array */ get(name: string): any; @@ -16661,7 +16661,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param name The case-sensitive name of the setting to remove. + * @param name - The case-sensitive name of the setting to remove. */ remove(name: string): void; /** @@ -16678,10 +16678,10 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * @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; + saveAsync(callback?: (result: Office.AsyncResult) => void): void; /** * Sets or creates the specified setting. * @@ -16699,8 +16699,8 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * @param name The case-sensitive name of the setting to set or create. - * @param value Specifies the value to be stored. + * @param name - The case-sensitive name of the setting to set or create. + * @param value - Specifies the value to be stored. */ set(name: string, value: any): void; } @@ -16790,7 +16790,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param minutes The length of the appointment in minutes. + * @param minutes - The length of the appointment in minutes. */ setDuration(minutes: number): void; @@ -16811,9 +16811,9 @@ declare namespace Office { * `setEndDate(date: string): void;` (Where date is the end date of the recurring appointment series represented in the * {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD"). * - * @param year The year value of the end date. - * @param month The month value of the end date. Valid range is 0-11 where 0 represents the 1st month and 11 represents the 12th month. - * @param day The day value of the end date. + * @param year - The year value of the end date. + * @param month - The month value of the end date. Valid range is 0-11 where 0 represents the 1st month and 11 represents the 12th month. + * @param day - The day value of the end date. */ setEndDate(year: number, month: number, day: number): void; /** @@ -16828,7 +16828,7 @@ declare namespace Office { * * ErrorsInvalid date format - The date is not in an acceptable format. * - * @param date End date of the recurring appointment series represented in the {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD". + * @param date - End date of the recurring appointment series represented in the {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD". */ setEndDate(date: string): void; /** @@ -16847,9 +16847,9 @@ declare namespace Office { * * `setStartDate(date: string): void;` (Where date is the start date of the recurring appointment series represented in the {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD"). * - * @param year The year value of the start date. - * @param month The month value of the start date. Valid range is 0-11 where 0 represents the 1st month and 11 represents the 12th month. - * @param day The day value of the start date. + * @param year - The year value of the start date. + * @param month - The month value of the start date. Valid range is 0-11 where 0 represents the 1st month and 11 represents the 12th month. + * @param day - The day value of the start date. */ setStartDate(year:number, month:number, day:number): void; @@ -16865,7 +16865,7 @@ declare namespace Office { * * ErrorsInvalid date format - The date is not in an acceptable format. * - * @param date Start date of the recurring appointment series represented in the {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD". + * @param date - Start date of the recurring appointment series represented in the {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD". */ setStartDate(date:string): void; @@ -16886,8 +16886,8 @@ declare namespace Office { * * `setStartTime(time: string): void;` (Where time is the start time of all instances represented by standard datetime string format: "THH:mm:ss:mmm"). * - * @param hours The hour value of the start time. Valid range: 0-24. - * @param minutes The minute value of the start time. Valid range: 0-59. + * @param hours - The hour value of the start time. Valid range: 0-24. + * @param minutes - The minute value of the start time. Valid range: 0-59. */ setStartTime(hours: number, minutes: number): void; @@ -16904,7 +16904,7 @@ declare namespace Office { * * ErrorsInvalid time format - The time is not in an acceptable format. * - * @param time Start time of all instances represented by standard datetime string format: "THH:mm:ss:mmm". + * @param time - Start time of all instances represented by standard datetime string format: "THH:mm:ss:mmm". */ setStartTime(time: string): void; } @@ -16933,7 +16933,7 @@ declare namespace Office { /** * The permissions that the delegate has on a shared folder. */ - delegatePermissions: Office.MailboxEnums.DelegatePermissions; + delegatePermissions: MailboxEnums.DelegatePermissions; } /** @@ -16961,15 +16961,15 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `getAsync(callback: (result: AsyncResult) => void): void;` + * `getAsync(callback: (result: Office.AsyncResult) => void): void;` * - * @param options An object literal that contains one or more of the following properties. + * @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 + * @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 subject of the item. */ - getAsync(options: Office.AsyncContextOptions, callback: (result: AsyncResult) => void): void; + getAsync(options: Office.AsyncContextOptions, callback: (result: Office.AsyncResult) => void): void; /** * Gets the subject of an appointment or message. * @@ -16982,10 +16982,10 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type 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 subject of the item. */ - getAsync(callback: (result: AsyncResult) => void): void; + getAsync(callback: (result: Office.AsyncResult) => void): void; /** * Sets the subject of an appointment or message. * @@ -17007,15 +17007,15 @@ declare namespace Office { * * `setAsync(subject: string, options: Office.AsyncContextOptions): void;` * - * `setAsync(subject: string, callback: (result: AsyncResult) => void): void;` + * `setAsync(subject: string, callback: (result: Office.AsyncResult) => void): void;` * - * @param subject The subject of the appointment or message. The string is limited to 255 characters. - * @param options An object literal that contains one or more of the following properties. + * @param subject - The subject of the appointment or message. The string is limited to 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 + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * 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; + setAsync(subject: string, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Sets the subject of an appointment or message. * @@ -17031,7 +17031,7 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The subject parameter is longer than 255 characters. * - * @param subject The subject of the appointment or message. The string is limited to 255 characters. + * @param subject - The subject of the appointment or message. The string is limited to 255 characters. */ setAsync(data: string): void; /** @@ -17049,8 +17049,8 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The subject parameter is longer than 255 characters. * - * @param subject The subject of the appointment or message. The string is limited to 255 characters. - * @param options An object literal that contains one or more of the following properties. + * @param subject - The subject of the appointment or message. The string is limited to 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. */ setAsync(data: string, options: Office.AsyncContextOptions): void; @@ -17069,11 +17069,11 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The subject parameter is longer than 255 characters. * - * @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 + * @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 Office.AsyncResult. If setting the subject fails, the asyncResult.error property will contain an error code. */ - setAsync(data: string, callback: (result: AsyncResult) => void): void; + setAsync(data: string, callback: (result: Office.AsyncResult) => void): void; } /** @@ -17125,14 +17125,14 @@ declare namespace Office { * * In addition to this signature, this method also has the following signature: * - * `getAsync(callback: (result: AsyncResult) => void): void;` + * `getAsync(callback: (result: Office.AsyncResult) => void): void;` * - * @param options An object literal that contains one or more of the following properties. + * @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 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 a Date object. */ - getAsync(options: Office.AsyncContextOptions, callback: (result: AsyncResult) => void): void; + getAsync(options: Office.AsyncContextOptions, callback: (result: Office.AsyncResult) => void): void; /** * Gets the start or end time of an appointment. * @@ -17146,10 +17146,10 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type 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 a Date object. */ - getAsync(callback: (result: AsyncResult) => void): void; + getAsync(callback: (result: Office.AsyncResult) => void): void; /** * Sets the start or end time of an appointment. * @@ -17173,16 +17173,16 @@ declare namespace Office { * * `setAsync(dateTime: Date, options: Office.AsyncContextOptions): void;` * - * `setAsync(dateTime: Date, callback: (result: AsyncResult) => void): void;` + * `setAsync(dateTime: Date, callback: (result: Office.AsyncResult) => void): void;` * - * @param dateTime A date-time object in Coordinated Universal Time (UTC). - * @param options An object literal that contains one or more of the following properties. + * @param dateTime - A date-time object in Coordinated Universal Time (UTC). + * @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 + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * 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; + setAsync(dateTime: Date, options?: Office.AsyncContextOptions, callback?: (result: Office.AsyncResult) => void): void; /** * Sets the start or end time of an appointment. * @@ -17200,7 +17200,7 @@ declare namespace Office { * * ErrorsInvalidEndTime - The appointment end time is before the appointment start time. * - * @param dateTime A date-time object in Coordinated Universal Time (UTC). + * @param dateTime - A date-time object in Coordinated Universal Time (UTC). */ setAsync(dateTime: Date): void; /** @@ -17220,8 +17220,8 @@ declare namespace Office { * * ErrorsInvalidEndTime - The appointment end time is before the appointment start time. * - * @param dateTime A date-time object in Coordinated Universal Time (UTC). - * @param options An object literal that contains one or more of the following properties. + * @param dateTime - A date-time object in Coordinated Universal Time (UTC). + * @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. */ setAsync(dateTime: Date, options: Office.AsyncContextOptions): void; @@ -17242,12 +17242,12 @@ declare namespace Office { * * ErrorsInvalidEndTime - The appointment end time is before the appointment start time. * - * @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 + * @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 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; + setAsync(dateTime: Date, callback: (result: Office.AsyncResult) => void): void; } /**