diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index 872ee94385..26ce17ea52 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -728,15 +728,15 @@ declare namespace Office { */ license: string; /** - * Provides access to the Outlook Add-in object model for Microsoft Outlook and Microsoft Outlook on the web. + * Provides access to the Microsoft Outlook add-in object model. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * - * **Namespaces**: + * **Key properties**: * * - `diagnostics`: Provides diagnostic information to an Outlook add-in. * @@ -760,14 +760,14 @@ declare namespace Office { /** * Gets an object that represents the custom settings or state of a mail add-in saved to a user's mailbox. * - * The RoamingSettings object lets you store and access data for a mail add-in that is stored in a user's mailbox, so that is available to + * The `RoamingSettings` object lets you store and access data for a mail add-in that is stored in a user's mailbox, so it's available to * that add-in when it is running from any host client application used to access that mailbox. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ roamingSettings: Office.RoamingSettings; /** @@ -813,16 +813,16 @@ declare namespace Office { } namespace AddinCommands { /** - * The event object is passed as a parameter to add-in functions invoked by UI-less command buttons. The object allows the add-in to identify + * The `Event` object is passed as a parameter to add-in functions invoked by UI-less command buttons. The object allows the add-in to identify * which button was clicked and to signal the host that it has completed its processing. * * @remarks * * See {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/add-in-commands-requirement-sets | Add-in commands requirement sets} for more support information. * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: Restricted * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface Event { /** @@ -830,7 +830,7 @@ declare namespace Office { * * @remarks * - * This property is only supported in Outlook in {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/outlook-api-requirement-sets | requirement set} Mailbox 1.3 and later. + * This property is supported in Outlook only in {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/outlook-api-requirement-sets | requirement set} Mailbox 1.3 and later. */ source:Source; @@ -839,7 +839,7 @@ declare namespace Office { * * This method must be called at the end of a function which was invoked by the following. * - * - A UI-less button (i.e., an add-in command defined with an Action element where the xsi:type attribute is set to ExecuteFunction) + * - A UI-less button (i.e., an add-in command defined with an `Action` element where the `xsi:type` attribute is set to `ExecuteFunction`) * * - An {@link https://docs.microsoft.com/office/dev/add-ins/reference/manifest/event | event} defined in the * {@link https://docs.microsoft.com/office/dev/add-ins/reference/manifest/extensionpoint#events | Events extension point}, @@ -849,11 +849,11 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * - * The `options` parameter was introduced in Mailbox 1.8. + * **Note**: The `options` parameter was introduced in Mailbox 1.8. * * @param options Optional. An object that specifies behavior options for when the event is completed. */ @@ -878,7 +878,7 @@ declare namespace Office { interface Source { /** - * The id of the control that triggered calling this function. The id comes from the manifest and is the unique ID of your Office Add-in + * The ID of the control that triggered calling this function. The ID comes from the manifest and is the unique ID of your Office Add-in * as a GUID. */ id: string; @@ -1837,7 +1837,7 @@ declare namespace Office { Text, } /** - * Specifies the kind of event that was raised. Returned by the `type` property of an *EventArgs object. + * Specifies the kind of event that was raised. Returned by the `type` property of an `*EventArgs` object. * * Add-ins for Project support the `Office.EventType.ResourceSelectionChanged`, `Office.EventType.TaskSelectionChanged`, and * `Office.EventType.ViewSelectionChanged` event types. @@ -7851,7 +7851,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum AttachmentContentFormat { /** @@ -7881,7 +7881,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum AttachmentStatus { /** @@ -7899,19 +7899,19 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum AttachmentType { /** - * The attachment is a file + * The attachment is a file. */ File = "file", /** - * The attachment is an Exchange item + * The attachment is an Exchange item. */ Item = "item", /** - * The attachment is stored in a cloud location, such as OneDrive. The id property of the attachment contains a URL to the file. + * The attachment is stored in a cloud location, such as OneDrive. The `id` property of the attachment contains a URL to the file. */ Cloud = "cloud" } @@ -7925,11 +7925,11 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum CategoryColor { /** - * Default color or no color mapped + * Default color or no color mapped. */ None, /** @@ -8040,7 +8040,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum Days { /** @@ -8091,7 +8091,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum DelegatePermissions { /** @@ -8124,7 +8124,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum EntityType { /** @@ -8163,19 +8163,19 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum ItemNotificationMessageType { /** - * The notificationMessage is a progress indicator. + * The notification message is a progress indicator. */ ProgressIndicator = "progressIndicator", /** - * The notificationMessage is an informational message. + * The notification message is an informational message. */ InformationalMessage = "informationalMessage", /** - * The notificationMessage is an error message. + * The notification message is an error message. */ ErrorMessage = "errorMessage" } @@ -8184,7 +8184,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum ItemType { /** @@ -8203,7 +8203,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum LocationType { /** @@ -8222,7 +8222,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum Month { /** @@ -8279,15 +8279,15 @@ declare namespace Office { */ enum OWAView { /** - * One column view. Displayed when the screen is narrow. Outlook on the web uses this single-column layout on the entire screen of a smartphone. + * One-column view. Displayed when the screen is narrow. Outlook on the web uses this single-column layout on the entire screen of a smartphone. */ OneColumn = "OneColumn", /** - * Two column view. Displayed when the screen is wider. Outlook on the web uses this view on most tablets. + * Two-column view. Displayed when the screen is wider. Outlook on the web uses this view on most tablets. */ TwoColumns = "TwoColumns", /** - Three column view. Displayed when the screen is wide. For example, Outlook on the web uses this view in a full screen window on a desktop + Three-column view. Displayed when the screen is wide. For example, Outlook on the web uses this view in a full screen window on a desktop computer. */ ThreeColumns = "ThreeColumns" @@ -8299,7 +8299,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum RecipientType { /** @@ -8326,7 +8326,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum RecurrenceTimeZone { /** @@ -8881,7 +8881,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum RecurrenceType { /** @@ -8910,7 +8910,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum ResponseType { /** @@ -8941,7 +8941,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum RestVersion { /** @@ -8964,7 +8964,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose */ enum SourceProperty { /** @@ -8983,7 +8983,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum WeekNumber { /** @@ -9015,7 +9015,7 @@ declare namespace Office { * The subclass of {@link Office.Item | Item} dealing with appointments. * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. - * You should treat this as a mode of Office.context.mailbox.item. Refer to the + * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information. * * Child interfaces: @@ -9030,7 +9030,7 @@ declare namespace Office { * The appointment organizer mode of {@link Office.Item | Office.context.mailbox.item}. * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. - * You should treat this as a mode of Office.context.mailbox.item. Refer to the + * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information. * * Parent interfaces: @@ -9047,9 +9047,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ body: Body; /** @@ -9059,25 +9059,25 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ categories: Categories; /** * Gets or sets the date and time that the appointment is to end. * - * The end property is a {@link Office.Time | Time} object expressed as a Coordinated Universal Time (UTC) date and time value. - * You can use the convertToLocalClientTime method to convert the end property value to the client's local date and time. + * The `end` property is a {@link Office.Time | Time} object expressed as a Coordinated Universal Time (UTC) date and time value. + * You can use the `convertToLocalClientTime` method to convert the `end` property value to the client's local date and time. * - * When you use the Time.setAsync method to set the end time, you should use the convertToUtcClientTime method to convert the local time on + * When you use the `Time.setAsync` method to set the end time, you should use the `convertToUtcClientTime` method to convert the local time on * the client to UTC for the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ end: Time; /** @@ -9088,32 +9088,32 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ enhancedLocation: EnhancedLocation; /** * Gets the type of item that an instance represents. * - * The itemType property returns one of the ItemType enumeration values, indicating whether the item object instance is a message or an appointment. + * The `itemType` property returns one of the `ItemType` enumeration values, indicating whether the `item` object instance is a message or an appointment. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ itemType: MailboxEnums.ItemType | string; /** - * Gets or sets the location of an appointment. The location property returns a {@link Office.Location | Location} object that provides methods that are + * Gets or sets the location of an appointment. The `location` property returns a {@link Office.Location | Location} object that provides methods that are * used to get and set the location of the appointment. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ location: Location; /** @@ -9123,15 +9123,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ 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 a {@link Office.Recipients | Recipients} object that provides methods to get or update the optional attendees + * The `optionalAttendees` property returns a {@link Office.Recipients | Recipients} object that provides methods to get or update the optional attendees * for a meeting. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, the following limits apply. * * - Get 500 members maximum. @@ -9140,32 +9140,32 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ optionalAttendees: Recipients; /** * Gets the organizer for the specified meeting. * - * The organizer property returns an {@link Office.Organizer | Organizer} object that provides a method to get the organizer value. + * The `organizer` property returns an {@link Office.Organizer | Organizer} object that provides a method to get the organizer value. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ organizer: Organizer; /** * Gets or sets the recurrence pattern of an appointment. * - * The recurrence property returns a recurrence object for recurring appointments or meetings requests if an item is a series or an instance + * The `recurrence` property returns a recurrence object for recurring appointments or meetings requests if an item is a series or an instance * in a series. `null` is returned for single appointments and meeting requests of single appointments. * - * **Note**: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request. + * **Note**: Meeting requests have an `itemClass` value of `IPM.Schedule.Meeting.Request`. * * **Note**: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single * appointment and NOT a part of a series. @@ -9174,15 +9174,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ recurrence: Recurrence; /** * Provides access to the required attendees of an event. The type of object and level of access depends on the mode of the current item. * - * The requiredAttendees property returns a {@link Office.Recipients | Recipients} object that provides methods to get or update the required attendees + * The `requiredAttendees` property returns a {@link Office.Recipients | Recipients} object that provides methods to get or update the required attendees * for a meeting. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, the following limits apply. * * - Get 500 members maximum. @@ -9191,71 +9191,71 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ requiredAttendees: Recipients; /** * Gets the id of the series that an instance belongs to. * - * In Outlook on the web and desktop clients, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to. - * However, on iOS and Android, the seriesId returns the REST ID of the parent item. + * In Outlook on the web and desktop clients, the `seriesId` property returns the Exchange Web Services (EWS) ID of the parent (series) item + * that this item belongs to. However, on iOS and Android, the seriesId returns the REST ID of the parent item. * - * **Note**: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier. - * The seriesId property is not identical to the Outlook IDs used by the Outlook REST API. - * Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId. - * For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. + * **Note**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier. + * The `seriesId` property is not identical to the Outlook IDs used by the Outlook REST API. + * Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`. + * For more details, see {@link https://docs.microsoft.com/office/dev/add-ins/outlook/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. * - * The seriesId property returns null for items that do not have parent items such as single appointments, series items, or meeting requests - * and returns undefined for any other items that are not meeting requests. + * The `seriesId` property returns `null` for items that do not have parent items such as single appointments, series items, or meeting requests + * and returns `undefined` for any other items that are not meeting requests. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ seriesId: string; /** * Gets or sets the date and time that the appointment is to begin. * - * The start property is a {@link Office.Time | Time} object expressed as a Coordinated Universal Time (UTC) date and time value. - * You can use the convertToLocalClientTime method to convert the value to the client's local date and time. + * The `start` property is a {@link Office.Time | Time} object expressed as a Coordinated Universal Time (UTC) date and time value. + * You can use the `convertToLocalClientTime` method to convert the value to the client's local date and time. * - * When you use the Time.setAsync method to set the start time, you should use the convertToUtcClientTime method to convert the local time on + * When you use the `Time.setAsync` method to set the start time, you should use the `convertToUtcClientTime` method to convert the local time on * the client to UTC for the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ start: Time; /** * Gets or sets the description that appears in the subject field of an item. * - * The subject property gets or sets the entire subject of the item, as sent by the email server. + * The `subject` property gets or sets the entire subject of the item, as sent by the email server. * - * The subject property returns a Subject object that provides methods to get and set the subject. + * The `subject` property returns a `Subject` object that provides methods to get and set the subject. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ subject: Subject; /** * Adds a file to a message or appointment as an attachment. * - * The addFileAttachmentAsync method uploads the file at the specified URI and attaches it to the item in the compose form. + * The `addFileAttachmentAsync` method uploads the file at the specified URI and attaches it to the item in the compose form. * - * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * * **Important**: In recent builds of Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to * this action (whether using this API or the Outlook UI). To work around this issue, you can try using the `addFileAttachmentFromBase64` API @@ -9265,34 +9265,37 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - AttachmentSizeExceeded: The attachment is larger than allowed. + * - `AttachmentSizeExceeded`: The attachment is larger than allowed. * - * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * - `FileTypeNotSupported`: The attachment has an extension that is not allowed. * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `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. - * 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 - 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 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. + * `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 - 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 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 & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds a file to a message or appointment as an attachment. * - * The addFileAttachmentAsync method uploads the file at the specified URI and attaches it to the item in the compose form. + * The `addFileAttachmentAsync` method uploads the file at the specified URI and attaches it to the item in the compose form. * - * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * * **Important**: In recent builds of Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to * this action (whether using this API or the Outlook UI). To work around this issue, you can try using the `addFileAttachmentFromBase64` API @@ -9302,94 +9305,101 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - AttachmentSizeExceeded: The attachment is larger than allowed. + * - `AttachmentSizeExceeded`: The attachment is larger than allowed. * - * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * - `FileTypeNotSupported`: The attachment has an extension that is not allowed. * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `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 - 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 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. + * @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 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?: (asyncResult: 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. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * - * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. + * **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API. * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - AttachmentSizeExceeded: The attachment is larger than allowed. + * - `AttachmentSizeExceeded`: The attachment is larger than allowed. * - * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * - `FileTypeNotSupported`: The attachment has an extension that is not allowed. * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `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. - * 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 - 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 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. + * `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 - 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 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. */ addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: 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. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * - * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. + * **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API. * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - AttachmentSizeExceeded: The attachment is larger than allowed. + * - `AttachmentSizeExceeded`: The attachment is larger than allowed. * - * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * - `FileTypeNotSupported`: The attachment has an extension that is not allowed. * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `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 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 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. + * @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 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. */ addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -9401,17 +9411,17 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * The type property on the parameter will match the eventType parameter passed to addHandlerAsync. + * 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. - * 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. + * `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. */ addHandlerAsync(eventType: Office.EventType | string, handler: any, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -9423,105 +9433,109 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * 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. + * 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. */ addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. * - * The addItemAttachmentAsync method attaches the item with the specified Exchange identifier to the item in the compose form. - * If you specify a callback method, the method is called with one parameter, asyncResult, which contains either the attachment identifier or + * The `addItemAttachmentAsync` method attaches the item with the specified Exchange identifier to the item in the compose form. + * If you specify a callback method, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or * a code that indicates any error that occurred while attaching the item. - * You can use the options parameter to pass state information to the callback method, if needed. + * You can use the `options` parameter to pass state information to the callback method, if needed. * - * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * - * If your Office add-in is running in Outlook on the web, the addItemAttachmentAsync method can attach items to items other than the item that + * If your Office Add-in is running in Outlook on the web, the `addItemAttachmentAsync` method can attach items to items other than the item that * you are editing; however, this is not supported and is not recommended. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `NumberOfAttachmentsExceeded`: 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 - 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. - * 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. + * `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`. + * 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?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. * - * The addItemAttachmentAsync method attaches the item with the specified Exchange identifier to the item in the compose form. - * If you specify a callback method, the method is called with one parameter, asyncResult, which contains either the attachment identifier or + * The `addItemAttachmentAsync` method attaches the item with the specified Exchange identifier to the item in the compose form. + * If you specify a callback method, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or * a code that indicates any error that occurred while attaching the item. - * You can use the options parameter to pass state information to the callback method, if needed. + * You can use the `options` parameter to pass state information to the callback method, if needed. * - * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * - * If your Office add-in is running in Outlook on the web, the addItemAttachmentAsync method can attach items to items other than the item that + * If your Office Add-in is running in Outlook on the web, the `addItemAttachmentAsync` method can attach items to items other than the item that * you are editing; however, this is not supported and is not recommended. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `NumberOfAttachmentsExceeded`: 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 - 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 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. + * @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 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?: (asyncResult: Office.AsyncResult) => void): void; /** * Closes the current item that is being composed * - * The behaviors of the close method depends on the current state of the item being composed. + * The behaviors of the `close` method depends on the current state of the item being composed. * If the item has unsaved changes, the client prompts the user to save, discard, or close the action. * - * In the Outlook desktop client, if the message is an inline reply, the close method has no effect. + * In the Outlook desktop client, if the message is an inline reply, the `close` method has no effect. * - * **Note**: In Outlook on the web, if the item is an appointment and it has previously been saved using saveAsync, the user is prompted to save, + * **Note**: In Outlook on the web, if the item is an appointment and it has previously been saved using `saveAsync`, the user is prompted to save, * discard, or cancel even if no changes have occurred since the item was last saved. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ close(): void; /** - * Gets an attachment from a message or appointment and returns it as an **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 @@ -9533,27 +9547,27 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - AttachmentTypeNotSupported: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, + * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, * or item attachment types other than email or calendar items (such as a contact or task item). * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: 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. - * 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 - * with the reason for the failure. + * `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 + * an error code with the reason for the failure. */ getAttachmentContentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** - * Gets an attachment from a message or appointment and returns it as an **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 @@ -9565,21 +9579,21 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - AttachmentTypeNotSupported: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, + * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, * or item attachment types other than email or calendar items (such as a contact or task item). * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * * @param attachmentId - The identifier of the attachment you want to get. - * @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. + * @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 + * an error code with the reason for the failure. */ getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -9589,14 +9603,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * @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. If the call fails, the asyncResult.error property will contain and error code with the reason for + * `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`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for * the failure. */ getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; @@ -9607,35 +9621,38 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * - * @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 + * @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 an error code with the reason for * the failure. */ getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Gets initialization data passed when the add-in is activated by an actionable message. * - * **Note**: This method is only supported by Outlook 2016 or later on Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web for Office 365. + * **Note**: This method is only supported by Outlook 2016 or later on Windows (Click-to-Run versions greater than 16.0.8413.1000) + * and Outlook on the web for Office 365. * * [Api set: Mailbox Preview] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * 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. - * 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. - * 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. + * `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`. + * 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 */ @@ -9643,21 +9660,24 @@ declare namespace Office { /** * Gets initialization data passed when the add-in is activated by an actionable message. * - * **Note**: This method is only supported by Outlook 2016 or later on Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web for Office 365. + * **Note**: This method is only supported by Outlook 2016 or later on Windows (Click-to-Run versions greater than 16.0.8413.1000) + * and Outlook on the web for Office 365. * * [Api set: Mailbox Preview] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * More information on {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | actionable messages}. * - * @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. + * @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 */ @@ -9675,17 +9695,18 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * * - `ItemNotSaved`: The id can't be retrieved until the item is saved. * * @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. + * `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`. */ getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -9701,68 +9722,70 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * * - `ItemNotSaved`: The id can't be retrieved until the item is saved. * - * @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`. */ getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * * If there is no selection but the cursor is in the body or subject, the method returns an empty string for the selected data. - * If a field other than the body or subject is selected, the method returns the InvalidSelection error. + * If a field other than the body or subject is selected, the method returns the `InvalidSelection` error. * - * To access the selected data from the callback method, call asyncResult.value.data. - * To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject. + * To access the selected data from the callback method, call `asyncResult.value.data`. + * To access the `source` property that the selection comes from, call `asyncResult.value.sourceProperty`, which will be either `body` or `subject`. * * [Api set: Mailbox 1.2] * * @returns - * The selected data as a string with format determined by coercionType. + * The selected data as a string with format determined by `coercionType`. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * If HTML, the method returns the selected text, whether it is plaintext or HTML. + * @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. - * 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. + * `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`. */ getSelectedDataAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * * If there is no selection but the cursor is in the body or subject, the method returns an empty string for the selected data. - * If a field other than the body or subject is selected, the method returns the InvalidSelection error. + * If a field other than the body or subject is selected, the method returns the `InvalidSelection` error. * - * To access the selected data from the callback method, call asyncResult.value.data. - * To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject. + * To access the selected data from the callback method, call `asyncResult.value.data`. + * To access the `source` property that the selection comes from, call `asyncResult.value.sourceProperty`, which will be either `body` or `subject`. * * [Api set: Mailbox 1.2] * * @returns - * The selected data as a string with format determined by coercionType. + * The selected data as a string with format determined by `coercionType`. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * If HTML, the method returns the selected text, whether it is plaintext or HTML. - * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. + * @param coercionType - Requests a format for the data. If `Text`, the method returns the plain text as a string, removing any HTML tags present. + * If `HTML`, the method returns the selected text, whether it is plaintext or HTML. + * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter + * of type `Office.AsyncResult`. */ getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -9774,14 +9797,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * @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. + * `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`. * The `value` property of the result is the properties of the shared item. */ getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; @@ -9794,12 +9817,12 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * type Office.AsyncResult. + * type `Office.AsyncResult`. * The `value` property of the result is the properties of the shared item. */ getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void): void; @@ -9807,29 +9830,29 @@ declare namespace Office { * Asynchronously loads custom properties for this add-in on the selected item. * * Custom properties are stored as key/value pairs on a per-app, per-item basis. - * This method returns a CustomProperties object in the callback, which provides methods to access the custom properties specific to the + * This method returns a `CustomProperties` object in the callback, which provides methods to access the custom properties specific to the * current item and the current add-in. Custom properties are not encrypted on the item, so this should not be used as secure storage. * - * The custom properties are provided as a CustomProperties object in the asyncResult.value property. + * The custom properties are provided as a `CustomProperties` object in the `asyncResult.value` property. * This object can be used to get, set, and remove custom properties from the item and save changes to the custom property set back to * the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * 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`. * @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. + * This object can be accessed by the `asyncResult.asyncContext` property in the callback function. */ loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any): void; /** * Removes an attachment from a message or appointment. * - * The removeAttachmentAsync method removes the attachment with the specified identifier from the item. + * The `removeAttachmentAsync` method removes the attachment with the specified identifier from the item. * As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment * in the same session. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session. * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to @@ -9839,25 +9862,26 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: 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. - * 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. - * If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + * `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`. + * 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?: (asyncResult: Office.AsyncResult) => void): void; /** * Removes an attachment from a message or appointment. * - * The removeAttachmentAsync method removes the attachment with the specified identifier from the item. + * The `removeAttachmentAsync` method removes the attachment with the specified identifier from the item. * As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment * in the same session. * In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session. @@ -9868,18 +9892,18 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: 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 Office.AsyncResult. - * If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + * @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?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -9891,15 +9915,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * @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. + * `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. */ removeHandlerAsync(eventType: Office.EventType | string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -9911,96 +9935,98 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 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 | string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. * - * When invoked, this method saves the current message as a draft and returns the item id via the callback method. + * When invoked, this method saves the current message as a draft and returns the item ID via the callback method. * In Outlook on the web or Outlook in online mode, the item is saved to the server. * In Outlook in cached mode, the item is saved to the local cache. * - * Since appointments have no draft state, if saveAsync is called on an appointment in compose mode, the item will be saved as a normal + * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item will be saved as a normal * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. * Saving an existing appointment will send an update to added or removed attendees. * - * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that - * when Outlook is in cached mode, it may take some time before the item is actually synced to the server. - * Until the item is synced, using the itemId will return an error. + * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware + * that when Outlook is in cached mode, it may take some time before the item is actually synced to the server. + * Until the item is synced, using the item ID will return an error. * - * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode: + * **Note**: The following clients have different behavior for `saveAsync` on appointments in compose mode: * * - In Outlook on Mac, only preview build 16.35.205.0 or later with an Office 365 subscription supports saving a meeting. - * Otherwise, the saveAsync method fails when called from a meeting in compose mode. + * Otherwise, the `saveAsync` method fails when called from a meeting in compose mode. * For a workaround, see {@link https://support.microsoft.com/help/4505745 | Cannot save a meeting as a draft in Outlook for Mac by using Office JS API}. * - * - Outlook on the web always sends an invitation or update when saveAsync is called on an appointment in compose mode. + * - Outlook on the web always sends an invitation or update when `saveAsync` is called on an appointment in compose mode. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * * @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. + * `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`. */ saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. * - * When invoked, this method saves the current message as a draft and returns the item id via the callback method. + * When invoked, this method saves the current message as a draft and returns the item ID via the callback method. * In Outlook on the web or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache. * - * Since appointments have no draft state, if saveAsync is called on an appointment in compose mode, the item will be saved as a normal + * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item will be saved as a normal * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. * Saving an existing appointment will send an update to added or removed attendees. * - * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that + * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware that * when Outlook is in cached mode, it may take some time before the item is actually synced to the server. - * Until the item is synced, using the itemId will return an error. + * Until the item is synced, using the item ID will return an error. * - * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode: + * **Note**: The following clients have different behavior for `saveAsync` on appointments in compose mode: * * - In Outlook on Mac, only preview build 16.35.205.0 or later with an Office 365 subscription supports saving a meeting. - * Otherwise, the saveAsync method fails when called from a meeting in compose mode. + * Otherwise, the `saveAsync` method fails when called from a meeting in compose mode. * For a workaround, see {@link https://support.microsoft.com/help/4505745 | Cannot save a meeting as a draft in Outlook for Mac by using Office JS API}. * - * - Outlook on the web always sends an invitation or update when saveAsync is called on an appointment in compose mode. + * - Outlook on the web always sends an invitation or update when `saveAsync` is called on an appointment in compose mode. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * - * @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`. */ saveAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * - * The setSelectedDataAsync method inserts the specified string at the cursor location in the subject or body of the item, or, if text is + * The `setSelectedDataAsync` method inserts the specified string at the cursor location in the subject or body of the item, or, if text is * selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. * After insertion, the cursor is placed at the end of the inserted content. * @@ -10008,63 +10034,63 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * * @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. + * 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. - * asyncContext: Developers can provide any object they wish to access in the callback method. - * coercionType: If text, the current style is applied in Outlook on the web and Windows. + * `asyncContext`: Developers can provide any object they wish to access in the callback method. + * `coercionType`: If text, the current style is applied in Outlook on the web and Windows. * If the field is an HTML editor, only the text data is inserted, even if the data is HTML. * If html and the field supports HTML (the subject doesn't), the current style is applied in Outlook on the web and the * default style is applied in Outlook on desktop clients. - * 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 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 - * 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`. */ setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * - * The setSelectedDataAsync method inserts the specified string at the cursor location in the subject or body of the item, or, if text is - * selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. + * The `setSelectedDataAsync` method inserts the specified string at the cursor location in the subject or body of the item, or, if text is + * selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. * After insertion, the cursor is placed at the end of the inserted content. * * [Api set: Mailbox 1.2] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * * @param data - The data to be inserted. Data is not to exceed 1,000,000 characters. - * If more than 1,000,000 characters are passed in, an ArgumentOutOfRange exception is thrown. - * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. + * If more than 1,000,000 characters are passed in, an `ArgumentOutOfRange` exception is thrown. + * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of + * type `Office.AsyncResult`. */ setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void): void; } /** - * The AppointmentForm namespace is used to access the currently selected appointment. + * The `AppointmentForm` object is used to access the currently selected appointment. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface AppointmentForm { /** @@ -10074,33 +10100,33 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ body: Body | string; /** * Gets or sets the date and time that the appointment is to end. * - * The end property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the convertToLocalClientTime method to - * convert the end property value to the client's local date and time. + * The `end` property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the `convertToLocalClientTime` method to + * convert the `end` property value to the client's local date and time. * * *Read mode* * - * The end property returns a Date object. + * The `end` property returns a `Date` object. * * *Compose mode* * - * The end property returns a Time object. + * The `end` property returns a `Time` object. * - * When you use the Time.setAsync method to set the end time, you should use the convertToUtcClientTime method to convert the local time on + * When you use the `Time.setAsync` method to set the end time, you should use the `convertToUtcClientTime` method to convert the local time on * the client to UTC for the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ end: Time | Date; /** @@ -10108,17 +10134,17 @@ declare namespace Office { * * *Read mode* * - * The location property returns a string that contains the location of the appointment. + * The `location` property returns a string that contains the location of the appointment. * * *Compose mode* * - * The location property returns a Location object that provides methods that are used to get and set the location of the appointment. + * The `location` property returns a `Location` object that provides methods that are used to get and set the location of the appointment. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ location: Location | string; /** @@ -10126,12 +10152,12 @@ declare namespace Office { * * *Read mode* * - * The optionalAttendees property returns an array that contains an EmailAddressDetails object for each optional attendee to the meeting. + * The `optionalAttendees` property returns an array that contains an `EmailAddressDetails` object for each optional attendee to the meeting. * By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, you can get 500 members maximum. * * *Compose mode* * - * The optionalAttendees property returns a Recipients object that provides methods to get or update the optional attendees for a meeting. + * The `optionalAttendees` property returns a `Recipients` object that provides methods to get or update the optional attendees for a meeting. * By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, the following limits apply. * * - Get 500 members maximum. @@ -10140,9 +10166,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ optionalAttendees: Recipients[] | EmailAddressDetails[]; /** @@ -10150,9 +10176,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ resources: string[]; /** @@ -10160,12 +10186,12 @@ declare namespace Office { * * *Read mode* * - * The requiredAttendees property returns an array that contains an EmailAddressDetails object for each required attendee to the meeting. + * The `requiredAttendees` property returns an array that contains an `EmailAddressDetails` object for each required attendee to the meeting. * By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, you can get 500 members maximum. * * *Compose mode* * - * The requiredAttendees property returns a Recipients object that provides methods to get or update the required attendees for a meeting. + * The `requiredAttendees` property returns a `Recipients` object that provides methods to get or update the required attendees for a meeting. * By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, the following limits apply. * * - Get 500 members maximum. @@ -10174,53 +10200,53 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ requiredAttendees: Recipients[] | EmailAddressDetails[]; /** * Gets or sets the date and time that the appointment is to begin. * - * The start property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the convertToLocalClientTime method + * The `start` property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the `convertToLocalClientTime` method * to convert the value to the client's local date and time. * * *Read mode* * - * The start property returns a Date object. + * The `start` property returns a `Date` object. * * *Compose mode* * - * The start property returns a Time object. + * The `start` property returns a `Time` object. * - * When you use the Time.setAsync method to set the start time, you should use the convertToUtcClientTime method to convert the local time on + * When you use the `Time.setAsync` method to set the start time, you should use the `convertToUtcClientTime` method to convert the local time on * the client to UTC for the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ start: Time | Date; /** * Gets or sets the description that appears in the subject field of an item. * - * The subject property gets or sets the entire subject of the item, as sent by the email server. + * The `subject` property gets or sets the entire subject of the item, as sent by the email server. * * *Read mode* * - * The subject property returns a string. Use the normalizedSubject property to get the subject minus any leading prefixes such as RE: and FW:. + * The `subject` property returns a string. Use the `normalizedSubject` property to get the subject minus any leading prefixes such as RE: and FW:. * * *Compose mode* * - * The subject property returns a Subject object that provides methods to get and set the subject. + * The `subject` property returns a `Subject` object that provides methods to get and set the subject. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ subject: Subject | string; } @@ -10228,7 +10254,7 @@ declare namespace Office { * The appointment attendee mode of {@link Office.Item | Office.context.mailbox.item}. * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. - * You should treat this as a mode of Office.context.mailbox.item. Refer to the + * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information. * * Parent interfaces: @@ -10243,9 +10269,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee * * **Note**: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned. For more information, see * {@link https://support.office.com/article/Blocked-attachments-in-Outlook-434752E1-02D3-4E90-9124-8B81E49A8519 | Blocked attachments in Outlook}. @@ -10259,9 +10285,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ body: Body; /** @@ -10271,9 +10297,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ categories: Categories; /** @@ -10281,9 +10307,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ dateTimeCreated: Date; /** @@ -10293,54 +10319,54 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ dateTimeModified: Date; /** * Gets the date and time that the appointment is to end. * - * The end property is a Date object expressed as a Coordinated Universal Time (UTC) date and time value. - * You can use the convertToLocalClientTime method to convert the end property value to the client's local date and time. + * The `end` property is a `Date` object expressed as a Coordinated Universal Time (UTC) date and time value. + * You can use the `convertToLocalClientTime` method to convert the `end` property value to the client's local date and time. * - * When you use the Time.setAsync method to set the end time, you should use the convertToUtcClientTime method to convert the local time on + * When you use the `Time.setAsync` method to set the end time, you should use the `convertToUtcClientTime` method to convert the local time on * the client to UTC for the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ end: Date; /** * Gets the locations of an appointment. * - * The enhancedLocation property returns an {@link Office.EnhancedLocation | EnhancedLocation} object that allows you to get the set of locations + * The `enhancedLocation` property returns an {@link Office.EnhancedLocation | EnhancedLocation} object that allows you to get the set of locations * (each represented by a {@link Office.LocationDetails | LocationDetails} object) associated with the appointment. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ enhancedLocation: EnhancedLocation; /** * Gets the Exchange Web Services item class of the selected item. * - * You can create custom message classes that extends a default message class, for example, a custom appointment message class IPM.Appointment.Contoso. + * You can create custom message classes that extends a default message class, for example, a custom appointment message class `IPM.Appointment.Contoso`. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee * - * The itemClass property specifies the message class of the selected item. The following are the default message classes for the message or appointment item. + * The `itemClass` property specifies the message class of the selected item. The following are the default message classes for the message or appointment item. * * * @@ -10366,58 +10392,58 @@ declare namespace Office { * Gets the {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services item identifier} * for the current item. * - * 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. + * 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. * - * **Note**: The identifier returned by the itemId property is the same as the + * **Note**: The identifier returned by the `itemId` property is the same as the * {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | 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. - * Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId. - * For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api#get-the-item-id | Use the Outlook REST APIs from an Outlook add-in}. + * The `itemId` property is not identical to the Outlook Entry ID or the ID used by the Outlook REST API. + * Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`. + * For more details, see {@link https://docs.microsoft.com/office/dev/add-ins/outlook/use-rest-api#get-the-item-id | Use the Outlook REST APIs from an Outlook add-in}. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ itemId: string; /** * Gets the type of item that an instance represents. * - * The itemType property returns one of the ItemType enumeration values, indicating whether the item object instance is a message or an appointment. + * The `itemType` property returns one of the `ItemType` enumeration values, indicating whether the item object instance is a message or an appointment. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ itemType: MailboxEnums.ItemType | string; /** * Gets the location of an appointment. * - * The location property returns a string that contains the location of the appointment. + * The `location` property returns a string that contains the location of the appointment. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ location: string; /** * Gets the subject of an item, with all prefixes removed (including RE: and FWD:). * - * The normalizedSubject property gets the subject of the item, with any standard prefixes (such as RE: and FW:) that are added by email programs. - * To get the subject of the item with the prefixes intact, use the subject property. + * The `normalizedSubject` property gets the subject of the item, with any standard prefixes (such as RE: and FW:) that are added by email programs. + * To get the subject of the item with the prefixes intact, use the `subject` property. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ normalizedSubject: string; /** @@ -10427,22 +10453,22 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ 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 array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for each optional attendee to + * The `optionalAttendees` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for each optional attendee to * the meeting. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, you can get 500 members maximum. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ optionalAttendees: EmailAddressDetails[]; /** @@ -10450,18 +10476,18 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ organizer: EmailAddressDetails; /** * Gets the recurrence pattern of an appointment. Gets the recurrence pattern of a meeting request. * - * The recurrence property returns a recurrence object for recurring appointments or meetings requests if an item is a series or an instance - * in a series. `null` is returned for single appointments and meeting requests of single appointments. + * The `recurrence` property returns a {@link Office.Recurrence | Recurrence} object for recurring appointments or meetings requests + * if an item is a series or an instance in a series. `null` is returned for single appointments and meeting requests of single appointments. * - * **Note**: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request. + * **Note**: Meeting requests have an `itemClass` value of `IPM.Schedule.Meeting.Request`. * * **Note**: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single * appointment and NOT a part of a series. @@ -10470,72 +10496,73 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ recurrence: Recurrence; /** * Provides access to the required attendees of an event. The type of object and level of access depends on the mode of the current item. * - * The requiredAttendees property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for each required attendee to - * the meeting. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, you can get 500 members maximum. + * The `requiredAttendees` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object + * for each required attendee to the meeting. By default, the collection is limited to a maximum of 100 members. + * However, on Windows and Mac, you can get 500 members maximum. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ requiredAttendees: EmailAddressDetails[]; /** * Gets the date and time that the appointment is to begin. * - * The start property is a Date object expressed as a Coordinated Universal Time (UTC) date and time value. - * You can use the convertToLocalClientTime method to convert the value to the client's local date and time. + * The `start` property is a `Date` object expressed as a Coordinated Universal Time (UTC) date and time value. + * You can use the `convertToLocalClientTime` method to convert the value to the client's local date and time. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ start: Date; /** - * Gets the id of the series that an instance belongs to. + * Gets the ID of the series that an instance belongs to. * - * In Outlook on the web and desktop clients, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to. - * However, on iOS and Android, the seriesId returns the REST ID of the parent item. + * In Outlook on the web and desktop clients, the `seriesId` returns the Exchange Web Services (EWS) ID of the parent (series) item + * that this item belongs to. However, on iOS and Android, the seriesId returns the REST ID of the parent item. * - * **Note**: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier. - * The seriesId property is not identical to the Outlook IDs used by the Outlook REST API. Before making REST API calls using this value, it - * should be converted using Office.context.mailbox.convertToRestId. - * For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. + * **Note**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier. + * The `seriesId` property is not identical to the Outlook IDs used by the Outlook REST API. Before making REST API calls using this value, it + * should be converted using `Office.context.mailbox.convertToRestId`. + * For more details, see {@link https://docs.microsoft.com/office/dev/add-ins/outlook/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. * - * The seriesId property returns null for items that do not have parent items such as single appointments, series items, or meeting requests - * and returns undefined for any other items that are not meeting requests. + * The `seriesId` property returns `null` for items that do not have parent items such as single appointments, series items, or meeting requests + * and returns `undefined` for any other items that are not meeting requests. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ seriesId: string; /** * Gets the description that appears in the subject field of an item. * - * The subject property gets or sets the entire subject of the item, as sent by the email server. + * The `subject` property gets or sets the entire subject of the item, as sent by the email server. * - * The subject property returns a string. Use the normalizedSubject property to get the subject minus any leading prefixes such as RE: and FW:. + * The `subject` property returns a string. Use the `normalizedSubject` property to get the subject minus any leading prefixes such as RE: and FW:. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ subject: string; @@ -10548,17 +10575,17 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * The type property on the parameter will match the eventType parameter passed to addHandlerAsync. + * 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. - * 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. + * `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. */ addHandlerAsync(eventType: Office.EventType | string, handler: any, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -10570,15 +10597,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * 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. + * 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. */ addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -10587,24 +10614,24 @@ declare namespace Office { * * In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2- or 1-column view. * - * If any of the string parameters exceed their limits, displayReplyAllForm throws an exception. + * If any of the string parameters exceed their limits, `displayReplyAllForm` throws an exception. * - * When attachments are specified in the formData.attachments parameter, Outlook on the web and desktop clients attempt to download all attachments and - * attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. + * When attachments are specified in the `formData.attachments` parameter, Outlook on the web and desktop clients attempt to download + * all attachments and attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. * If this isn't possible, then no error message is thrown. * * **Note**: This method is not supported in Outlook on iOS or Android. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. - * @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. */ displayReplyAllForm(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -10612,28 +10639,28 @@ declare namespace Office { * * In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2- or 1-column view. * - * If any of the string parameters exceed their limits, displayReplyForm throws an exception. + * If any of the string parameters exceed their limits, `displayReplyForm` throws an exception. * - * When attachments are specified in the formData.attachments parameter, Outlook on the web and desktop clients attempt to download all attachments and - * attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. + * When attachments are specified in the `formData.attachments` parameter, Outlook on the web and desktop clients attempt to download + * all attachments and attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. * If this isn't possible, then no error message is thrown. * * **Note**: This method is not supported in Outlook on iOS or Android. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. - * @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. */ displayReplyForm(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void): void; /** - * Gets an attachment from a message or appointment and returns it as an **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 @@ -10645,27 +10672,27 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee * * **Errors**: * - * - AttachmentTypeNotSupported: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, + * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, * or item attachment types other than email or calendar items (such as a contact or task item). * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: 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. - * 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 - * with the reason for the failure. + * `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 + * an error code with the reason for the failure. */ getAttachmentContentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** - * Gets an attachment from a message or appointment and returns it as an **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 @@ -10677,44 +10704,44 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee * * **Errors**: * - * - AttachmentTypeNotSupported: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, + * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, * or item attachment types other than email or calendar items (such as a contact or task item). * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * * @param attachmentId - The identifier of the attachment you want to get. - * @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. + * @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 + * an error code with the reason for the failure. */ getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: 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}. * - * **Note**: This method is only supported by Outlook 2016 or later on Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web - * for Office 365. + * **Note**: This method is only supported by Outlook 2016 or later on Windows (Click-to-Run versions greater than 16.0.8413.1000) + * and Outlook on the web for Office 365. * * [Api set: Mailbox Preview] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee * * @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. - * 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. + * `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. + * 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 */ @@ -10722,21 +10749,22 @@ declare namespace Office { /** * 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}. * - * **Note**: This method is only supported by Outlook 2016 or later on Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web for Office 365. + * **Note**: This method is only supported by Outlook 2016 or later on Windows (Click-to-Run versions greater than 16.0.8413.1000) + * and Outlook on the web for Office 365. * * [Api set: Mailbox Preview] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * 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. + * `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 */ @@ -10748,9 +10776,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ getEntities(): Entities; /** @@ -10758,20 +10786,20 @@ declare namespace Office { * * **Note**: This method is not supported in Outlook on iOS or Android. * - * @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. + * If the value passed in `entityType` is not a valid member of the `EntityType` enumeration, the method returns null. * If no entities of the specified type are present in the item's body, the method returns an empty array. - * Otherwise, the type of the objects in the returned array depends on the type of entity requested in the entityType parameter. + * Otherwise, the type of the objects in the returned array depends on the type of entity requested in the `entityType` parameter. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * @param entityType - One of the `EntityType` enumeration values. * - * While the minimum permission level to use this method is Restricted, some entity types require ReadItem to access, as specified in the following table. + * While the minimum permission level to use this method is `Restricted`, some entity types require `ReadItem` to access, as specified in the following table. * *
* @@ -10820,58 +10848,59 @@ declare namespace Office { /** * Returns well-known entities in the selected item that pass the named filter defined in the manifest XML file. * - * The getFilteredEntitiesByName method returns the entities that match the regular expression defined in the ItemHasKnownEntity rule element - * in the manifest XML file with the specified FilterName element value. + * The `getFilteredEntitiesByName` method returns the entities that match the regular expression defined in the `ItemHasKnownEntity` rule element + * in the manifest XML file with the specified `FilterName` element value. * * **Note**: This method is not supported in Outlook on iOS or Android. + * + * @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 matches an `ItemHasKnownEntity` element in the manifest, but there are no entities in the current item that match, + * the method return an empty array. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee * - * @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, - * the method return an empty array. + * @param name - The name of the `ItemHasKnownEntity` rule element that defines the filter to match. */ getFilteredEntitiesByName(name: string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; /** * Returns string values in the selected item that match the regular expressions defined in the manifest XML file. * - * The getRegExMatches method returns the strings that match the regular expression defined in each ItemHasRegularExpressionMatch or - * ItemHasKnownEntity rule element in the manifest XML file. - * For an ItemHasRegularExpressionMatch rule, a matching string has to occur in the property of the item that is specified by that rule. - * The PropertyName simple type defines the supported properties. + * The `getRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or + * `ItemHasKnownEntity` rule element in the manifest XML file. + * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that is specified by that rule. + * The `PropertyName` simple type defines the supported properties. * - * If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body + * If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body * and should not attempt to return the entire body of the item. * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. - * Instead, use the Body.getAsync method to retrieve the entire body. + * Instead, use the `Body.getAsync` method to retrieve the entire body. * * **Note**: This method is not supported in Outlook on iOS or Android. * * @returns * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file. - * The name of each array is equal to the corresponding value of the RegExName attribute of the matching ItemHasRegularExpressionMatch rule - * or the FilterName attribute of the matching ItemHasKnownEntity rule. + * The name of each array is equal to the corresponding value of the RegExName attribute of the matching `ItemHasRegularExpressionMatch` rule + * or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ getRegExMatches(): any; /** * Returns string values in the selected item that match the named regular expression defined in the manifest XML file. * - * The getRegExMatchesByName method returns the strings that match the regular expression defined in the ItemHasRegularExpressionMatch rule - * element in the manifest XML file with the specified RegExName element value. + * The `getRegExMatchesByName` method returns the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule + * element in the manifest XML file with the specified `RegExName` element value. * - * If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body + * If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body * and should not attempt to return the entire body of the item. * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. * @@ -10882,11 +10911,11 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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[]; /** @@ -10898,41 +10927,41 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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; /** * Returns string values in a highlighted match that match the regular expressions defined in the manifest XML file. * Highlighted matches apply to contextual add-ins. * - * The getSelectedRegExMatches method returns the strings that match the regular expression defined in each ItemHasRegularExpressionMatch or - * ItemHasKnownEntity rule element in the manifest XML file. - * For an ItemHasRegularExpressionMatch rule, a matching string has to occur in the property of the item that is specified by that rule. - * The PropertyName simple type defines the supported properties. + * The `getSelectedRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or + * `ItemHasKnownEntity` rule element in the manifest XML file. + * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that is specified by that rule. + * The `PropertyName` simple type defines the supported properties. * - * If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body - * and should not attempt to return the entire body of the item. - * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. - * Instead, use the Body.getAsync method to retrieve the entire body. + * If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body + * and should not attempt to return the entire body of the item. + * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. + * Instead, use the `Body.getAsync` method to retrieve the entire body * * **Note**: This method is not supported in Outlook on iOS or Android. * * [Api set: Mailbox 1.6] * * @returns - * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file. - * The name of each array is equal to the corresponding value of the RegExName attribute of the matching ItemHasRegularExpressionMatch rule - * or the FilterName attribute of the matching ItemHasKnownEntity rule. + * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file. + * The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule + * or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ getSelectedRegExMatches(): any; /** @@ -10944,14 +10973,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee * * @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. + * `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`. * The `value` property of the result is the properties of the shared item. */ getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; @@ -10964,36 +10993,36 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * 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`. * The `value` property of the result is the properties of the shared item. */ getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously loads custom properties for this add-in on the selected item. * - * Custom properties are stored as key/value pairs on a per-app, per-item basis. - * This method returns a CustomProperties object in the callback, which provides methods to access the custom properties specific to the + * Custom properties are stored as key/value pairs on a per-app, per-item basis. + * This method returns a `CustomProperties` object in the callback, which provides methods to access the custom properties specific to the * current item and the current add-in. Custom properties are not encrypted on the item, so this should not be used as secure storage. * - * The custom properties are provided as a CustomProperties object in the asyncResult.value property. - * This object can be used to get, set, and remove custom properties from the item and save changes to the custom property set back to + * The custom properties are provided as a `CustomProperties` object in the asyncResult.value property. + * This object can be used to get, set, and remove custom properties from the item and save changes to the custom property set back to * the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * type Office.AsyncResult. - * @param userContext - Optional. Developers can provide any object they wish to access in the callback function. - * This object can be accessed by the asyncResult.asyncContext property in the callback function. + * @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. + * This object can be accessed by the `asyncResult.asyncContext` property in the callback function. */ loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any): void; /** @@ -11005,15 +11034,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee * * @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. + * `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. */ removeHandlerAsync(eventType: Office.EventType | string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -11025,13 +11054,13 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 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 | string, callback?: (asyncResult: Office.AsyncResult) => void): void; } @@ -11067,9 +11096,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface AttachmentContent { /** @@ -11096,13 +11125,13 @@ declare namespace Office { /** * Represents an attachment on an item from the server. Read mode only. * - * An array of **AttachmentDetails** objects is returned as the attachments property of an appointment or message item. + * An array of `AttachmentDetails` objects is returned as the attachments property of an appointment or message item. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read */ interface AttachmentDetails { /** @@ -11173,55 +11202,55 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface Body { /** * Returns the current body in a specified format. * - * This method returns the entire current body in the format specified by coercionType. + * This method returns the entire current body in the format specified by `coercionType`. * - * When working with HTML-formatted bodies, it is important to note that the Body.getAsync and Body.setAsync methods are not idempotent. - * The value returned from the getAsync method will not necessarily be exactly the same as the value that was passed in the setAsync method previously. - * The client may modify the value passed to setAsync in order to make it render efficiently with its rendering engine. + * When working with HTML-formatted bodies, it is important to note that the `Body.getAsync` and `Body.setAsync` methods are not idempotent. + * The value returned from the `getAsync` method will not necessarily be exactly the same as the value that was passed in the `setAsync` method previously. + * The client may modify the value passed to `setAsync` in order to make it render efficiently with its rendering engine. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * @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 Office.AsyncResult. - * The body is provided in the requested format in the asyncResult.value property. + * `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. The body is provided in the requested format in the `asyncResult.value` property. */ getAsync(coercionType: Office.CoercionType | string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Returns the current body in a specified format. * - * This method returns the entire current body in the format specified by coercionType. + * This method returns the entire current body in the format specified by `coercionType`. * - * When working with HTML-formatted bodies, it is important to note that the Body.getAsync and Body.setAsync methods are not idempotent. - * The value returned from the getAsync method will not necessarily be exactly the same as the value that was passed in the setAsync method previously. - * The client may modify the value passed to setAsync in order to make it render efficiently with its rendering engine. + * When working with HTML-formatted bodies, it is important to note that the `Body.getAsync` and `Body.setAsync` methods are not idempotent. + * The value returned from the `getAsync` method will not necessarily be exactly the same as the value that was passed in the `setAsync` method previously. + * The client may modify the value passed to `setAsync` in order to make it render efficiently with its rendering engine. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * The body is provided in the requested format in the asyncResult.value property. + * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter + * of type Office.AsyncResult. The body is provided in the requested format in the `asyncResult.value` property. */ getAsync(coercionType: Office.CoercionType | string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -11231,14 +11260,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. - * The content type is returned as one of the CoercionType values in the asyncResult.value property. + * `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`. + * The content type is returned as one of the `CoercionType` values in the `asyncResult.value` property. */ getTypeAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -11248,189 +11278,190 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * - * @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. + * @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(callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds the specified content to the beginning of the item body. * - * The prependAsync method inserts the specified string at the beginning of the item body. + * The `prependAsync` method inserts the specified string at the beginning of the item body. * After insertion, the cursor is returned to its original place, relative to the inserted content. * - * When including links in HTML markup, you can disable online link preview by setting the id attribute on the anchor (\) to "LPNoLP" - * (please see the Examples section for a sample). + * When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\) to "LPNoLP" + * (see the **Examples** section for a sample). * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - DataExceedsMaximumSize: The data parameter is longer than 1,000,000 characters. + * - `DataExceedsMaximumSize`: 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. - * 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. - * Any errors encountered will be provided in the asyncResult.error property. + * `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`. Any errors encountered will be provided in the `asyncResult.error` property. */ prependAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds the specified content to the beginning of the item body. * - * The prependAsync method inserts the specified string at the beginning of the item body. + * The `prependAsync` method inserts the specified string at the beginning of the item body. * After insertion, the cursor is returned to its original place, relative to the inserted content. * - * When including links in HTML markup, you can disable online link preview by setting the id attribute on the anchor (\) to "LPNoLP" - * (please see the Examples section for a sample). + * When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\) to "LPNoLP" + * (see the **Examples** section for a sample). * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - DataExceedsMaximumSize: The data parameter is longer than 1,000,000 characters. + * - `DataExceedsMaximumSize`: 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. - * Any errors encountered will be provided in the asyncResult.error property. + * @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?: (asyncResult: Office.AsyncResult) => void): void; /** * Replaces the entire body with the specified text. * - * When working with HTML-formatted bodies, it is important to note that the Body.getAsync and Body.setAsync methods are not idempotent. - * The value returned from the getAsync method will not necessarily be exactly the same as the value that was passed in the setAsync method - * previously. The client may modify the value passed to setAsync in order to make it render efficiently with its rendering engine. + * When working with HTML-formatted bodies, it is important to note that the `Body.getAsync` and `Body.setAsync` methods are not idempotent. + * The value returned from the `getAsync` method will not necessarily be exactly the same as the value that was passed in the `setAsync` method + * previously. The client may modify the value passed to `setAsync` in order to make it render efficiently with its rendering engine. * - * When including links in HTML markup, you can disable online link preview by setting the id attribute on the anchor (\) to "LPNoLP" - * (please see the Examples section for a sample). + * When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\) to "LPNoLP" + * (see the **Examples** section for a sample). * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - DataExceedsMaximumSize: The data parameter is longer than 1,000,000 characters. + * - `DataExceedsMaximumSize`: 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. + * - `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. - * 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. - * Any errors encountered will be provided in the asyncResult.error property. + * `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. Any errors encountered will be provided in the `asyncResult.error` property. */ setAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Replaces the entire body with the specified text. * - * When working with HTML-formatted bodies, it is important to note that the Body.getAsync and Body.setAsync methods are not idempotent. - * The value returned from the getAsync method will not necessarily be exactly the same as the value that was passed in the setAsync method - * previously. The client may modify the value passed to setAsync in order to make it render efficiently with its rendering engine. + * When working with HTML-formatted bodies, it is important to note that the `Body.getAsync` and `Body.setAsync` methods are not idempotent. + * The value returned from the `getAsync` method will not necessarily be exactly the same as the value that was passed in the `setAsync` method + * previously. The client may modify the value passed to `setAsync` in order to make it render efficiently with its rendering engine. * - * When including links in HTML markup, you can disable online link preview by setting the id attribute on the anchor (\) to "LPNoLP" - * (please see the Examples section for a sample). + * When including links in HTML markup, you can disable online link preview by setting the id attribute on the anchor (\) to "LPNoLP" + * (see the **Examples** section for a sample). * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - DataExceedsMaximumSize: The data parameter is longer than 1,000,000 characters. + * - `DataExceedsMaximumSize`: 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. + * - `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. - * Any errors encountered will be provided in the asyncResult.error property. + * @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?: (asyncResult: Office.AsyncResult) => void): void; /** * Replaces the selection in the body with the specified text. * - * The setSelectedDataAsync method inserts the specified string at the cursor location in the body of the item, or, if text is selected in - * the editor, it replaces the selected text. If the cursor was never in the body of the item, or if the body of the item lost focus in the + * The `setSelectedDataAsync` method inserts the specified string at the cursor location in the body of the item, or, if text is selected in + * the editor, it replaces the selected text. If the cursor was never in the body of the item, or if the body of the item lost focus in the * UI, the string will be inserted at the top of the body content. After insertion, the cursor is placed at the end of the inserted content. * - * When including links in HTML markup, you can disable online link preview by setting the id attribute on the anchor (\) to "LPNoLP" - * (please see the Examples section for a sample). + * When including links in HTML markup, you can disable online link preview by setting the id attribute on the anchor (\) to "LPNoLP" + * (see the **Examples** section for a sample). * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - DataExceedsMaximumSize: The data parameter is longer than 1,000,000 characters. + * - `DataExceedsMaximumSize`: 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. + * - `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. - * 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. - * Any errors encountered will be provided in the asyncResult.error property. + * `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`. Any errors encountered will be provided in the `asyncResult.error` property. */ setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Replaces the selection in the body with the specified text. * - * The setSelectedDataAsync method inserts the specified string at the cursor location in the body of the item, or, if text is selected in - * the editor, it replaces the selected text. If the cursor was never in the body of the item, or if the body of the item lost focus in the + * The `setSelectedDataAsync` method inserts the specified string at the cursor location in the body of the item, or, if text is selected in + * the editor, it replaces the selected text. If the cursor was never in the body of the item, or if the body of the item lost focus in the * UI, the string will be inserted at the top of the body content. After insertion, the cursor is placed at the end of the inserted content. * - * When including links in HTML markup, you can disable online link preview by setting the id attribute on the anchor (\) to "LPNoLP" - * (please see the Examples section for a sample). + * When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\) to "LPNoLP" + * (see the **Examples** section for a sample). * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - DataExceedsMaximumSize: The data parameter is longer than 1,000,000 characters. + * - `DataExceedsMaximumSize`: 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. + * - `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. - * Any errors encountered will be provided in the asyncResult.error property. + * @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?: (asyncResult: Office.AsyncResult) => void): void; } @@ -11447,119 +11478,119 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface Categories { /** * Adds categories to an item. Each category must be in the categories master list on that mailbox and so must have a unique name * but multiple categories can use the same color. * - * @param categories - The categories to be added to the item. - * @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. - * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * **Errors**: * - * - InvalidCategory: Invalid categories were provided. + * - `InvalidCategory`: Invalid categories were provided. + * + * @param categories - The categories to be added to the item. + * @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`. */ addAsync(categories: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds categories to an item. Each category must be in the categories master list on that mailbox and so must have a unique name * but multiple categories can use the same color. * - * @param categories - The categories to be added to the item. - * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. If adding categories fails, the asyncResult.error property will contain an error code. - * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * **Errors**: * - * - InvalidCategory: Invalid categories were provided. + * - `InvalidCategory`: Invalid categories were provided. + * + * @param categories - The categories to be added to the item. + * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of + * type `Office.AsyncResult`. If adding categories fails, the `asyncResult.error` property will contain an error code. */ addAsync(categories: string[], callback: (asyncResult: Office.AsyncResult) => void): void; /** * Gets an item's categories. * - * @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. If adding categories fails, the asyncResult.error property will contain an error code. - * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * @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`. If adding categories fails, the `asyncResult.error` property will contain an error code. */ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** * Gets an item's categories. * - * @param callback - 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.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 + * type `Office.AsyncResult`. */ getAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Removes categories from an item. * - * @param categories - The categories to be removed from the item. - * @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. If removing categories fails, the asyncResult.error property will contain an error code. - * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * @param categories - The categories to be removed from the item. + * @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`. If removing categories fails, the `asyncResult.error` property will contain an error code. */ removeAsync(categories: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Removes categories from an item. * - * @param categories - The categories to be removed from the item. - * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. If removing categories fails, the asyncResult.error property will contain an error code. - * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * @param categories - The categories to be removed from the item. + * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of + * type `Office.AsyncResult`. If removing categories fails, the `asyncResult.error` property will contain an error code. */ removeAsync(categories: string[], callback: (asyncResult: Office.AsyncResult) => void): void; } @@ -11570,9 +11601,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface CategoryDetails { /** @@ -11587,14 +11618,14 @@ declare namespace Office { /** * Represents the details about a contact (similar to what's on a physical contact or business card) extracted from the item's body. Read mode only. * - * The list of contacts extracted from the body of an email message or appointment is returned in the contacts property of the - * {@link Office.Entities | Entities} object returned by the getEntities or getEntitiesByType method of the current item. + * The list of contacts extracted from the body of an email message or appointment is returned in the `contacts` property of the + * {@link Office.Entities | Entities} object returned by the `getEntities` or `getEntitiesByType` method of the current item. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read */ interface Contact { /** @@ -11614,7 +11645,7 @@ declare namespace Office { */ personName: string; /** - * An array containing a PhoneNumber object for each phone number associated with the contact. Nullable. + * An array containing a `PhoneNumber` object for each phone number associated with the contact. Nullable. */ phoneNumbers: PhoneNumber[]; /** @@ -11623,147 +11654,150 @@ declare namespace Office { urls: string[]; } /** - * The CustomProperties object represents custom properties that are specific to a particular item and specific to a mail add-in for Outlook. + * The `CustomProperties` object represents custom properties that are specific to a particular item and specific to a mail add-in for Outlook. * For example, there might be a need for a mail add-in to save some data that is specific to the current email message that activated the add-in. * If the user revisits the same message in the future and activates the mail add-in again, the add-in will be able to retrieve the data that had - * been saved as custom properties. **Important**: The maximum length of a CustomProperties JSON object is 2500 characters. + * been saved as custom properties. **Important**: The maximum length of a `CustomProperties` JSON object is 2500 characters. * * Because Outlook on Mac doesn't cache custom properties, if the user's network goes down, mail add-ins cannot access their custom properties. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface CustomProperties { /** * Returns the value of the specified custom property. - * @param name - The name of the custom property to be returned. + * * @returns The value of the specified custom property. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * @param name - The name of the custom property to be returned. */ get(name: string): any; - /** - * Sets the specified property to the specified value. - * - * The set method sets the specified property to the specified value. You must use the saveAsync method to save the property to the server. - * - * The set method creates a new property if the specified property does not already exist; - * otherwise, the existing value is replaced with the new value. - * The value parameter can be of any type; however, it is always passed to the server as a string. - * - * @remarks - * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem - * - * **{@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. - */ - 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. + * To make the removal of the property permanent, you must call the `saveAsync` method of the `CustomProperties` object. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * @param name - The `name` of the property to be removed. */ remove(name: string): void; /** * Saves item-specific custom properties to the server. * - * You must call the saveAsync method to persist any changes made with the set method or the remove method of the CustomProperties object. + * You must call the `saveAsync` method to persist any changes made with the `set` method or the `remove` method of the `CustomProperties` object. * The saving action is asynchronous. * - * It's a good practice to have your callback function check for and handle errors from saveAsync. - * In particular, a read add-in can be activated while the user is in a connected state in a read form, and subsequently the user becomes + * It's a good practice to have your callback function check for and handle errors from `saveAsync`. + * In particular, a read add-in can be activated while the user is in a connected state in a read form, and subsequently the user becomes * disconnected. - * If the add-in calls saveAsync while in the disconnected state, saveAsync would return an error. + * 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 - * type Office.AsyncResult. - * @param asyncContext - Optional. Any state data that is passed to the callback method. - * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 asyncContext - Optional. Any state data that is passed to the callback method. */ saveAsync(callback?: (asyncResult: Office.AsyncResult) => void, asyncContext?: any): void; + /** + * Sets the specified property to the specified value. + * + * The `set` method sets the specified property to the specified value. You must use the `saveAsync` method to save the property to the server. + * + * The `set` method creates a new property if the specified property does not already exist; + * otherwise, the existing value is replaced with the new value. + * The `value` parameter can be of any type; however, it is always passed to the server as a string. + * + * @remarks + * + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` + * + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. + */ + set(name: string, value: string): void; } /** * Provides diagnostic information to an Outlook add-in. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface Diagnostics { /** * Gets a string that represents the name of the host application. * - * A string that can be one of the following values: "Outlook", "OutlookWebApp", "OutlookIOS", or "OutlookAndroid". + * A string that can be one of the following values: `Outlook`, `OutlookWebApp`, `OutlookIOS`, or `OutlookAndroid`. * - * **Note**: The "Outlook" value is returned for Outlook on desktop clients (i.e., Windows and Mac). + * **Note**: The `Outlook` value is returned for Outlook on desktop clients (i.e., Windows and Mac). * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ hostName: string; /** * Gets a string that represents the version of either the host application or the Exchange Server (e.g., "15.0.468.0"). * - * If the mail add-in is running in Outlook on a desktop or mobile client, the hostVersion property returns the version of the host + * If the mail add-in is running in Outlook on a desktop or mobile client, the `hostVersion` property returns the version of the host * application, Outlook. In Outlook on the web, the property returns the version of the Exchange Server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ hostVersion: string; /** * Gets a string that represents the current view of Outlook on the web. * - * The returned string can be one of the following values: "OneColumn", "TwoColumns", or "ThreeColumns". + * The returned string can be one of the following values: `OneColumn`, `TwoColumns`, or `ThreeColumns`. * * If the host application is not Outlook on the web, then accessing this property results in undefined. * * Outlook on the web has three views that correspond to the width of the screen and the window, and the number of columns that can be displayed: * - * - "OneColumn", which is displayed when the screen is narrow. Outlook on the web uses this single-column layout on the entire screen of a + * - `OneColumn`, which is displayed when the screen is narrow. Outlook on the web uses this single-column layout on the entire screen of a * smartphone. * - * - "TwoColumns", which is displayed when the screen is wider. Outlook on the web uses this view on most tablets. + * - `TwoColumns`, which is displayed when the screen is wider. Outlook on the web uses this view on most tablets. * - * - "ThreeColumns", which is displayed when the screen is wide. For example, Outlook on the web uses this view in a full screen window on a + * - `ThreeColumns`, which is displayed when the screen is wide. For example, Outlook on the web uses this view in a full screen window on a * desktop computer. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ OWAView: MailboxEnums.OWAView | "OneColumn" | "TwoColumns" | "ThreeColumns"; } @@ -11772,9 +11806,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface EmailAddressDetails { /** @@ -11787,7 +11821,7 @@ declare namespace Office { displayName: string; /** * Gets the response that an attendee returned for an appointment. - * This property applies to only an attendee of an appointment, as represented by the optionalAttendees or requiredAttendees property. + * 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: MailboxEnums.ResponseType | string; @@ -11801,9 +11835,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read */ interface EmailUser { /** @@ -11822,9 +11856,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ export interface EnhancedLocation { /** @@ -11834,19 +11868,19 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - InvalidFormatError: The format of the specified data object is not valid. + * - `InvalidFormatError`: The format of the specified data object is not valid. * * @param locationIdentifiers The locations to be added to the current list of locations. * @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. Check the `status` property of asyncResult to determine if the call succeeded. + * `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. Check the `status` property of `asyncResult` to determine if the call succeeded. */ addAsync(locationIdentifiers: LocationIdentifier[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResultStatus) => void): void; /** @@ -11856,17 +11890,17 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - InvalidFormatError: The format of the specified data object is not valid. + * - `InvalidFormatError`: The format of the specified data object is not valid. * * @param locationIdentifiers The locations to be added to the current list of locations. - * @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. Check the `status` property of asyncResult to determine if the call succeeded. + * @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. Check the `status` property of `asyncResult` to determine if the call succeeded. */ addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResultStatus) => void): void; /** @@ -11876,14 +11910,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * @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. + * `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. */ getAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -11893,50 +11927,50 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. */ getAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Removes the set of locations associated with the appointment. * - * If there are multiple locations with the same name, all matching locations will be removed even if only one was specified in locationIdentifiers. + * If there are multiple locations with the same name, all matching locations will be removed even if only one was specified in `locationIdentifiers`. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param locationIdentifiers The locations to be removed from the current list of locations. * @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. Check the `status` property of asyncResult to determine if the call succeeded. + * `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. Check the `status` property of `asyncResult` to determine if the call succeeded. */ removeAsync(locationIdentifiers: LocationIdentifier[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResultStatus) => void): void; /** * Removes the set of locations associated with the appointment. * - * If there are multiple locations with the same name, all matching locations will be removed even if only one was specified in locationIdentifiers. + * If there are multiple locations with the same name, all matching locations will be removed even if only one was specified in `locationIdentifiers`. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param locationIdentifiers The locations to be removed from the current list of locations. - * @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. Check the `status` property of asyncResult to determine if the call succeeded. + * @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. Check the `status` property of `asyncResult` to determine if the call succeeded. */ removeAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResultStatus) => void): void; } @@ -11962,7 +11996,7 @@ declare namespace Office { /** * Represents a collection of entities found in an email message or appointment. Read mode only. * - * The Entities object is a container for the entity arrays returned by the getEntities and getEntitiesByType methods when the item + * The `Entities` object is a container for the entity arrays returned by the `getEntities` and `getEntitiesByType` methods when the item * (either an email message or an appointment) contains one or more entities that have been found by the server. * You can use these entities in your code to provide additional context information to the viewer, such as a map to an address found in the item, * or to open a dialer for a phone number found in the item. @@ -11979,14 +12013,14 @@ declare namespace Office { * Entity recognition relies on natural language recognition that is based on machine learning of large amounts of data. * The recognition of an entity is non-deterministic and success sometimes relies on the particular context in the item. * - * When the property arrays are returned by the getEntitiesByType method, only the property for the specified entity contains data; + * When the property arrays are returned by the `getEntitiesByType` method, only the property for the specified entity contains data; * all other properties are null. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read */ interface Entities { /** @@ -12025,59 +12059,59 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose */ interface From { /** * Gets the from value of a message. * - * The getAsync method starts an asynchronous call to the Exchange server to get the from value of a message. + * The `getAsync` method starts an asynchronous call to the Exchange server to get the from value of a message. * - * The from value of the item is provided as an {@link Office.EmailAddressDetails | EmailAddressDetails} in the asyncResult.value property. + * The from value of the item is provided as an {@link Office.EmailAddressDetails | EmailAddressDetails} in the `asyncResult.value` property. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. - * The `value` property of the result is the item's from value, as an EmailAddressDetails object. + * `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. + * The `value` property of the result is the item's from value, as an `EmailAddressDetails` object. */ getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Gets the from value of a message. * - * The getAsync method starts an asynchronous call to the Exchange server to get the from value of a message. + * The `getAsync` method starts an asynchronous call to the Exchange server to get the from value of a message. * - * The from value of the item is provided as an {@link Office.EmailAddressDetails | EmailAddressDetails} in the asyncResult.value property. + * The from value of the item is provided as an {@link Office.EmailAddressDetails | EmailAddressDetails} in the `asyncResult.value` property. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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 the item's from value, as an EmailAddressDetails object. + * `asyncResult`, which is an `Office.AsyncResult` object. + * The `value` property of the result is the item's from value, as an `EmailAddressDetails` object. */ getAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; } /** - * The InternetHeaders object represents custom internet headers that are preserved after the message item leaves Exchange and is converted to a MIME message. - * These headers are stored as x-headers in the MIME message. + * The `InternetHeaders` object represents custom internet headers that are preserved after the message item leaves Exchange + * and is converted to a MIME message. These headers are stored as x-headers in the MIME message. * - * InternetHeaders are stored as key/value pairs on a per-item basis. + * Internet headers are stored as key/value pairs on a per-item basis. * * **Note**: This object is intended for you to set and get your custom headers on a message item. * @@ -12085,9 +12119,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose */ interface InternetHeaders { /** @@ -12100,15 +12134,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. + * `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. */ getAsync(names: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -12121,13 +12155,13 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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 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. */ getAsync(names: string[], callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -12139,15 +12173,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. + * `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. */ removeAsync(names: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -12159,19 +12193,19 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 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. */ removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Sets the specified internet headers to the specified values. * - * The setAsync method creates a new header if the specified header doesn't already exist; otherwise, the existing value is replaced with + * The `setAsync` method creates a new header if the specified header doesn't already exist; otherwise, the existing value is replaced with * the new value. * * **Note**: This method is intended to set the values of your custom headers. @@ -12180,22 +12214,22 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 * 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. - * 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. - * Any errors encountered will be provided in the asyncResult.error property. + * `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. Any errors encountered will be provided in the `asyncResult.error` property. */ setAsync(headers: Object, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Sets the specified internet headers to the specified values. * - * The setAsync method creates a new header if the specified header doesn't already exist; otherwise, the existing value is replaced with + * The `setAsync` method creates a new header if the specified header doesn't already exist; otherwise, the existing value is replaced with * the new value. * * **Note**: This method is intended to set the values of your custom headers. @@ -12204,14 +12238,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 * 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. - * Any errors encountered will be provided in the asyncResult.error property. + * @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(headers: Object, callback?: (asyncResult: Office.AsyncResult) => void): void; } @@ -12234,17 +12268,17 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer, Appointment Attendee, Message Compose, Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer, Appointment Attendee, Message Compose, Message Read */ interface Item { } /** * The compose mode of {@link Office.Item | Office.context.mailbox.item}. * - * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. - * You should treat this as a mode of Office.context.mailbox.item. Refer to the + * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. + * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information. * * Child interfaces: @@ -12258,8 +12292,8 @@ declare namespace Office { /** * The read mode of {@link Office.Item | Office.context.mailbox.item}. * - * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. - * You should treat this as a mode of Office.context.mailbox.item. Refer to the + * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. + * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information. * * Child interfaces: @@ -12275,9 +12309,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read */ interface LocalClientTime { /** @@ -12320,95 +12354,95 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose */ interface Location { /** * 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 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. + * 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. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * @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`. */ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: 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 - When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. + * 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. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 `Office.AsyncResult`. */ getAsync(callback: (asyncResult: 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. + * 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. - * 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. If setting the location fails, the asyncResult.error property will contain an error code. - * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. + * + * @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 + * type `Office.AsyncResult`. If setting the location fails, the `asyncResult.error` property will contain an error code. */ setAsync(location: string, options?: Office.AsyncContextOptions, callback?: (asyncResult: 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. + * 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 - * type Office.AsyncResult. If setting the location fails, the asyncResult.error property will contain an error code. - * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. + * - `DataExceedsMaximumSize`: The location parameter is longer than 255 characters. + * + * @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. */ setAsync(location: string, callback?: (asyncResult: Office.AsyncResult) => void): void; } @@ -12419,13 +12453,13 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ export interface LocationDetails { /** - * The LocationIdentifier of the location. + * The `LocationIdentifier` of the location. */ locationIdentifier: LocationIdentifier; /** @@ -12438,23 +12472,23 @@ declare namespace Office { emailAddress: string; } /** - * Represents the id of a location. + * Represents the ID of a location. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface LocationIdentifier { /** - * The location's unique id. + * The location's unique ID. * - * For **Room** type, it's the room's email address. + * For `Room` type, it's the room's email address. * - * For **Custom** type, it's the displayName. + * For `Custom` type, it's the `displayName`. */ id: string; /** @@ -12463,21 +12497,21 @@ declare namespace Office { type: MailboxEnums.LocationType | string; } /** - * Provides access to the Outlook Add-in object model for Microsoft Outlook and Microsoft Outlook on the web. + * Provides access to the Microsoft Outlook add-in object model. * - * Namespaces: + * Key properties: * - * - diagnostics: Provides diagnostic information to an Outlook add-in. + * - `diagnostics`: Provides diagnostic information to an Outlook add-in. * - * - item: Provides methods and properties for accessing a message or appointment in an Outlook add-in. + * - `item`: Provides methods and properties for accessing a message or appointment in an Outlook add-in. * - * - userProfile: Provides information about the user in an Outlook add-in. + * - `userProfile`: Provides information about the user in an Outlook add-in. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface Mailbox { /** @@ -12485,55 +12519,53 @@ declare namespace Office { * * Contains the following members: * - * - hostName (string): A string that represents the name of the host application. - * It should be one of the following values: "Outlook", "OutlookWebApp", "OutlookIOS", or "OutlookAndroid". + * - `hostName` (string): A string that represents the name of the host application. + * It should be one of the following values: `Outlook`, `OutlookWebApp`, `OutlookIOS`, or `OutlookAndroid`. * **Note**: The "Outlook" value is returned for Outlook on desktop clients (i.e., Windows and Mac). * - * - hostVersion (string): A string that represents the version of either the host application or the Exchange Server (e.g., "15.0.468.0"). - * If the mail add-in is running in Outlook on desktop or mobile clients, the hostVersion property returns the version of the + * - `hostVersion` (string): A string that represents the version of either the host application or the Exchange Server (e.g., "15.0.468.0"). + * If the mail add-in is running in Outlook on desktop or mobile clients, the `hostVersion` property returns the version of the * host application, Outlook. In Outlook on the web, the property returns the version of the Exchange Server. * - * - OWAView (MailboxEnums.OWAView or string): An enum (or string literal) that represents the current view of Outlook on the web. + * - `OWAView` (`MailboxEnums.OWAView` or string): An enum (or string literal) that represents the current view of Outlook on the web. * If the host application is not Outlook on the web, then accessing this property results in undefined. - * Outlook on the web has three views ("OneColumn" - displayed when the screen is narrow, "TwoColumns" - displayed when the screen is wider, - * and "ThreeColumns" - displayed when the screen is wide) that correspond to the width of the screen and the window, and the number of columns + * Outlook on the web has three views (`OneColumn` - displayed when the screen is narrow, `TwoColumns` - displayed when the screen is wider, + * and `ThreeColumns` - displayed when the screen is wide) that correspond to the width of the screen and the window, and the number of columns * that can be displayed. * * More information is under {@link Office.Diagnostics}. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ diagnostics: Diagnostics; /** * Gets the URL of the Exchange Web Services (EWS) endpoint for this email account. Read mode only. * - * Your app must have the ReadItem permission specified in its manifest to call the ewsUrl member in read mode. + * Your app must have the `ReadItem` permission specified in its manifest to call the `ewsUrl` member in read mode. * - * In compose mode you must call the saveAsync method before you can use the ewsUrl member. - * Your app must have ReadWriteItem permissions to call the saveAsync method. + * In compose mode you must call the `saveAsync` method before you can use the `ewsUrl` member. + * Your app must have `ReadWriteItem` permissions to call the `saveAsync` method. * * **Note**: This member is not supported in Outlook on iOS or Android. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * - * The ewsUrl value can be used by a remote service to make EWS calls to the user's mailbox. - * For example, you can create a remote service to {@link https://docs.microsoft.com/outlook/add-ins/get-attachments-of-an-outlook-item | get attachments from the selected item}. + * The `ewsUrl` value can be used by a remote service to make EWS calls to the user's mailbox. + * For example, you can create a remote service to {@link https://docs.microsoft.com/office/dev/add-ins/outlook/get-attachments-of-an-outlook-item | get attachments from the selected item}. */ ewsUrl: string; /** * The mailbox item. Depending on the context in which the add-in opened, the item type may vary. * If you want to see IntelliSense for only a specific type or mode, cast this item to one of the following: * - * {@link Office.ItemCompose | ItemCompose}, {@link Office.ItemRead | ItemRead}, - * {@link Office.Message | Message}, {@link Office.Appointment | Appointment}, * {@link Office.MessageCompose | MessageCompose}, {@link Office.MessageRead | MessageRead}, * {@link Office.AppointmentCompose | AppointmentCompose}, {@link Office.AppointmentRead | AppointmentRead} */ @@ -12545,28 +12577,28 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ masterCategories: MasterCategories; /** * Gets the URL of the REST endpoint for this email account. * - * Your app must have the ReadItem permission specified in its manifest to call the restUrl member in read mode. + * Your app must have the `ReadItem` permission specified in its manifest to call the `restUrl` member in read mode. * - * In compose mode you must call the saveAsync method before you can use the restUrl member. - * Your app must have ReadWriteItem permissions to call the saveAsync method. + * In compose mode you must call the saveAsync method before you can use the `restUrl` member. + * Your app must have `ReadWriteItem` permissions to call the `saveAsync` method. * * [Api set: Mailbox 1.5] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * - * The restUrl value can be used to make {@link https://docs.microsoft.com/outlook/rest/ | REST API} calls to the user's mailbox. + * The `restUrl` value can be used to make {@link https://docs.microsoft.com/outlook/rest/ | REST API} calls to the user's mailbox. */ restUrl: string; /** @@ -12585,16 +12617,16 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * The type property on the parameter will match the eventType parameter passed to addHandlerAsync. + * @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 - * 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`. */ addHandlerAsync(eventType: Office.EventType | string, handler: (type: Office.EventType) => void, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -12606,22 +12638,22 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * 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 of - * type Office.AsyncResult. + * @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 of + * type `Office.AsyncResult`. */ addHandlerAsync(eventType: Office.EventType | string, handler: (type: Office.EventType) => void, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Converts an item ID formatted for REST into EWS format. * - * Item IDs retrieved via a REST API (such as the Outlook Mail API or the Microsoft Graph) use a different format than the format used by - * Exchange Web Services (EWS). The convertToEwsId method converts a REST-formatted ID into the proper format for EWS. + * Item IDs retrieved via a REST API (such as the Outlook Mail API or the Microsoft Graph) use a different format than the format used by + * Exchange Web Services (EWS). The `convertToEwsId` method converts a REST-formatted ID into the proper format for EWS. * * **Note**: This method is not supported in Outlook on iOS or Android. * @@ -12629,9 +12661,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. @@ -12645,18 +12677,18 @@ declare namespace Office { * You should handle date and time values so that the values you display on the user interface are always consistent with the time zone that * the user expects. * - * If the mail app is running in Outlook on desktop clients, the convertToLocalClientTime method will return a dictionary object with the values set to the - * client computer time zone. - * If the mail app is running in Outlook on the web, the convertToLocalClientTime method will return a dictionary object with the values set to - * the time zone specified in the EAC. + * If the mail app is running in Outlook on desktop clients, the `convertToLocalClientTime` method will return a dictionary object + * with the values set to the client computer time zone. + * If the mail app is running in Outlook on the web, the `convertToLocalClientTime` method will return a dictionary object + * with the values set to the time zone specified in the EAC. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * - * @param timeValue - A Date object. + * @param timeValue - A `Date` object. */ convertToLocalClientTime(timeValue: Date): LocalClientTime; /** @@ -12668,38 +12700,40 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * - * Item IDs retrieved via EWS or via the itemId property use a different format than the format used by REST APIs (such as the - * {@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. + * Item IDs retrieved via EWS or via the `itemId` property use a different format than the format used by REST APIs (such as the + * {@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. */ convertToRestId(itemId: string, restVersion: MailboxEnums.RestVersion | string): string; /** - * Gets a Date object from a dictionary containing time information. + * Gets a `Date` object from a dictionary containing time information. * - * The convertToUtcClientTime method converts a dictionary containing a local date and time to a Date object with the correct values for the + * The `convertToUtcClientTime` method converts a dictionary containing a local date and time to a `Date` object with the correct values for the * local date and time. + * + * @returns A Date object with the time expressed in UTC. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * @param input - The local time value to convert. - * @returns A Date object with the time expressed in UTC. */ convertToUtcClientTime(input: LocalClientTime): Date; /** * Displays an existing calendar appointment. * - * The displayAppointmentForm method opens an existing calendar appointment in a new window on the desktop or in a dialog box on + * The `displayAppointmentForm` method opens an existing calendar appointment in a new window on the desktop or in a dialog box on * mobile devices. * * In Outlook on Mac, you can use this method to display a single appointment that is not part of a recurring series, or the @@ -12715,9 +12749,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * @param itemId - The Exchange Web Services (EWS) identifier for an existing calendar appointment. */ @@ -12725,23 +12759,23 @@ declare namespace Office { /** * Displays an existing message. * - * The displayMessageForm method opens an existing message in a new window on the desktop or in a dialog box on mobile devices. + * The `displayMessageForm` method opens an existing message in a new window on the desktop or in a dialog box on mobile devices. * * In Outlook on the web, this method opens the specified form only if the body of the form is less than or equal to 32 KB number of characters. * - * If the specified item identifier does not identify an existing message, no message will be displayed on the client computer, and + * If the specified item identifier does not identify an existing message, no message will be displayed on the client computer, and * no error message will be returned. * - * Do not use the displayMessageForm with an itemId that represents an appointment. Use the displayAppointmentForm method to display - * an existing appointment, and displayNewAppointmentForm to display a form to create a new appointment. + * Do not use the `displayMessageForm` with an itemId that represents an appointment. Use the `displayAppointmentForm` method to display + * an existing appointment, and `displayNewAppointmentForm` to display a form to create a new appointment. * * **Note**: This method is not supported in Outlook on iOS or Android. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * @param itemId - The Exchange Web Services (EWS) identifier for an existing message. */ @@ -12749,16 +12783,16 @@ declare namespace Office { /** * Displays a form for creating a new calendar appointment. * - * The displayNewAppointmentForm method opens a form that enables the user to create a new appointment or meeting. + * The `displayNewAppointmentForm` method opens a form that enables the user to create a new appointment or meeting. * If parameters are specified, the appointment form fields are automatically populated with the contents of the parameters. * - * In Outlook on the web, this method always displays a form with an attendees field. - * If you do not specify any attendees as input arguments, the method displays a form with a Save button. - * If you have specified attendees, the form would include the attendees and a Send button. + * In Outlook on the web, this method always displays a form with an attendees field. + * If you do not specify any attendees as input arguments, the method displays a form with a **Save** button. + * If you have specified attendees, the form would include the attendees and a **Send** button. * - * In the Outlook rich client and Outlook RT, if you specify any attendees or resources in the requiredAttendees, optionalAttendees, or - * resources parameter, this method displays a meeting form with a Send button. - * If you don't specify any recipients, this method displays an appointment form with a Save & Close button. + * In the Outlook rich client and Outlook RT, if you specify any attendees or resources in the `requiredAttendees`, `optionalAttendees`, or + * `resources` parameter, this method displays a meeting form with a **Send** button. + * If you don't specify any recipients, this method displays an appointment form with a **Save & Close** button. * * If any of the parameters exceed the specified size limits, or if an unknown parameter name is specified, an exception is thrown. * @@ -12766,17 +12800,17 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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; /** * Displays a form for creating a new message. * - * The displayNewMessageForm method opens a form that enables the user to create a new message. If parameters are specified, the message form + * The `displayNewMessageForm` method opens a form that enables the user to create a new message. If parameters are specified, the message form * fields are automatically populated with the contents of the parameters. * * If any of the parameters exceed the specified size limits, or if an unknown parameter name is specified, an exception is thrown. @@ -12785,37 +12819,37 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. * - * toRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object + * `toRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object * for each of the recipients on the To line. The array is limited to a maximum of 100 entries. * - * ccRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object + * `ccRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object * for each of the recipients on the Cc line. The array is limited to a maximum of 100 entries. * - * bccRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object + * `bccRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object * for each of the recipients on the Bcc line. The array is limited to a maximum of 100 entries. * - * subject: A string containing the subject of the message. The string is limited to a maximum of 255 characters. + * `subject`: A string containing the subject of the message. The string is limited to a maximum of 255 characters. * - * htmlBody: The HTML body of the message. The body content is limited to a maximum size of 32 KB. + * `htmlBody`: The HTML body of the message. The body content is limited to a maximum size of 32 KB. * - * attachments: An array of JSON objects that are either file or item attachments. + * `attachments`: An array of JSON objects that are either file or item attachments. * - * attachments.type: Indicates the type of attachment. Must be file for a file attachment or item for an item attachment. + * `attachments.type`: Indicates the type of attachment. Must be file for a file attachment or item for an item attachment. * - * attachments.name: A string that contains the name of the attachment, up to 255 characters in length. + * `attachments.name`: A string that contains the name of the attachment, up to 255 characters in length. * - * attachments.url: Only used if type is set to file. The URI of the location for the file. + * `attachments.url`: Only used if type is set to file. The URI of the location for the file. * - * attachments.isInline: Only used if type is set to file. If true, indicates that the attachment will be shown inline in the + * `attachments.isInline`: Only used if type is set to file. If true, indicates that the attachment will be shown inline in the * message body, and should not be displayed in the attachment list. * - * attachments.itemId: Only used if type is set to item. The EWS item id of the existing e-mail you want to attach to the new message. + * `attachments.itemId`: Only used if type is set to item. The EWS item id of the existing e-mail you want to attach to the new message. * This is a string up to 100 characters. */ displayNewMessageForm(parameters: any): void; @@ -12827,34 +12861,34 @@ declare namespace Office { * * The token is returned as a string in the `asyncResult.value` property. * - * Calling the `getCallbackTokenAsync` method in read mode requires a minimum permission level of **ReadItem**. + * Calling the `getCallbackTokenAsync` method in read mode requires a minimum permission level of `ReadItem`. * * Calling the `getCallbackTokenAsync` method in compose mode requires you to have saved the item. - * The `saveAsync` method requires a minimum permission level of **ReadWriteItem**. + * The `saveAsync` method requires a minimum permission level of `ReadWriteItem`. * * *REST Tokens* * - * When a REST token is requested (options.isRest = true), the resulting token will not work to authenticate Exchange Web Services calls. - * The token will be limited in scope to read-only access to the current item and its attachments, unless the add-in has specified the - * ReadWriteMailbox permission in its manifest. - * If the ReadWriteMailbox permission is specified, the resulting token will grant read/write access to mail, calendar, and contacts, + * When a REST token is requested (`options.isRest = true`), the resulting token will not work to authenticate Exchange Web Services calls. + * The token will be limited in scope to read-only access to the current item and its attachments, unless the add-in has specified the + * `ReadWriteMailbox` permission in its manifest. + * If the `ReadWriteMailbox` permission is specified, the resulting token will grant read/write access to mail, calendar, and contacts, * including the ability to send mail. * - * The add-in should use the restUrl property to determine the correct URL to use when making REST API calls. + * The add-in should use the `restUrl` property to determine the correct URL to use when making REST API calls. * * *EWS Tokens* * - * When an EWS token is requested (options.isRest = false), the resulting token will not work to authenticate REST API calls. + * When an EWS token is requested (`options.isRest = false`), the resulting token will not work to authenticate REST API calls. * The token will be limited in scope to accessing the current item. * - * The add-in should use the ewsUrl property to determine the correct URL to use when making EWS calls. + * The add-in should use the `ewsUrl` property to determine the correct URL to use when making EWS calls. * * You can pass both the token and either an attachment identifier or item identifier to a third-party system. The third-party system uses * the token as a bearer authorization token to call the Exchange Web Services (EWS) * {@link https://docs.microsoft.com/exchange/client-developer/web-service-reference/getattachment-operation | GetAttachment} operation or * {@link https://docs.microsoft.com/exchange/client-developer/web-service-reference/getitem-operation | GetItem} operation to return an * attachment or item. For example, you can create a remote service to - * {@link https://docs.microsoft.com/outlook/add-ins/get-attachments-of-an-outlook-item | get attachments from the selected item}. + * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/get-attachments-of-an-outlook-item | get attachments from the selected item}. * * **Note**: It is recommended that add-ins use the REST APIs instead of Exchange Web Services whenever possible. * @@ -12862,23 +12896,23 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * **Errors**: * - * - HTTPRequestFailure: The request has failed. Please look at the diagnostics object for the HTTP error code. + * - `HTTPRequestFailure`: The request has failed. Please look at the diagnostics object for the HTTP error code. * - * - InternalServerError: The Exchange server returned an error. Please look at the diagnostics object for more information. + * - `InternalServerError`: The Exchange server returned an error. Please look at the diagnostics object for more information. * - * - NetworkError: The user is no longer connected to the network. Please check your network connection and try again. + * - `NetworkError`: The user is no longer connected to the network. Please check your network connection and try again. * * @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 - * type Office.AsyncResult. The token is returned as a string in the `asyncResult.value` property. + * `isRest`: Determines if the token provided will be used for the Outlook REST APIs or Exchange Web Services. Default value is `false`. + * `asyncContext`: Any state data that is passed to the asynchronous method. + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of + * type `Office.AsyncResult`. The token is returned as a string in the `asyncResult.value` property. * If there was an error, the `asyncResult.error` and `asyncResult.diagnostics` properties may provide additional information. */ getCallbackTokenAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (asyncResult: Office.AsyncResult) => void): void; @@ -12895,31 +12929,31 @@ declare namespace Office { * {@link https://docs.microsoft.com/exchange/client-developer/web-service-reference/getattachment-operation | GetAttachment} or * {@link https://docs.microsoft.com/exchange/client-developer/web-service-reference/getitem-operation | GetItem} operation to return an * attachment or item. For example, you can create a remote service to - * {@link https://docs.microsoft.com/outlook/add-ins/get-attachments-of-an-outlook-item | get attachments from the selected item}. + * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/get-attachments-of-an-outlook-item | get attachments from the selected item}. * - * Calling the `getCallbackTokenAsync` method in read mode requires a minimum permission level of **ReadItem**. + * Calling the `getCallbackTokenAsync` method in read mode requires a minimum permission level of `ReadItem`. * * Calling the `getCallbackTokenAsync` method in compose mode requires you to have saved the item. - * The `saveAsync` method requires a minimum permission level of **ReadWriteItem**. + * The `saveAsync` method requires a minimum permission level of `ReadWriteItem`. * * [Api set: All support Read mode; Mailbox 1.3 introduced Compose mode support] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * **Errors**: * - * - HTTPRequestFailure: The request has failed. Please look at the diagnostics object for the HTTP error code. + * - `HTTPRequestFailure`: The request has failed. Please look at the diagnostics object for the HTTP error code. * - * - InternalServerError: The Exchange server returned an error. Please look at the diagnostics object for more information. + * - `InternalServerError`: The Exchange server returned an error. Please look at the diagnostics object for more information. * - * - NetworkError: The user is no longer connected to the network. Please check your network connection and try again. + * - `NetworkError`: The user is no longer connected to the network. Please check your network connection and try again. * - * @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 returned as a string 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`. The token is returned as a string in the `asyncResult.value` property. * If there was an error, the `asyncResult.error` and `asyncResult.diagnostics` properties may provide additional information. * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ @@ -12931,23 +12965,23 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * - * 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}. + * The `getUserIdentityTokenAsync` method returns a token that you can use to identify and + * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/authentication | authenticate the add-in and user with a third-party system}. * * **Errors**: * - * - HTTPRequestFailure: The request has failed. Please look at the diagnostics object for the HTTP error code. + * - `HTTPRequestFailure`: The request has failed. Please look at the diagnostics object for the HTTP error code. * - * - InternalServerError: The Exchange server returned an error. Please look at the diagnostics object for more information. + * - `InternalServerError`: The Exchange server returned an error. Please look at the diagnostics object for more information. * - * - NetworkError: The user is no longer connected to the network. Please check your network connection and try again. + * - `NetworkError`: The user is no longer connected to the network. Please check your network connection and try again. * * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. + * type `Office.AsyncResult`. * The token is returned as a string in the `asyncResult.value` property. * If there was an error, the `asyncResult.error` and `asyncResult.diagnostics` properties may provide additional information. * @param userContext - Optional. Any state data that is passed to the asynchronous method. @@ -12958,17 +12992,17 @@ declare namespace Office { * * In these cases, add-ins should use REST APIs to access the user's mailbox instead. * - * The makeEwsRequestAsync method sends an EWS request on behalf of the add-in to Exchange. + * The `makeEwsRequestAsync` method sends an EWS request on behalf of the add-in to Exchange. * - * You cannot request Folder Associated Items with the makeEwsRequestAsync method. + * You cannot request Folder Associated Items with the `makeEwsRequestAsync` method. * - * The XML request must specify UTF-8 encoding. \ + * The XML request must specify UTF-8 encoding: `\`. * - * Your add-in must have the ReadWriteMailbox permission to use the makeEwsRequestAsync method. - * For information about using the ReadWriteMailbox permission and the EWS operations that you can call with the makeEwsRequestAsync method, - * see {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Specify permissions for mail add-in access to the user's mailbox}. + * Your add-in must have the `ReadWriteMailbox` permission to use the `makeEwsRequestAsync` method. + * For information about using the `ReadWriteMailbox` permission and the EWS operations that you can call with the `makeEwsRequestAsync` method, + * see {@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Specify permissions for mail add-in access to the user's mailbox}. * - * The XML result of the EWS call is provided as a string in the asyncResult.value property. + * The XML result of the EWS call is provided as a string in the `asyncResult.value` property. * If the result exceeds 1 MB in size, an error message is returned instead. * * **Note**: This method is not supported in the following scenarios: @@ -12977,28 +13011,29 @@ declare namespace Office { * * - When the add-in is loaded in a Gmail mailbox. * - * **Note**: The server administrator must set OAuthAuthentication to true on the Client Access Server EWS directory to enable the - * makeEwsRequestAsync method to make EWS requests. + * **Note**: The server administrator must set `OAuthAuthentication` to `true` on the Client Access Server EWS directory to enable the + * `makeEwsRequestAsync` method to make EWS requests. * * *Version differences* * - * When you use the makeEwsRequestAsync method in mail apps running in Outlook versions earlier than version 15.0.4535.1004, you should set + * When you use the `makeEwsRequestAsync` method in mail apps running in Outlook versions earlier than version 15.0.4535.1004, you should set * the encoding value to ISO-8859-1. * * `` * - * You do not need to set the encoding value when your mail app is running in Outlook on the web. - * You can determine whether your mail app is running in Outlook or Outlook on the web by using the mailbox.diagnostics.hostName property. - * You can determine what version of Outlook is running by using the mailbox.diagnostics.hostVersion property. + * You do not need to set the encoding value when your mail app is running in Outlook on the web. + * You can determine whether your mail app is running in Outlook or Outlook on the web by using the `mailbox.diagnostics.hostName` property. + * You can determine what version of Outlook is running by using the `mailbox.diagnostics.hostVersion` property. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or 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 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. @@ -13013,14 +13048,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * 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`. */ removeHandlerAsync(eventType: Office.EventType | string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -13032,13 +13067,13 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 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`. */ removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult) => void): void; } @@ -13052,147 +13087,146 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface MasterCategories { /** * Adds categories to the master list on a mailbox. Each category must have a unique name but multiple categories can use the same color. * - * @param categories - The categories to be added to the master list on the mailbox. - * @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. - * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * **Errors**: * - * - DuplicateCategory: One of the categories provided is already in the master category list. + * - `DuplicateCategory`: One of the categories provided is already in the master category list. * - * - PermissionDenied: The user does not have permission to perform this action. + * - `PermissionDenied`: The user does not have permission to perform this action. + * + * @param categories - The categories to be added to the master list on the mailbox. + * @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`. */ addAsync(categories: CategoryDetails[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds categories to the master list on a mailbox. Each category must have a unique name but multiple categories can use the same color. * - * @param categories - The categories to be added to the master list on the mailbox. - * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. If adding categories fails, the asyncResult.error property will contain an error code. - * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * **Errors**: * - * - DuplicateCategory: One of the categories provided is already in the master category list. + * - `DuplicateCategory`: One of the categories provided is already in the master category list. * - * - PermissionDenied: The user does not have permission to perform this action. + * - `PermissionDenied`: The user does not have permission to perform this action. + * + * @param categories - The categories to be added to the master list on the mailbox. + * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of + * type `Office.AsyncResult`. If adding categories fails, the `asyncResult.error` property will contain an error code. */ addAsync(categories: CategoryDetails[], callback: (asyncResult: Office.AsyncResult) => void): void; /** * Gets the master list of categories on a mailbox. * - * @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. If adding categories fails, the asyncResult.error property will contain an error code. - * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * @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`. If adding categories fails, the `asyncResult.error` property will contain an error code. */ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** * Gets the master list of categories on a mailbox. * - * @param callback - 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.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 + * type `Office.AsyncResult`. */ getAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Removes categories from the master list on a mailbox. * - * @param categories - The categories to be removed from the master list on the mailbox. - * @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. If removing categories fails, the asyncResult.error property will contain an error code. - * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * **Errors**: * - * - PermissionDenied: The user does not have permission to perform this action. + * - `PermissionDenied`: The user does not have permission to perform this action. + * + * @param categories - The categories to be removed from the master list on the mailbox. + * @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`. If removing categories fails, the `asyncResult.error` property will contain an error code. */ removeAsync(categories: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Removes categories from the master list on a mailbox. * - * @param categories - The categories to be removed from the master list on the mailbox. - * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. If removing categories fails, the asyncResult.error property will contain an error code. - * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * **Errors**: * - * - PermissionDenied: The user does not have permission to perform this action. + * - `PermissionDenied`: The user does not have permission to perform this action. + * + * @param categories - The categories to be removed from the master list on the mailbox. + * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of + * type `Office.AsyncResult`. If removing categories fails, the `asyncResult.error` property will contain an error code. */ removeAsync(categories: string[], callback: (asyncResult: Office.AsyncResult) => void): void; } /** * Represents a suggested meeting found in an item. Read mode only. * - * The list of meetings suggested in an email message is returned in the meetingSuggestions property of the Entities object that is returned when - * the getEntities or getEntitiesByType method is called on the active item. + * The list of meetings suggested in an email message is returned in the `meetingSuggestions` property of the `Entities` object that is returned when + * the `getEntities` or `getEntitiesByType` method is called on the active item. * - * The start and end values are string representations of a Date object that contains the date and time at which the suggested meeting is to - * begin and end. - * The values are in the default time zone specified for the current user. + * The start and end values are string representations of a `Date` object that contains the date and time at which the suggested meeting is to + * begin and end. The values are in the default time zone specified for the current user. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read */ interface MeetingSuggestion { /** @@ -13224,7 +13258,7 @@ declare namespace Office { * A subclass of {@link Office.Item | Item} for messages. * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. - * You should treat this as a mode of Office.context.mailbox.item. Refer to the + * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information. * * Child interfaces: @@ -13239,7 +13273,7 @@ declare namespace Office { * The message compose mode of {@link Office.Item | Office.context.mailbox.item}. * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. - * You should treat this as a mode of Office.context.mailbox.item. Refer to the + * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information. * * Parent interfaces: @@ -13262,9 +13296,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ bcc: Recipients; /** @@ -13274,9 +13308,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ body: Body; /** @@ -13286,16 +13320,16 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ categories: Categories; /** * 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. * - * The cc property returns a {@link Office.Recipients | Recipients} object that provides methods to get or update the recipients on the Cc line of + * The `cc` property returns a {@link Office.Recipients | Recipients} object that provides methods to get or update the recipients on the Cc line of * the message. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, the following limits apply. * * - Get 500 members maximum. @@ -13304,9 +13338,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ cc: Recipients; /** @@ -13317,57 +13351,57 @@ declare namespace Office { * and that value you obtained earlier will no longer apply. * * You get null for this property for a new item in a compose form. - * If the user sets a subject and saves the item, the conversationId property will return a value. + * If the user sets a subject and saves the item, the `conversationId` property will return a value. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ conversationId: string; /** * Gets the email address of the sender of a message. * - * The from and sender properties represent the same person unless the message is sent by a delegate. - * In that case, the from property represents the owner, and the sender property represents the delegate. + * The `from` and `sender` properties represent the same person unless the message is sent by a delegate. + * In that case, the `from` property represents the owner, and the `sender` property represents the delegate. * - * The from property returns a From object that provides a method to get the from value. + * The `from` property returns a `From` object that provides a method to get the from value. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ from: From; /** * Gets or sets the custom internet headers of a message. * - * The internetHeaders property returns an InternetHeaders object that provides methods to manage the internet headers on the message. + * The `internetHeaders` property returns an `InternetHeaders` object that provides methods to manage the internet headers on the message. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ internetHeaders: InternetHeaders; /** * Gets the type of item that an instance represents. * - * The itemType property returns one of the ItemType enumeration values, indicating whether the item object instance is a message or + * The `itemType` property returns one of the `ItemType` enumeration values, indicating whether the item object instance is a message or * an appointment. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ itemType: MailboxEnums.ItemType | string; /** @@ -13377,53 +13411,53 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ notificationMessages: NotificationMessages; /** - * Gets the id of the series that an instance belongs to. + * Gets the ID of the series that an instance belongs to. * - * In Outlook on the web and desktop clients, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to. - * However, on iOS and Android, the seriesId returns the REST ID of the parent item. + * In Outlook on the web and desktop clients, the `seriesId` returns the Exchange Web Services (EWS) ID of the parent (series) item + * that this item belongs to. However, on iOS and Android, the seriesId returns the REST ID of the parent item. * - * **Note**: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier. - * The seriesId property is not identical to the Outlook IDs used by the Outlook REST API. - * Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId. - * For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. + * **Note**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier. + * The `seriesId` property is not identical to the Outlook IDs used by the Outlook REST API. + * Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`. + * For more details, see {@link https://docs.microsoft.com/office/dev/add-ins/outlook/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. * - * The seriesId property returns null for items that do not have parent items such as single appointments, series items, or meeting requests - * and returns undefined for any other items that are not meeting requests. + * The `seriesId` property returns `null` for items that do not have parent items such as single appointments, series items, or meeting requests + * and returns `undefined` for any other items that are not meeting requests. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ seriesId: string; /** * Gets or sets the description that appears in the subject field of an item. * - * The subject property gets or sets the entire subject of the item, as sent by the email server. + * The `subject` property gets or sets the entire subject of the item, as sent by the email server. * - * The subject property returns a Subject object that provides methods to get and set the subject. + * The `subject` property returns a `Subject` object that provides methods to get and set the subject. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ subject: Subject; /** - * Provides access to the recipients on the To line of a message. The type of object and level of access depends on the mode of the + * Provides access to the recipients on the To line of a message. The type of object and level of access depends on the mode of the * current item. * - * The to property returns a Recipients object that provides methods to get or update the recipients on the To line of the message. + * The `to` property returns a `Recipients` object that provides methods to get or update the recipients on the To line of the message. * By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, the following limits apply. * * - Get 500 members maximum. @@ -13432,18 +13466,18 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ to: Recipients; /** * Adds a file to a message or appointment as an attachment. * - * The addFileAttachmentAsync method uploads the file at the specified URI and attaches it to the item in the compose form. + * The `addFileAttachmentAsync` method uploads the file at the specified URI and attaches it to the item in the compose form. * - * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * * **Important**: In recent builds of Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to * this action (whether using this API or the Outlook UI). To work around this issue, you can try using the `addFileAttachmentFromBase64` API @@ -13453,36 +13487,36 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - AttachmentSizeExceeded: The attachment is larger than allowed. + * - `AttachmentSizeExceeded`: The attachment is larger than allowed. * - * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * - `FileTypeNotSupported`: The attachment has an extension that is not allowed. * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `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. - * 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 + * `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 - 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 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 + * @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 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 & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds a file to a message or appointment as an attachment. * - * The addFileAttachmentAsync method uploads the file at the specified URI and attaches it to the item in the compose form. + * The `addFileAttachmentAsync` method uploads the file at the specified URI and attaches it to the item in the compose form. * - * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * * **Important**: In recent builds of Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to * this action (whether using this API or the Outlook UI). To work around this issue, you can try using the `addFileAttachmentFromBase64` API @@ -13492,95 +13526,95 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - AttachmentSizeExceeded: The attachment is larger than allowed. + * - `AttachmentSizeExceeded`: The attachment is larger than allowed. * - * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * - `FileTypeNotSupported`: The attachment has an extension that is not allowed. * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `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 - 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 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 + * @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 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?: (asyncResult: 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. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * - * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. + * **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API. * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - AttachmentSizeExceeded: The attachment is larger than allowed. + * - `AttachmentSizeExceeded`: The attachment is larger than allowed. * - * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * - `FileTypeNotSupported`: The attachment has an extension that is not allowed. * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `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 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 - 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 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. + * `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 - 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 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. */ addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: 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. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * - * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. + * **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API. * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - AttachmentSizeExceeded: The attachment is larger than allowed. + * - `AttachmentSizeExceeded`: The attachment is larger than allowed. * - * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * - `FileTypeNotSupported`: The attachment has an extension that is not allowed. * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `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 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 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 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. + * @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 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. */ addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -13592,17 +13626,17 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * The type property on the parameter will match the eventType parameter passed to addHandlerAsync. + * @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. - * 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. + * `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. */ addHandlerAsync(eventType: Office.EventType | string, handler: any, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -13614,82 +13648,82 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * 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 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. */ addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. * - * The addItemAttachmentAsync method attaches the item with the specified Exchange identifier to the item in the compose form. - * If you specify a callback method, the method is called with one parameter, asyncResult, which contains either the attachment identifier or + * The `addItemAttachmentAsync` method attaches the item with the specified Exchange identifier to the item in the compose form. + * If you specify a callback method, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or * a code that indicates any error that occurred while attaching the item. You can use the options parameter to pass state information to the * callback method, if needed. * - * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * - * If your Office add-in is running in Outlook on the web, the addItemAttachmentAsync method can attach items to items other than the item that + * If your Office Add-in is running in Outlook on the web, the `addItemAttachmentAsync` method can attach items to items other than the item that * you are editing; however, this is not supported and is not recommended. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `NumberOfAttachmentsExceeded`: 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 - 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. 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 + * `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`. 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?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. * - * The addItemAttachmentAsync method attaches the item with the specified Exchange identifier to the item in the compose form. - * If you specify a callback method, the method is called with one parameter, asyncResult, which contains either the attachment identifier or - * a code that indicates any error that occurred while attaching the item. + * The `addItemAttachmentAsync` method attaches the item with the specified Exchange identifier to the item in the compose form. + * If you specify a callback method, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or + * a code that indicates any error that occurred while attaching the item. * You can use the options parameter to pass state information to the callback method, if needed. * - * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * - * If your Office add-in is running in Outlook on the web, the addItemAttachmentAsync method can attach items to items other than the item that + * If your Office Add-in is running in Outlook on the web, the `addItemAttachmentAsync` method can attach items to items other than the item that * you are editing; however, this is not supported and is not recommended. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `NumberOfAttachmentsExceeded`: 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 - 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 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 + * @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 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?: (asyncResult: Office.AsyncResult) => void): void; @@ -13701,78 +13735,78 @@ declare namespace Office { * * In the Outlook desktop client, if the message is an inline reply, the close method has no effect. * - * **Note**: In Outlook on the web, if the item is an appointment and it has previously been saved using saveAsync, the user is prompted to save, + * **Note**: In Outlook on the web, if the item is an appointment and it has previously been saved using `saveAsync`, the user is prompted to save, * discard, or cancel even if no changes have occurred since the item was last saved. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ close(): void; /** - * Gets an attachment from a message or appointment and returns it as an **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 - * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session. - * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to + * 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 attachment IDs were retrieved with the `getAttachmentsAsync` or + * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session. + * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to * continue in a separate window. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - AttachmentTypeNotSupported: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, + * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, * or item attachment types other than email or calendar items (such as a contact or task item). * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: 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. - * 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 - * with the reason for the failure. + * `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 + * an error code with the reason for the failure. */ getAttachmentContentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** - * Gets an attachment from a message or appointment and returns it as an **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 - * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session. - * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to + * 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 attachment IDs were retrieved with the `getAttachmentsAsync` or + * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session. + * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to * continue in a separate window. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - AttachmentTypeNotSupported: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, + * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, * or item attachment types other than email or calendar items (such as a contact or task item). * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * * @param attachmentId - The identifier of the attachment you want to get. - * @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. + * @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 + * an error code with the reason for the failure. */ getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -13782,14 +13816,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * @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. If the call fails, the asyncResult.error property will contain and error code with the reason for + * `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`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for * the failure. */ getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; @@ -13800,38 +13834,37 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * - * @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 + * @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 an error code with the reason for * the failure. */ getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Gets initialization data passed when the add-in is activated by an actionable message. * - * **Note**: This method is only supported by Outlook 2016 or later on Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web - * for Office 365. + * **Note**: This method is only supported by Outlook 2016 or later on Windows (Click-to-Run versions greater than 16.0.8413.1000) + * and Outlook on the web for Office 365. * * [Api set: Mailbox Preview] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * 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. - * 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. - * 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. + * `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`. 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 */ @@ -13839,24 +13872,23 @@ declare namespace Office { /** * Gets initialization data passed when the add-in is activated by an actionable message. * - * **Note**: This method is only supported by Outlook 2016 or later on Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web - * for Office 365. + * **Note**: This method is only supported by Outlook 2016 or later on Windows (Click-to-Run versions greater than 16.0.8413.1000) + * and Outlook on the web for Office 365. * * [Api set: Mailbox Preview] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * More information on {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | actionable messages}. * - * @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. + * @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 */ @@ -13874,17 +13906,18 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * * - `ItemNotSaved`: The id can't be retrieved until the item is saved. * * @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. + * `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`. */ getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -13900,69 +13933,70 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * * - `ItemNotSaved`: The id can't be retrieved until the item is saved. * - * @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`. */ getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * * If there is no selection but the cursor is in the body or subject, the method returns an empty string for the selected data. - * If a field other than the body or subject is selected, the method returns the InvalidSelection error. + * If a field other than the body or subject is selected, the method returns the `InvalidSelection` error. * - * To access the selected data from the callback method, call asyncResult.value.data. - * To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject. + * To access the selected data from the callback method, call `asyncResult.value.data`. + * To access the source property that the selection comes from, call `asyncResult.value.sourceProperty`, which will be either `body` or `subject`. * * [Api set: Mailbox 1.2] * * @returns - * The selected data as a string with format determined by coercionType. + * The selected data as a string with format determined by `coercionType`. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * If HTML, the method returns the selected text, whether it is plaintext or HTML. + * @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. - * 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. + * `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`. */ getSelectedDataAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * * If there is no selection but the cursor is in the body or subject, the method returns an empty string for the selected data. - * If a field other than the body or subject is selected, the method returns the InvalidSelection error. + * If a field other than the body or subject is selected, the method returns the `InvalidSelection` error. * - * To access the selected data from the callback method, call asyncResult.value.data. - * To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject. + * To access the selected data from the callback method, call `asyncResult.value.data`. + * To access the source property that the selection comes from, call `asyncResult.value.sourceProperty`, which will be either `body` or `subject`. * * [Api set: Mailbox 1.2] * * @returns - * The selected data as a string with format determined by coercionType. + * The selected data as a string with format determined by `coercionType`. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * If HTML, the method returns the selected text, whether it is plaintext or HTML. - * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. + * @param coercionType - Requests a format for the data. If `Text`, the method returns the plain text as a string, removing any HTML tags present. + * If `Html`, the method returns the selected text, whether it is plaintext or HTML. + * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of + * type `Office.AsyncResult`. */ getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -13974,15 +14008,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * @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. - * The `value` property of the result is the properties of the shared item. + * `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`. The `value` property of the result is the properties of the shared item. */ getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -13994,42 +14027,41 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * type Office.AsyncResult. - * The `value` property of the result is the properties of the shared item. + * @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. */ getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously loads custom properties for this add-in on the selected item. * * Custom properties are stored as key/value pairs on a per-app, per-item basis. - * This method returns a CustomProperties object in the callback, which provides methods to access the custom properties specific to the + * This method returns a `CustomProperties` object in the callback, which provides methods to access the custom properties specific to the * current item and the current add-in. Custom properties are not encrypted on the item, so this should not be used as secure storage. * - * The custom properties are provided as a CustomProperties object in the asyncResult.value property. + * The custom properties are provided as a `CustomProperties` object in the `asyncResult.value` property. * This object can be used to get, set, and remove custom properties from the item and save changes to the custom property set back to * the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * type Office.AsyncResult. - * @param userContext - Optional. Developers can provide any object they wish to access in the callback function. - * This object can be accessed by the asyncResult.asyncContext property in the callback function. + * @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. + * This object can be accessed by the `asyncResult.asyncContext` property in the callback function. */ loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any): void; /** * Removes an attachment from a message or appointment. * - * The removeAttachmentAsync method removes the attachment with the specified identifier from the item. + * The `removeAttachmentAsync` method removes the attachment with the specified identifier from the item. * As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment * in the same session. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session. * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to @@ -14039,26 +14071,26 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: 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. - * 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. - * If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + * `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`. 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?: (asyncResult: Office.AsyncResult) => void): void; /** * Removes an attachment from a message or appointment. * - * The removeAttachmentAsync method removes the attachment with the specified identifier from the item. + * The `removeAttachmentAsync` method removes the attachment with the specified identifier from the item. * As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment * in the same session. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session. * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to @@ -14068,18 +14100,18 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: 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 Office.AsyncResult. - * If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + * @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?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14091,15 +14123,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * @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. + * `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. */ removeHandlerAsync(eventType: Office.EventType | string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14111,83 +14143,83 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 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 | string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. * - * When invoked, this method saves the current message as a draft and returns the item id via the callback method. - * In Outlook on the web or Outlook in online mode, the item is saved to the server. + * When invoked, this method saves the current message as a draft and returns the item ID via the callback method. + * In Outlook on the web or Outlook in online mode, the item is saved to the server. * In Outlook in cached mode, the item is saved to the local cache. * - * Since appointments have no draft state, if saveAsync is called on an appointment in compose mode, the item will be saved as a normal - * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. + * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item will be saved as a normal + * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. * Saving an existing appointment will send an update to added or removed attendees. * - * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that - * when Outlook is in cached mode, it may take some time before the item is actually synced to the server. + * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware + * that when Outlook is in cached mode, it may take some time before the item is actually synced to the server. * Until the item is synced, using the itemId will return an error. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * * @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. + * `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`. */ saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. * - * When invoked, this method saves the current message as a draft and returns the item id via the callback method. - * In Outlook on the web or Outlook in online mode, the item is saved to the server. + * When invoked, this method saves the current message as a draft and returns the item id via the callback method. + * In Outlook on the web or Outlook in online mode, the item is saved to the server. * In Outlook in cached mode, the item is saved to the local cache. * - * Since appointments have no draft state, if saveAsync is called on an appointment in compose mode, the item will be saved as a normal - * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. + * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item will be saved as a normal + * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. * Saving an existing appointment will send an update to added or removed attendees. * - * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that - * when Outlook is in cached mode, it may take some time before the item is actually synced to the server. - * Until the item is synced, using the itemId will return an error. + * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware + * that when Outlook is in cached mode, it may take some time before the item is actually synced to the server. + * Until the item is synced, using the `itemId` will return an error. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * - * @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`. */ saveAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * - * The setSelectedDataAsync method inserts the specified string at the cursor location in the subject or body of the item, or, if text is + * The `setSelectedDataAsync` method inserts the specified string at the cursor location in the subject or body of the item, or, if text is * selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. * After insertion, the cursor is placed at the end of the inserted content. * @@ -14195,51 +14227,51 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * * @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. + * 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. - * asyncContext: Developers can provide any object they wish to access in the callback method. - * coercionType: If text, the current style is applied in Outlook on the web and desktop clients. + * `asyncContext`: Developers can provide any object they wish to access in the callback method. + * `coercionType`: If text, the current style is applied in Outlook on the web and desktop clients. * If the field is an HTML editor, only the text data is inserted, even if the data is HTML. - * If html and the field supports HTML (the subject doesn't), the current style is applied in Outlook on the web and the default style is - * applied in Outlook on desktop clients. 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 - * type Office.AsyncResult. + * If html and the field supports HTML (the subject doesn't), the current style is applied in Outlook on the web and the default style is + * applied in Outlook on desktop clients. 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 + * type `Office.AsyncResult`. */ setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * - * The setSelectedDataAsync method inserts the specified string at the cursor location in the subject or body of the item, or, if text is - * selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. + * The `setSelectedDataAsync` method inserts the specified string at the cursor location in the subject or body of the item, or, if text is + * selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. * After insertion, the cursor is placed at the end of the inserted content. * * [Api set: Mailbox 1.2] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * * @param data - The data to be inserted. Data is not to exceed 1,000,000 characters. - * If more than 1,000,000 characters are passed in, an ArgumentOutOfRange exception is thrown. - * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. + * If more than 1,000,000 characters are passed in, an `ArgumentOutOfRange` exception is thrown. + * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of + * type `Office.AsyncResult`. */ setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void): void; } @@ -14247,7 +14279,7 @@ declare namespace Office { * The message read mode of {@link Office.Item | Office.context.mailbox.item}. * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. - * You should treat this as a mode of Office.context.mailbox.item. Refer to the + * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/preview-requirement-set/office.context.mailbox.item | Object Model} page for more information. * * Parent interfaces: @@ -14262,9 +14294,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read * * **Note**: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned. * For more information, see @@ -14279,9 +14311,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ body: Body; /** @@ -14293,40 +14325,40 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ categories: Categories; /** * 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. * - * The cc property returns an array that contains an EmailAddressDetails object for each recipient listed on the Cc line of the message. + * The `cc` property returns an array that contains an `EmailAddressDetails` object for each recipient listed on the Cc line of the message. * By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, you can get 500 members maximum. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ cc: EmailAddressDetails[]; /** * Gets an identifier for the email conversation that contains a particular message. * - * You can get an integer for this property if your mail app is activated in read forms or responses in compose forms. - * If subsequently the user changes the subject of the reply message, upon sending the reply, the conversation ID for that message will change + * You can get an integer for this property if your mail app is activated in read forms or responses in compose forms. + * If subsequently the user changes the subject of the reply message, upon sending the reply, the conversation ID for that message will change * and that value you obtained earlier will no longer apply. * - * You get null for this property for a new item in a compose form. - * If the user sets a subject and saves the item, the conversationId property will return a value. + * You get null for this property for a new item in a compose form. + * If the user sets a subject and saves the item, the `conversationId` property will return a value. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ conversationId: string; /** @@ -14334,9 +14366,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ dateTimeCreated: Date; /** @@ -14346,67 +14378,67 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ dateTimeModified: Date; /** * Gets the date and time that the appointment is to end. * - * The end property is a Date object expressed as a Coordinated Universal Time (UTC) date and time value. - * You can use the convertToLocalClientTime method to convert the end property value to the client's local date and time. + * The `end` property is a `Date` object expressed as a Coordinated Universal Time (UTC) date and time value. + * You can use the `convertToLocalClientTime` method to convert the `end` property value to the client's local date and time. * - * When you use the Time.setAsync method to set the end time, you should use the convertToUtcClientTime method to convert the local time on + * When you use the `Time.setAsync` method to set the end time, you should use the `convertToUtcClientTime` method to convert the local time on * the client to UTC for the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ end: Date; /** * Gets the email address of the sender of a message. * - * The from and sender properties represent the same person unless the message is sent by a delegate. - * In that case, the from property represents the delegator, and the sender property represents the delegate. + * The `from` and `sender` properties represent the same person unless the message is sent by a delegate. + * In that case, the `from` property represents the delegator, and the `sender` property represents the delegate. * - * **Note**: The recipientType property of the EmailAddressDetails object in the from property is undefined. + * **Note**: The `recipientType` property of the `EmailAddressDetails` object in the `from` property is undefined. * - * The from property returns an EmailAddressDetails object. + * The `from` property returns an `EmailAddressDetails` object. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ from: EmailAddressDetails; /** - * Gets the Internet message identifier for an email message. + * Gets the internet message identifier for an email message. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ internetMessageId: string; /** * Gets the Exchange Web Services item class of the selected item. * - * You can create custom message classes that extends a default message class, for example, a custom appointment message class - * IPM.Appointment.Contoso. + * You can create custom message classes that extends a default message class, for example, a custom appointment message class + * `IPM.Appointment.Contoso`. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read - - * The itemClass property specifies the message class of the selected item. + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * The `itemClass` property specifies the message class of the selected item. * The following are the default message classes for the message or appointment item. * *
@@ -14433,60 +14465,59 @@ declare namespace Office { * Gets the {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services item identifier} * for the current item. * - * 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. + * 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. * - * **Note**: The identifier returned by the itemId property is the same as the - * {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | 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. - * Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId. - * For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api#get-the-item-id | Use the Outlook REST APIs from an Outlook add-in}. + * **Note**: The identifier returned by the `itemId` property is the same as the + * {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | 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. + * Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`. + * For more details, see {@link https://docs.microsoft.com/office/dev/add-ins/outlook/use-rest-api#get-the-item-id | Use the Outlook REST APIs from an Outlook add-in}. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ itemId: string; /** * Gets the type of item that an instance represents. * - * The itemType property returns one of the ItemType enumeration values, indicating whether the item object instance is a message or + * The `itemType` property returns one of the `ItemType` enumeration values, indicating whether the item object instance is a message or * an appointment. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ itemType: MailboxEnums.ItemType | string; /** * Gets the location of a meeting request. * - * The location property returns a string that contains the location of the appointment. + * The `location` property returns a string that contains the location of the appointment. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ location: string; /** * Gets the subject of an item, with all prefixes removed (including RE: and FWD:). * - * The normalizedSubject property gets the subject of the item, with any standard prefixes (such as RE: and FW:) that are added by - * email programs. - * To get the subject of the item with the prefixes intact, use the subject property. + * The `normalizedSubject` property gets the subject of the item, with any standard prefixes (such as RE: and FW:) that are added by + * email programs. To get the subject of the item with the prefixes intact, use the `subject` property. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ normalizedSubject: string; /** @@ -14496,110 +14527,110 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ notificationMessages: NotificationMessages; /** - * Gets the recurrence pattern of an appointment. Gets the recurrence pattern of a meeting request. + * 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. * - * The recurrence property returns a recurrence object for recurring appointments or meetings requests if an item is a series or an instance - * in a series. `null` is returned for single appointments and meeting requests of single appointments. + * The `recurrence` property returns a `Recurrence` object for recurring appointments or meetings requests if an item is a series or an instance + * in a series. `null` is returned for single appointments and meeting requests of single appointments. * `undefined` is returned for messages that are not meeting requests. * - * **Note**: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request. + * **Note**: Meeting requests have an itemClass value of `IPM.Schedule.Meeting.Request`. * - * **Note**: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single appointment + * **Note**: If the `recurrence` object is null, this indicates that the object is a single appointment or a meeting request of a single appointment * and NOT a part of a series. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ recurrence: Recurrence; /** * Gets the id of the series that an instance belongs to. * - * In Outlook on the web and desktop clients, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to. - * However, on iOS and Android, the seriesId returns the REST ID of the parent item. + * In Outlook on the web and desktop clients, the `seriesId` returns the Exchange Web Services (EWS) ID of the parent (series) item + * that this item belongs to. However, on iOS and Android, the `seriesId` returns the REST ID of the parent item. * - * **Note**: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier. - * The seriesId property is not identical to the Outlook IDs used by the Outlook REST API. - * Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId. - * For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. + * **Note**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier. + * The `seriesId` property is not identical to the Outlook IDs used by the Outlook REST API. + * Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`. + * For more details, see {@link https://docs.microsoft.com/office/dev/add-ins/outlook/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. * - * The seriesId property returns null for items that do not have parent items such as single appointments, series items, or meeting requests - * and returns undefined for any other items that are not meeting requests. + * The `seriesId` property returns `null` for items that do not have parent items such as single appointments, series items, or meeting requests + * and returns `undefined` for any other items that are not meeting requests. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ seriesId: string; /** * Gets the email address of the sender of an email message. * - * The from and sender properties represent the same person unless the message is sent by a delegate. - * In that case, the from property represents the delegator, and the sender property represents the delegate. + * The `from` and `sender` properties represent the same person unless the message is sent by a delegate. + * In that case, the `from` property represents the delegator, and the `sender` property represents the delegate. * - * **Note**: The recipientType property of the EmailAddressDetails object in the sender property is undefined. + * **Note**: The `recipientType` property of the `EmailAddressDetails` object in the `sender` property is undefined. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ sender: EmailAddressDetails; /** * Gets the date and time that the appointment is to begin. * - * The start property is a Date object expressed as a Coordinated Universal Time (UTC) date and time value. - * You can use the convertToLocalClientTime method to convert the value to the client's local date and time. + * The `start` property is a `Date` object expressed as a Coordinated Universal Time (UTC) date and time value. + * You can use the `convertToLocalClientTime` method to convert the value to the client's local date and time. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ start: Date; /** * Gets the description that appears in the subject field of an item. * - * The subject property gets or sets the entire subject of the item, as sent by the email server. + * The `subject` property gets or sets the entire subject of the item, as sent by the email server. * - * The subject property returns a string. Use the normalizedSubject property to get the subject minus any leading prefixes such as RE: and FW:. + * The `subject` property returns a string. Use the `normalizedSubject` property to get the subject minus any leading prefixes such as RE: and FW:. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ subject: string; /** - * Provides access to the recipients on the To line of a message. The type of object and level of access depends on the mode of the + * Provides access to the recipients on the To line of a message. The type of object and level of access depends on the mode of the * current item. * - * The to property returns an array that contains an EmailAddressDetails object for each recipient listed on the To line of the message. + * The `to` property returns an array that contains an `EmailAddressDetails` object for each recipient listed on the To line of the message. * By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, you can get 500 members maximum. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ to: EmailAddressDetails[]; @@ -14612,17 +14643,17 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * The type property on the parameter will match the eventType parameter passed to addHandlerAsync. + * @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. - * 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. + * `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. */ addHandlerAsync(eventType: Office.EventType | string, handler: any, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14634,15 +14665,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * 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 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. */ addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14651,24 +14682,24 @@ declare namespace Office { * * In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2- or 1-column view. * - * If any of the string parameters exceed their limits, displayReplyAllForm throws an exception. + * If any of the string parameters exceed their limits, `displayReplyAllForm` throws an exception. * - * When attachments are specified in the formData.attachments parameter, Outlook on the web and desktop clients attempt to download all attachments and - * attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. + * When attachments are specified in the `formData.attachments` parameter, Outlook on the web and desktop clients attempt to download + * all attachments and attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. * If this isn't possible, then no error message is thrown. * * **Note**: This method is not supported in Outlook on iOS or Android. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. - * @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. */ displayReplyAllForm(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14676,24 +14707,24 @@ declare namespace Office { * * In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2- or 1-column view. * - * If any of the string parameters exceed their limits, displayReplyForm throws an exception. + * If any of the string parameters exceed their limits, `displayReplyForm` throws an exception. * - * When attachments are specified in the formData.attachments parameter, Outlook on the web and desktop clients attempt to download all attachments and - * attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. + * When attachments are specified in the `formData.attachments` parameter, Outlook on the web and desktop clients attempt to download + * all attachments and attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. * If this isn't possible, then no error message is thrown. * * **Note**: This method is not supported in Outlook on iOS or Android. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. - * @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. */ displayReplyForm(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14703,17 +14734,17 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read * * @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. - * On success, the internet headers data is provided in the asyncResult.value property as a string. - * Refer to {@link https://tools.ietf.org/html/rfc2183 | RFC 2183} for the formatting information of the returned string value. - * If the call fails, the asyncResult.error property will contain an error code with the reason for the failure. + * `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. + * On success, the internet headers data is provided in the `asyncResult.value` property as a string. + * Refer to {@link https://tools.ietf.org/html/rfc2183 | RFC 2183} for the formatting information of the returned string value. + * If the call fails, the `asyncResult.error` property will contain an error code with the reason for the failure. */ getAllInternetHeadersAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14723,19 +14754,19 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 internet headers data is provided in the asyncResult.value property as a string. * Refer to {@link https://tools.ietf.org/html/rfc2183 | RFC 2183} for the formatting information of the returned string value. - * If the call fails, the asyncResult.error property will contain an error code with the reason for the failure. + * If the call fails, the `asyncResult.error` property will contain an error code with the reason for the failure. */ getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** - * Gets an attachment from a message or appointment and returns it as an **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 @@ -14747,27 +14778,27 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read * * **Errors**: * - * - AttachmentTypeNotSupported: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, + * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, * or item attachment types other than email or calendar items (such as a contact or task item). * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: 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. - * 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 - * with the reason for the failure. + * `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 + * an error code with the reason for the failure. */ getAttachmentContentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** - * Gets an attachment from a message or appointment and returns it as an **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 @@ -14779,69 +14810,69 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read * * **Errors**: * - * - AttachmentTypeNotSupported: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, + * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, * or item attachment types other than email or calendar items (such as a contact or task item). * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * - * @param attachmentId - The identifier of the attachment you want to get. - * @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. + * @param attachmentId - The identifier of the attachment you want to get. + * @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 + * an error code with the reason for the failure. */ getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** - * Gets initialization data passed when the add-in is + * 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}. * - * **Note**: This method is only supported by Outlook 2016 or later on Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web - * for Office 365. + * **Note**: This method is only supported by Outlook 2016 or later on Windows (Click-to-Run versions greater than 16.0.8413.1000) + * and Outlook on the web for Office 365. * * [Api set: Mailbox Preview] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read * * @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. - * 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. + * `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. + * 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?: (asyncResult: Office.AsyncResult) => void): void; /** - * Gets initialization data passed when the add-in is + * 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}. * - * **Note**: This method is only supported by Outlook 2016 or later on Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the - * web for Office 365. + * **Note**: This method is only supported by Outlook 2016 or later on Windows (Click-to-Run versions greater than 16.0.8413.1000) + * and Outlook on the web for Office 365. * * [Api set: Mailbox Preview] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * 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. + * @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 */ @@ -14853,30 +14884,30 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ getEntities(): Entities; /** * Gets an array of all the entities of the specified entity type found in the selected item's body. * * **Note**: This method is not supported in Outlook on iOS or Android. - * - * @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. + * If the value passed in `entityType` is not a valid member of the `EntityType` enumeration, the method returns `null`. * If no entities of the specified type are present in the item's body, the method returns an empty array. - * Otherwise, the type of the objects in the returned array depends on the type of entity requested in the entityType parameter. + * Otherwise, the type of the objects in the returned array depends on the type of entity requested in the `entityType` parameter. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @param entityType - One of the `EntityType` enumeration values. * - * While the minimum permission level to use this method is Restricted, some entity types require ReadItem to access, as specified in the + * While the minimum permission level to use this method is `Restricted`, some entity types require `ReadItem` to access, as specified in the * following table. * *
@@ -14926,59 +14957,60 @@ declare namespace Office { /** * Returns well-known entities in the selected item that pass the named filter defined in the manifest XML file. * - * The getFilteredEntitiesByName method returns the entities that match the regular expression defined in the ItemHasKnownEntity rule element - * in the manifest XML file with the specified FilterName element value. + * The `getFilteredEntitiesByName` method returns the entities that match the regular expression defined in the `ItemHasKnownEntity` rule element + * in the manifest XML file with the specified `FilterName` element value. * * **Note**: This method is not supported in Outlook on iOS or Android. + * + * @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, + * the method return an empty array. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read * - * @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, - * the method return an empty array. + * @param name - The name of the `ItemHasKnownEntity` rule element that defines the filter to match. */ getFilteredEntitiesByName(name: string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; /** * Returns string values in the selected item that match the regular expressions defined in the manifest XML file. * - * The getRegExMatches method returns the strings that match the regular expression defined in each ItemHasRegularExpressionMatch or - * ItemHasKnownEntity rule element in the manifest XML file. - * For an ItemHasRegularExpressionMatch rule, a matching string has to occur in the property of the item that is specified by that rule. - * The PropertyName simple type defines the supported properties. + * The `getRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or + * `ItemHasKnownEntity` rule element in the manifest XML file. + * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that is specified by that rule. + * The `PropertyName` simple type defines the supported properties. * - * If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body - * and should not attempt to return the entire body of the item. - * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. - * Instead, use the Body.getAsync method to retrieve the entire body. + * If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter + * the body and should not attempt to return the entire body of the item. + * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. + * Instead, use the `Body.getAsync` method to retrieve the entire body. * * **Note**: This method is not supported in Outlook on iOS or Android. * * @returns * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file. - * The name of each array is equal to the corresponding value of the RegExName attribute of the matching ItemHasRegularExpressionMatch rule - * or the FilterName attribute of the matching ItemHasKnownEntity rule. + * The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule + * or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ getRegExMatches(): any; /** * Returns string values in the selected item that match the named regular expression defined in the manifest XML file. * - * The getRegExMatchesByName method returns the strings that match the regular expression defined in the ItemHasRegularExpressionMatch rule - * element in the manifest XML file with the specified RegExName element value. + * The `getRegExMatchesByName` method returns the strings that match the regular expression defined in the + * `ItemHasRegularExpressionMatch` rule element in the manifest XML file with the specified `RegExName` element value. * - * If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body - * and should not attempt to return the entire body of the item. + * If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter + * the body and should not attempt to return the entire body of the item. * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. * * **Note**: This method is not supported in Outlook on iOS or Android. @@ -14988,11 +15020,11 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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[]; /** @@ -15004,26 +15036,26 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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; /** * Returns string values in a highlighted match that match the regular expressions defined in the manifest XML file. * Highlighted matches apply to contextual add-ins. * - * The getSelectedRegExMatches method returns the strings that match the regular expression defined in each ItemHasRegularExpressionMatch or - * ItemHasKnownEntity rule element in the manifest XML file. - * For an ItemHasRegularExpressionMatch rule, a matching string has to occur in the property of the item that is specified by that rule. - * The PropertyName simple type defines the supported properties. + * The `getSelectedRegExMatches` method returns the strings that match the regular expression defined in + * each `ItemHasRegularExpressionMatch` or `ItemHasKnownEntity` rule element in the manifest XML file. + * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that is specified by that rule. + * The `PropertyName` simple type defines the supported properties. * - * If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body - * and should not attempt to return the entire body of the item. - * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. - * Instead, use the Body.getAsync method to retrieve the entire body. + * If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body + * and should not attempt to return the entire body of the item. + * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. + * Instead, use the `Body.getAsync` method to retrieve the entire body. * * **Note**: This method is not supported in Outlook on iOS or Android. * @@ -15031,14 +15063,14 @@ declare namespace Office { * * @returns * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file. - * The name of each array is equal to the corresponding value of the RegExName attribute of the matching ItemHasRegularExpressionMatch rule or - * the FilterName attribute of the matching ItemHasKnownEntity rule. + * The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule or + * the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ getSelectedRegExMatches(): any; /** @@ -15050,15 +15082,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read * * @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. - * The `value` property of the result is the properties of the shared item. + * `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`. The `value` property of the result is the properties of the shared item. */ getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -15070,36 +15101,34 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * type Office.AsyncResult. - * The `value` property of the result is the properties of the shared item. + * @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. */ getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously loads custom properties for this add-in on the selected item. * * Custom properties are stored as key/value pairs on a per-app, per-item basis. - * This method returns a CustomProperties object in the callback, which provides methods to access the custom properties specific to the + * This method returns a `CustomProperties` object in the callback, which provides methods to access the custom properties specific to the * current item and the current add-in. Custom properties are not encrypted on the item, so this should not be used as secure storage. * - * The custom properties are provided as a CustomProperties object in the asyncResult.value property. - * This object can be used to get, set, and remove custom properties from the item and save changes to the custom property set back to - * the server. + * The custom properties are provided as a `CustomProperties` object in the `asyncResult.value` property. + * This object can be used to get, set, and remove custom properties from the item and save changes to the custom property set back to the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * 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`. * @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. + * This object can be accessed by the `asyncResult.asyncContext` property in the callback function. */ loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any): void; /** @@ -15111,15 +15140,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read * * @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. + * `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. */ removeHandlerAsync(eventType: Office.EventType | string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -15131,26 +15160,26 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 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 | string, callback?: (asyncResult: Office.AsyncResult) => void): void; } /** - * An array of NotificationMessageDetails objects are returned by the NotificationMessages.getAllAsync method. + * An array of `NotificationMessageDetails` objects are returned by the `NotificationMessages.getAllAsync` method. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface NotificationMessageDetails { /** @@ -15158,86 +15187,86 @@ declare namespace Office { */ key?: string; /** - * Specifies the ItemNotificationMessageType of message. If type is ProgressIndicator or ErrorMessage, an icon is automatically supplied and - * the message is not persistent. Therefore the icon and persistent properties are not valid for these types of messages. - * 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. + * Specifies the `ItemNotificationMessageType` of message. If type is `ProgressIndicator` or `ErrorMessage`, an icon is automatically supplied + * and the message is not persistent. Therefore the icon and persistent properties are not valid for these types of messages. + * 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: MailboxEnums.ItemNotificationMessageType | string; /** - * 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. + * 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. * * **Note**: At present, the custom icon is displayed in Outlook on Windows only and not on other clients (e.g., Mac, web browser). */ icon?: string; /** - * The text of the notification message. Maximum length is 150 characters. - * If the developer passes in a longer string, an ArgumentOutOfRange exception is thrown. + * The text of the notification message. Maximum length is 150 characters. + * If the developer passes in a longer string, an `ArgumentOutOfRange` exception is thrown. */ message: string; /** - * Only applicable when type is InformationalMessage. If true, the message remains until removed by this add-in or dismissed by the user. - * If false, it is removed when the user navigates to a different item. - * For error notifications, the message persists until the user sees it once. + * Only applicable when type is `InformationalMessage`. If true, the message remains until removed by this add-in or dismissed by the user. + * If false, it is removed when the user navigates to a different item. + * For error notifications, the message persists until the user sees it once. * Specifying this parameter for an unsupported type throws an exception. */ persistent?: Boolean; } /** - * The NotificationMessages object is returned as the notificationMessages property of an item. + * The `NotificationMessages` object is returned as the `notificationMessages` property of an item. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface NotificationMessages { /** * 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. It can't be longer than 32 characters. - * @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. - * 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. + * There are a maximum of 5 notifications per message. Setting more will return a `NumberOfNotificationMessagesExceeded` error. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * @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. + * It contains a `NotificationMessageDetails` 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 + * of type `Office.AsyncResult`. */ addAsync(key: string, JSONmessage: NotificationMessageDetails, options?: Office.AsyncContextOptions, callback?: (asyncResult: 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. - * It can't be longer than 32 characters. - * @param JSONmessage - A JSON object that contains the notification message to be added to the item. - * It contains a NotificationMessageDetails object. - * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. + * There are a maximum of 5 notifications per message. Setting more will return a `NumberOfNotificationMessagesExceeded` error. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * @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. + * It contains a `NotificationMessageDetails` object. + * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter + * of type `Office.AsyncResult`. */ addAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -15247,14 +15276,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * @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. - * The `value` property of the result is an array of NotificationMessageDetails objects. + * `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`. The `value` property of the result is an array of `NotificationMessageDetails` objects. */ getAllAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -15264,12 +15293,12 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * The `value` property of the result is an array of NotificationMessageDetails objects. + * @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?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -15279,15 +15308,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * 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. + * `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`. */ removeAsync(key: string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -15297,55 +15326,55 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * 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`. */ removeAsync(key: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Replaces a notification message that has a given key with another message. * - * If a notification message with the specified key doesn't exist, replaceAsync will add the notification. + * If a notification message with the specified key doesn't exist, `replaceAsync` will add the notification. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * It contains a NotificationMessageDetails object. + * It contains a `NotificationMessageDetails` 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 of - * type Office.AsyncResult. + * `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`. */ replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Replaces a notification message that has a given key with another message. * - * If a notification message with the specified key doesn't exist, replaceAsync will add the notification. + * If a notification message with the specified key doesn't exist, `replaceAsync` will add the notification. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * It contains a NotificationMessageDetails object. - * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. + * It contains a `NotificationMessageDetails` object. + * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter + * of type `Office.AsyncResult`. */ replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult) => void): void; } @@ -15378,26 +15407,28 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose */ interface Organizer { /** - * Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails | EmailAddressDetails} object in the asyncResult.value property. + * Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails | EmailAddressDetails} object + * in the `asyncResult.value` property. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. - * The `value` property of the result is the appointment's organizer value, as an EmailAddressDetails object. + * `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. The `value` property of the result is the appointment's organizer value, + * as an `EmailAddressDetails` object. */ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -15407,30 +15438,32 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 AsyncResult object. - * The `value` property of the result is the appointment's organizer value, as an EmailAddressDetails 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 the appointment's organizer value, + * as an `EmailAddressDetails` object. */ getAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; } /** * Represents a phone number identified in an item. Read mode only. * - * An array of PhoneNumber objects containing the phone numbers found in an email message is returned in the phoneNumbers property of the - * Entities object that is returned when you call the getEntities method on the selected item. + * An array of `PhoneNumber` objects containing the phone numbers found in an email message is returned in the `phoneNumbers` property of the + * `Entities` object that is returned when you call the `getEntities` method on the selected item. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read */ interface PhoneNumber { /** - * Gets a string containing a phone number. This string contains only the digits of the telephone number and excludes characters like parentheses and hyphens, if they exist in the original item. + * Gets a string containing a phone number. This string contains only the digits of the telephone number and excludes characters + * like parentheses and hyphens, if they exist in the original item. */ phoneString: string; /** @@ -15443,13 +15476,15 @@ declare namespace Office { type: string; } /** + * Represents recipients of an item. Compose mode only. + * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose */ interface Recipients { /** @@ -15459,27 +15494,27 @@ declare namespace Office { * * - Strings containing SMTP email addresses * - * - EmailUser objects + * - {@link Office.EmailUser | EmailUser} objects * - * - EmailAddressDetails objects + * - {@link Office.EmailAddressDetails | EmailAddressDetails} objects * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - NumberOfRecipientsExceeded: The number of recipients exceeded 100 entries. + * - `NumberOfRecipientsExceeded`: 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. - * 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. If adding the recipients fails, the asyncResult.error property will contain an error code. + * `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`. If adding the recipients fails, the `asyncResult.error` property will contain an error code. */ addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -15497,61 +15532,61 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - NumberOfRecipientsExceeded: The number of recipients exceeded 100 entries. + * - `NumberOfRecipientsExceeded`: 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 - * type Office.AsyncResult. If adding the recipients fails, the asyncResult.error property will contain an error code. + * @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?: (asyncResult: Office.AsyncResult) => void): void; /** * Gets a recipient list for an appointment or message. * - * When the call completes, the asyncResult.value property will contain an array of {@link Office.EmailAddressDetails | EmailAddressDetails} objects. + * When the call completes, the `asyncResult.value` property will contain + * an array of {@link Office.EmailAddressDetails | EmailAddressDetails} objects. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. - * The `value` property of the result is an array of EmailAddressDetails objects. + * `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`. The `value` property of the result is an array of `EmailAddressDetails` objects. */ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** * Gets a recipient list for an appointment or message. * - * When the call completes, the asyncResult.value property will contain an array of {@link Office.EmailAddressDetails | EmailAddressDetails} objects. + * When the call completes, the asyncResult.value property will contain + * an array of {@link Office.EmailAddressDetails | EmailAddressDetails} objects. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 Office.AsyncResult. - * The `value` property of the result is an array of EmailAddressDetails objects. + * @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: (asyncResult: Office.AsyncResult) => void): void; /** * Sets a recipient list for an appointment or message. * - * The setAsync method overwrites the current recipient list. + * The `setAsync` method overwrites the current recipient list. * * The recipients parameter can be an array of one of the following: * @@ -15565,27 +15600,26 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - NumberOfRecipientsExceeded: The number of recipients exceeded 100 entries. + * - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries. * * @param recipients - The recipients to add to the recipients list. * @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. - * If setting the recipients fails the asyncResult.error property will contain a code that indicates any error that occurred - * while adding the data. + * `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`. 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: (asyncResult: Office.AsyncResult) => void): void; /** * Sets a recipient list for an appointment or message. * - * The setAsync method overwrites the current recipient list. + * The `setAsync` method overwrites the current recipient list. * * The recipients parameter can be an array of one of the following: * @@ -15599,19 +15633,18 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - NumberOfRecipientsExceeded: The number of recipients exceeded 100 entries. + * - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries. * * @param recipients - The recipients to add to the recipients list. - * @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 recipients fails the asyncResult.error property will contain a code that indicates any error that occurred - * while adding the data. + * @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 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: (asyncResult: Office.AsyncResult) => void): void; } @@ -15678,17 +15711,17 @@ declare namespace Office { to: boolean; } /** - * The recurrence object provides methods to get and set the recurrence pattern of appointments but only get the recurrence pattern of + * The `Recurrence` object provides methods to get and set the recurrence pattern of appointments but only get the recurrence pattern of * meeting requests. - * It will have a dictionary with the following keys: seriesTime, recurrenceType, recurrenceProperties, and recurrenceTimeZone (optional). + * It will have a dictionary with the following keys: `seriesTime`, `recurrenceType`, `recurrenceProperties`, and `recurrenceTimeZone` (optional). * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * **States** * @@ -15738,9 +15771,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ recurrenceProperties: RecurrenceProperties; /** @@ -15750,9 +15783,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ recurrenceTimeZone: RecurrenceTimeZone; /** @@ -15762,108 +15795,106 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ recurrenceType: MailboxEnums.RecurrenceType | string; /** - * The {@link Office.SeriesTime | SeriesTime} object enables you to manage the start and end dates of the recurring appointment series and the usual start - * and end times of instances. **This object is not in UTC time.** - * Instead, it is set in the time zone specified by the recurrenceTimeZone value or defaulted to the item's time zone. + * The {@link Office.SeriesTime | SeriesTime} object enables you to manage the start and end dates of the recurring appointment series and + * the usual start and end times of instances. **This object is not in UTC time.** + * Instead, it is set in the time zone specified by the `recurrenceTimeZone` value or defaulted to the item's time zone. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ seriesTime: SeriesTime; /** * Returns the current recurrence object of an appointment series. * - * This method returns the entire recurrence object for the appointment series. + * This method returns the entire `Recurrence` object for the appointment series. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * @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. - * The `value` property of the result is a Recurrence object. + * `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. The `value` property of the result is a `Recurrence` object. */ getAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Returns the current recurrence object of an appointment series. * - * This method returns the entire recurrence object for the appointment series. + * This method returns the entire `Recurrence` object for the appointment series. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * The `value` property of the result is 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. The `value` property of the result is a `Recurrence` object. */ getAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Sets the recurrence pattern of an appointment series. * - * **Note**: setAsync should only be available for series items and not instance items. + * **Note**: `setAsync` should only be available for series items and not instance items. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - InvalidEndTime: The appointment end time is before its start time. + * - `InvalidEndTime`: The appointment end time is before its start time. * * @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. + * `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. */ setAsync(recurrencePattern: Recurrence, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Sets the recurrence pattern of an appointment series. * - * **Note**: setAsync should only be available for series items and not instance items. + * **Note**: `setAsync` should only be available for series items and not instance items. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - InvalidEndTime: The appointment end time is before its start time. + * - `InvalidEndTime`: 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 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?: (asyncResult: Office.AsyncResult) => void): void; } @@ -15893,9 +15924,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface RecurrenceProperties { /** @@ -15935,9 +15966,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface RecurrenceTimeZone { /** @@ -15995,7 +16026,7 @@ declare namespace Office { callback?: (asyncResult: Office.AsyncResult) => void; } /** - * The settings created by using the methods of the RoamingSettings object are saved per add-in and per user. + * The settings created by using the methods of the `RoamingSettings` object are saved per add-in and per user. * That is, they are available only to the add-in that created them, and only from the user's mail box in which they are saved. * * While the Outlook Add-in API limits access to these settings to only the add-in that created them, these settings should not be considered @@ -16004,9 +16035,9 @@ declare namespace Office { * * The name of a setting is a String, while the value can be a String, Number, Boolean, null, Object, or Array. * - * The RoamingSettings object is accessible via the roamingSettings property in the Office.context namespace. + * The `RoamingSettings` object is accessible via the `roamingSettings` property in the `Office.context` namespace. * - * **Important**: The RoamingSettings object is initialized from the persisted storage only when the add-in is first loaded. + * **Important**: The `RoamingSettings` object is initialized from the persisted storage only when the add-in is first loaded. * For task panes, this means that it is only initialized when the task pane first opens. * If the task pane navigates to another page or reloads the current page, the in-memory object is reset to its initial values, even if * your add-in has persisted changes. @@ -16014,22 +16045,23 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ export interface RoamingSettings { /** * Retrieves the specified setting. * + * @returns Type: String | Number | Boolean | Object | Array + * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * @param name - The case-sensitive name of the setting to retrieve. - * @returns Type: String | Number | Boolean | Object | Array */ get(name: string): any; /** @@ -16037,9 +16069,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * @param name - The case-sensitive name of the setting to remove. */ @@ -16053,29 +16085,29 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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`. */ saveAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Sets or creates the specified setting. * - * The set method creates a new setting of the specified name if it does not already exist, or sets an existing setting of the specified name. + * The `set` method creates a new setting of the specified name if it does not already exist, or sets an existing setting of the specified name. * The value is stored in the document as the serialized JSON representation of its data type. * * A maximum of 32KB is available for the settings of each add-in. * - * Any changes made to settings using the set function will not be saved to the server until the saveAsync function is called. + * Any changes made to settings using the set function will not be saved to the server until the `saveAsync` function is called. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. @@ -16083,16 +16115,16 @@ declare namespace Office { set(name: string, value: any): void; } /** - * The SeriesTime object provides methods to get and set the dates and times of appointments in a recurring series and get the dates and times of - * meeting requests in a recurring series. + * The `SeriesTime` object provides methods to get and set the dates and times of appointments in a recurring series and get the dates and times + * of meeting requests in a recurring series. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface SeriesTime { /** @@ -16102,60 +16134,62 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ getDuration(): number; /** - * Gets the end date of a recurrence pattern in the following {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD" + * Gets the end date of a recurrence pattern in the following + * {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD". * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ getEndDate(): string; /** * Gets the end time of a usual appointment or meeting request instance of a recurrence pattern in whichever time zone that the user or * add-in set the recurrence pattern using the following {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} format: - * "THH:mm:ss:mmm" + * "THH:mm:ss:mmm". * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ getEndTime(): string; /** - * Gets the start date of a recurrence pattern in the following {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD" + * Gets the start date of a recurrence pattern in the following + * {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD". * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ getStartDate(): string; /** - * Gets the start time of a usual appointment instance of a recurrence pattern in whichever time zone that the user/add-in set the - * recurrence pattern using the following {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} format: "THH:mm:ss:mmm" + * Gets the start time of a usual appointment instance of a recurrence pattern in whichever time zone that the user/add-in set the + * recurrence pattern using the following {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} format: "THH:mm:ss:mmm". * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ getStartTime(): string; /** @@ -16165,9 +16199,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param minutes - The length of the appointment in minutes. */ @@ -16179,9 +16213,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. @@ -16195,11 +16229,12 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * - * @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; /** @@ -16209,9 +16244,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. @@ -16225,11 +16260,12 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * - * @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; /** @@ -16240,9 +16276,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. @@ -16256,9 +16292,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param time - Start time of all instances represented by standard datetime string format: "THH:mm:ss:mmm". */ @@ -16271,9 +16307,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface SharedProperties { /** @@ -16282,13 +16318,13 @@ declare namespace Office { owner: string; /** * The REST API's base URL (currently https://outlook.office.com/api). - * Use with targetMailbox to construct REST operation's URL. + * Use with `targetMailbox` to construct REST operation's URL. * * Example usage: `targetRestUrl + "/{api_version}/users/" + targetMailbox + "/{REST_operation}"` */ targetRestUrl: string; /** - * The target/owner's mailbox. Use with targetRestUrl to construct REST operation's URL. + * The target/owner's mailbox. Use with `targetRestUrl` to construct REST operation's URL. * * Example usage: `targetRestUrl + "/{api_version}/users/" + targetMailbox + "/{REST_operation}"` */ @@ -16305,108 +16341,107 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose */ interface Subject { /** * Gets the subject of an appointment or message. * - * The getAsync method starts an asynchronous call to the Exchange server to get the subject of an appointment or message. + * The `getAsync` method starts an asynchronous call to the Exchange server to get the subject of an appointment or message. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. - * The `value` property of the result is the subject of the item. + * `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`. The `value` property of the result is the subject of the item. */ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** * Gets the subject of an appointment or message. * - * The getAsync method starts an asynchronous call to the Exchange server to get the subject of an appointment or message. + * The `getAsync` method starts an asynchronous call to the Exchange server to get the subject of an appointment or message. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 Office.AsyncResult. - * The `value` property of the result is the subject of the item. + * @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: (asyncResult: Office.AsyncResult) => void): void; /** * Sets the subject of an appointment or message. * - * The setAsync method starts an asynchronous call to the Exchange server to set the subject of an appointment or message. + * The `setAsync` method starts an asynchronous call to the Exchange server to set the subject of an appointment or message. * Setting the subject overwrites the current subject, but leaves any prefixes, such as "Fwd:" or "Re:" in place. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - DataExceedsMaximumSize: The subject parameter is longer than 255 characters. + * - `DataExceedsMaximumSize`: 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 - 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. If setting the subject fails, the asyncResult.error property will contain an error code. + * `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`. If setting the subject fails, the `asyncResult.error` property will contain an error code. */ setAsync(subject: string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Sets the subject of an appointment or message. * - * The setAsync method starts an asynchronous call to the Exchange server to set the subject of an appointment or message. + * The `setAsync` method starts an asynchronous call to the Exchange server to set the subject of an appointment or message. * Setting the subject overwrites the current subject, but leaves any prefixes, such as "Fwd:" or "Re:" in place. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - DataExceedsMaximumSize: The subject parameter is longer than 255 characters. + * - `DataExceedsMaximumSize`: 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 - 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 subject fails, the asyncResult.error property will contain an error code. + * @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 subject fails, the `asyncResult.error` property will contain an error code. */ setAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void): void; } /** * Represents a suggested task identified in an item. Read mode only. * - * The list of tasks suggested in an email message is returned in the taskSuggestions property of the {@link Office.Entities | Entities} object - * that is returned when the getEntities or getEntitiesByType method is called on the active item. + * The list of tasks suggested in an email message is returned in the `taskSuggestions` property of the {@link Office.Entities | Entities} object + * that is returned when the `getEntities` or `getEntitiesByType` method is called on the active item. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read */ interface TaskSuggestion { /** @@ -16419,107 +16454,105 @@ declare namespace Office { taskString: string; } /** - * The Time object is returned as the start or end property of an appointment in compose mode. + * The `Time` object is returned as the start or end property of an appointment in compose mode. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose */ interface Time { /** * Gets the start or end time of an appointment. * - * The date and time is provided as a Date object in the asyncResult.value property. The value is in Coordinated Universal Time (UTC). - * You can convert the UTC time to the local client time by using the convertToLocalClientTime method. + * The date and time is provided as a `Date` object in the `asyncResult.value` property. The value is in Coordinated Universal Time (UTC). + * You can convert the UTC time to the local client time by using the `convertToLocalClientTime` method. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. - * The `value` property of the result is a Date object. + * `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`. The `value` property of the result is a `Date` object. */ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** * Gets the start or end time of an appointment. * - * The date and time is provided as a Date object in the asyncResult.value property. The value is in Coordinated Universal Time (UTC). - * You can convert the UTC time to the local client time by using the convertToLocalClientTime method. + * The date and time is provided as a `Date` object in the `asyncResult.value` property. The value is in Coordinated Universal Time (UTC). + * You can convert the UTC time to the local client time by using the `convertToLocalClientTime` method. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 Office.AsyncResult. - * The `value` property of the result is a Date object. + * @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: (asyncResult: Office.AsyncResult) => void): void; /** * Sets the start or end time of an appointment. * - * If the setAsync method is called on the start property, the end property will be adjusted to maintain the duration of the appointment as - * previously set. If the setAsync method is called on the end property, the duration of the appointment will be extended to the new end time. + * If the `setAsync` method is called on the start property, the `end` property will be adjusted to maintain the duration of the appointment as + * previously set. If the `setAsync` method is called on the `end` property, the duration of the appointment will be extended to the new end time. * - * The time must be in UTC; you can get the correct UTC time by using the convertToUtcClientTime method. + * The time must be in UTC; you can get the correct UTC time by using the `convertToUtcClientTime` method. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - InvalidEndTime: The appointment end time is before the appointment start time. + * - `InvalidEndTime`: The appointment end time is before the appointment start time. * * @param dateTime - A date-time object in Coordinated Universal Time (UTC). * @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. - * If setting the date and time fails, the asyncResult.error property will contain an error code. + * `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`. If setting the date and time fails, the `asyncResult.error` property will contain an error code. */ setAsync(dateTime: Date, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Sets the start or end time of an appointment. * - * If the setAsync method is called on the start property, the end property will be adjusted to maintain the duration of the appointment as - * previously set. If the setAsync method is called on the end property, the duration of the appointment will be extended to the new end time. + * If the `setAsync` method is called on the start property, the `end` property will be adjusted to maintain the duration of the appointment as + * previously set. If the `setAsync` method is called on the `end` property, the duration of the appointment will be extended to the new end time. * - * The time must be in UTC; you can get the correct UTC time by using the convertToUtcClientTime method. + * The time must be in UTC; you can get the correct UTC time by using the `convertToUtcClientTime` method. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - InvalidEndTime: The appointment end time is before the appointment start time. + * - `InvalidEndTime`: The appointment end time is before the appointment start time. * * @param dateTime - A date-time object in Coordinated Universal Time (UTC). - * @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 date and time fails, the asyncResult.error property will contain an error code. + * @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 date and time fails, the `asyncResult.error` property will contain an error code. */ setAsync(dateTime: Date, callback?: (asyncResult: Office.AsyncResult) => void): void; } @@ -16528,9 +16561,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface UserProfile { /** @@ -16542,9 +16575,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * The possible account types are listed in the following table. * @@ -16577,9 +16610,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ displayName: string; /** @@ -16587,9 +16620,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ emailAddress: string; /** @@ -16597,9 +16630,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ timeZone: string; } diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 9ab8e0e420..8c00ebc0d0 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -574,15 +574,15 @@ declare namespace Office { */ license: string; /** - * Provides access to the Outlook Add-in object model for Microsoft Outlook and Microsoft Outlook on the web. + * Provides access to the Microsoft Outlook Add-in object model. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * - * **Namespaces**: + * **Key properties**: * * - `diagnostics`: Provides diagnostic information to an Outlook add-in. * @@ -606,14 +606,14 @@ declare namespace Office { /** * Gets an object that represents the custom settings or state of a mail add-in saved to a user's mailbox. * - * The RoamingSettings object lets you store and access data for a mail add-in that is stored in a user's mailbox, so that is available to + * The `RoamingSettings` object lets you store and access data for a mail add-in that is stored in a user's mailbox, so it's available to * that add-in when it is running from any host client application used to access that mailbox. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ roamingSettings: Office.RoamingSettings; /** @@ -659,16 +659,16 @@ declare namespace Office { } namespace AddinCommands { /** - * The event object is passed as a parameter to add-in functions invoked by UI-less command buttons. The object allows the add-in to identify + * The `Event` object is passed as a parameter to add-in functions invoked by UI-less command buttons. The object allows the add-in to identify * which button was clicked and to signal the host that it has completed its processing. * * @remarks * * See {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/add-in-commands-requirement-sets | Add-in commands requirement sets} for more support information. * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: Restricted * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface Event { /** @@ -676,7 +676,7 @@ declare namespace Office { * * @remarks * - * This property is only supported in Outlook in {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/outlook-api-requirement-sets | requirement set} Mailbox 1.3 and later. + * This property is supported in Outlook only in {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/outlook-api-requirement-sets | requirement set} Mailbox 1.3 and later. */ source:Source; @@ -685,7 +685,7 @@ declare namespace Office { * * This method must be called at the end of a function which was invoked by the following. * - * - A UI-less button (i.e., an add-in command defined with an Action element where the xsi:type attribute is set to ExecuteFunction) + * - A UI-less button (i.e., an add-in command defined with an `Action` element where the `xsi:type` attribute is set to `ExecuteFunction`) * * - An {@link https://docs.microsoft.com/office/dev/add-ins/reference/manifest/event | event} defined in the * {@link https://docs.microsoft.com/office/dev/add-ins/reference/manifest/extensionpoint#events | Events extension point}, @@ -695,11 +695,11 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * - * The `options` parameter was introduced in Mailbox 1.8. + * **Note**: The `options` parameter was introduced in Mailbox 1.8. * * @param options Optional. An object that specifies behavior options for when the event is completed. */ @@ -724,7 +724,7 @@ declare namespace Office { interface Source { /** - * The id of the control that triggered calling this function. The id comes from the manifest and is the unique ID of your Office Add-in + * The ID of the control that triggered calling this function. The ID comes from the manifest and is the unique ID of your Office Add-in * as a GUID. */ id: string; @@ -1604,7 +1604,7 @@ declare namespace Office { Text, } /** - * Specifies the kind of event that was raised. Returned by the `type` property of an *EventArgs object. + * Specifies the kind of event that was raised. Returned by the `type` property of an `*EventArgs` object. * * Add-ins for Project support the `Office.EventType.ResourceSelectionChanged`, `Office.EventType.TaskSelectionChanged`, and * `Office.EventType.ViewSelectionChanged` event types. @@ -7608,7 +7608,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum AttachmentContentFormat { /** @@ -7638,7 +7638,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum AttachmentStatus { /** @@ -7656,19 +7656,19 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum AttachmentType { /** - * The attachment is a file + * The attachment is a file. */ File = "file", /** - * The attachment is an Exchange item + * The attachment is an Exchange item. */ Item = "item", /** - * The attachment is stored in a cloud location, such as OneDrive. The id property of the attachment contains a URL to the file. + * The attachment is stored in a cloud location, such as OneDrive. The `id` property of the attachment contains a URL to the file. */ Cloud = "cloud" } @@ -7682,11 +7682,11 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum CategoryColor { /** - * Default color or no color mapped + * Default color or no color mapped. */ None, /** @@ -7797,7 +7797,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum Days { /** @@ -7848,7 +7848,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum DelegatePermissions { /** @@ -7881,7 +7881,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum EntityType { /** @@ -7920,19 +7920,19 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum ItemNotificationMessageType { /** - * The notificationMessage is a progress indicator. + * The notification message is a progress indicator. */ ProgressIndicator = "progressIndicator", /** - * The notificationMessage is an informational message. + * The notification message is an informational message. */ InformationalMessage = "informationalMessage", /** - * The notificationMessage is an error message. + * The notification message is an error message. */ ErrorMessage = "errorMessage" } @@ -7941,7 +7941,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum ItemType { /** @@ -7960,7 +7960,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum LocationType { /** @@ -7979,7 +7979,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum Month { /** @@ -8036,15 +8036,15 @@ declare namespace Office { */ enum OWAView { /** - * One column view. Displayed when the screen is narrow. Outlook on the web uses this single-column layout on the entire screen of a smartphone. + * One-column view. Displayed when the screen is narrow. Outlook on the web uses this single-column layout on the entire screen of a smartphone. */ OneColumn = "OneColumn", /** - * Two column view. Displayed when the screen is wider. Outlook on the web uses this view on most tablets. + * Two-column view. Displayed when the screen is wider. Outlook on the web uses this view on most tablets. */ TwoColumns = "TwoColumns", /** - Three column view. Displayed when the screen is wide. For example, Outlook on the web uses this view in a full screen window on a desktop + Three-column view. Displayed when the screen is wide. For example, Outlook on the web uses this view in a full screen window on a desktop computer. */ ThreeColumns = "ThreeColumns" @@ -8056,7 +8056,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum RecipientType { /** @@ -8083,7 +8083,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum RecurrenceTimeZone { /** @@ -8638,7 +8638,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum RecurrenceType { /** @@ -8667,7 +8667,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum ResponseType { /** @@ -8698,7 +8698,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum RestVersion { /** @@ -8721,7 +8721,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose */ enum SourceProperty { /** @@ -8740,7 +8740,7 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ enum WeekNumber { /** @@ -8772,7 +8772,7 @@ declare namespace Office { * The subclass of {@link Office.Item | Item} dealing with appointments. * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. - * You should treat this as a mode of Office.context.mailbox.item. Refer to the + * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.8/office.context.mailbox.item | Object Model} page for more information. * * Child interfaces: @@ -8787,7 +8787,7 @@ declare namespace Office { * The appointment organizer mode of {@link Office.Item | Office.context.mailbox.item}. * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. - * You should treat this as a mode of Office.context.mailbox.item. Refer to the + * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.8/office.context.mailbox.item | Object Model} page for more information. * * Parent interfaces: @@ -8804,9 +8804,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ body: Body; /** @@ -8816,25 +8816,25 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ categories: Categories; /** * Gets or sets the date and time that the appointment is to end. * - * The end property is a {@link Office.Time | Time} object expressed as a Coordinated Universal Time (UTC) date and time value. - * You can use the convertToLocalClientTime method to convert the end property value to the client's local date and time. + * The `end` property is a {@link Office.Time | Time} object expressed as a Coordinated Universal Time (UTC) date and time value. + * You can use the `convertToLocalClientTime` method to convert the `end` property value to the client's local date and time. * - * When you use the Time.setAsync method to set the end time, you should use the convertToUtcClientTime method to convert the local time on + * When you use the `Time.setAsync` method to set the end time, you should use the `convertToUtcClientTime` method to convert the local time on * the client to UTC for the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ end: Time; /** @@ -8845,32 +8845,32 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ enhancedLocation: EnhancedLocation; /** * Gets the type of item that an instance represents. * - * The itemType property returns one of the ItemType enumeration values, indicating whether the item object instance is a message or an appointment. + * The `itemType` property returns one of the `ItemType` enumeration values, indicating whether the `item` object instance is a message or an appointment. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ itemType: MailboxEnums.ItemType | string; /** - * Gets or sets the location of an appointment. The location property returns a {@link Office.Location | Location} object that provides methods that are + * Gets or sets the location of an appointment. The `location` property returns a {@link Office.Location | Location} object that provides methods that are * used to get and set the location of the appointment. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ location: Location; /** @@ -8880,15 +8880,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ 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 a {@link Office.Recipients | Recipients} object that provides methods to get or update the optional attendees + * The `optionalAttendees` property returns a {@link Office.Recipients | Recipients} object that provides methods to get or update the optional attendees * for a meeting. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, the following limits apply. * * - Get 500 members maximum. @@ -8897,32 +8897,32 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ optionalAttendees: Recipients; /** * Gets the organizer for the specified meeting. * - * The organizer property returns an {@link Office.Organizer | Organizer} object that provides a method to get the organizer value. + * The `organizer` property returns an {@link Office.Organizer | Organizer} object that provides a method to get the organizer value. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ organizer: Organizer; /** * Gets or sets the recurrence pattern of an appointment. * - * The recurrence property returns a recurrence object for recurring appointments or meetings requests if an item is a series or an instance + * The `recurrence` property returns a recurrence object for recurring appointments or meetings requests if an item is a series or an instance * in a series. `null` is returned for single appointments and meeting requests of single appointments. * - * **Note**: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request. + * **Note**: Meeting requests have an `itemClass` value of `IPM.Schedule.Meeting.Request`. * * **Note**: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single * appointment and NOT a part of a series. @@ -8931,15 +8931,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ recurrence: Recurrence; /** * Provides access to the required attendees of an event. The type of object and level of access depends on the mode of the current item. * - * The requiredAttendees property returns a {@link Office.Recipients | Recipients} object that provides methods to get or update the required attendees + * The `requiredAttendees` property returns a {@link Office.Recipients | Recipients} object that provides methods to get or update the required attendees * for a meeting. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, the following limits apply. * * - Get 500 members maximum. @@ -8948,71 +8948,71 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ requiredAttendees: Recipients; /** * Gets the id of the series that an instance belongs to. * - * In Outlook on the web and desktop clients, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to. - * However, on iOS and Android, the seriesId returns the REST ID of the parent item. + * In Outlook on the web and desktop clients, the `seriesId` property returns the Exchange Web Services (EWS) ID of the parent (series) item + * that this item belongs to. However, on iOS and Android, the seriesId returns the REST ID of the parent item. * - * **Note**: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier. - * The seriesId property is not identical to the Outlook IDs used by the Outlook REST API. - * Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId. - * For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. + * **Note**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier. + * The `seriesId` property is not identical to the Outlook IDs used by the Outlook REST API. + * Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`. + * For more details, see {@link https://docs.microsoft.com/office/dev/add-ins/outlook/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. * - * The seriesId property returns null for items that do not have parent items such as single appointments, series items, or meeting requests - * and returns undefined for any other items that are not meeting requests. + * The `seriesId` property returns `null` for items that do not have parent items such as single appointments, series items, or meeting requests + * and returns `undefined` for any other items that are not meeting requests. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ seriesId: string; /** * Gets or sets the date and time that the appointment is to begin. * - * The start property is a {@link Office.Time | Time} object expressed as a Coordinated Universal Time (UTC) date and time value. - * You can use the convertToLocalClientTime method to convert the value to the client's local date and time. + * The `start` property is a {@link Office.Time | Time} object expressed as a Coordinated Universal Time (UTC) date and time value. + * You can use the `convertToLocalClientTime` method to convert the value to the client's local date and time. * - * When you use the Time.setAsync method to set the start time, you should use the convertToUtcClientTime method to convert the local time on + * When you use the `Time.setAsync` method to set the start time, you should use the `convertToUtcClientTime` method to convert the local time on * the client to UTC for the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ start: Time; /** * Gets or sets the description that appears in the subject field of an item. * - * The subject property gets or sets the entire subject of the item, as sent by the email server. + * The `subject` property gets or sets the entire subject of the item, as sent by the email server. * - * The subject property returns a Subject object that provides methods to get and set the subject. + * The `subject` property returns a `Subject` object that provides methods to get and set the subject. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ subject: Subject; /** * Adds a file to a message or appointment as an attachment. * - * The addFileAttachmentAsync method uploads the file at the specified URI and attaches it to the item in the compose form. + * The `addFileAttachmentAsync` method uploads the file at the specified URI and attaches it to the item in the compose form. * - * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * * **Important**: In recent builds of Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to * this action (whether using this API or the Outlook UI). To work around this issue, you can try using the `addFileAttachmentFromBase64` API @@ -9022,34 +9022,37 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - AttachmentSizeExceeded: The attachment is larger than allowed. + * - `AttachmentSizeExceeded`: The attachment is larger than allowed. * - * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * - `FileTypeNotSupported`: The attachment has an extension that is not allowed. * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `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. - * 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 - 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 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. + * `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 - 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 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 & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds a file to a message or appointment as an attachment. * - * The addFileAttachmentAsync method uploads the file at the specified URI and attaches it to the item in the compose form. + * The `addFileAttachmentAsync` method uploads the file at the specified URI and attaches it to the item in the compose form. * - * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * * **Important**: In recent builds of Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to * this action (whether using this API or the Outlook UI). To work around this issue, you can try using the `addFileAttachmentFromBase64` API @@ -9059,94 +9062,101 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - AttachmentSizeExceeded: The attachment is larger than allowed. + * - `AttachmentSizeExceeded`: The attachment is larger than allowed. * - * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * - `FileTypeNotSupported`: The attachment has an extension that is not allowed. * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `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 - 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 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. + * @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 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?: (asyncResult: 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. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * - * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. + * **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API. * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - AttachmentSizeExceeded: The attachment is larger than allowed. + * - `AttachmentSizeExceeded`: The attachment is larger than allowed. * - * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * - `FileTypeNotSupported`: The attachment has an extension that is not allowed. * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `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. - * 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 - 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 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. + * `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 - 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 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. */ addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: 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. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * - * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. + * **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API. * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - AttachmentSizeExceeded: The attachment is larger than allowed. + * - `AttachmentSizeExceeded`: The attachment is larger than allowed. * - * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * - `FileTypeNotSupported`: The attachment has an extension that is not allowed. * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `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 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 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. + * @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 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. */ addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -9158,17 +9168,17 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * The type property on the parameter will match the eventType parameter passed to addHandlerAsync. + * 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. - * 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. + * `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. */ addHandlerAsync(eventType: Office.EventType | string, handler: any, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -9180,105 +9190,109 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * 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. + * 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. */ addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. * - * The addItemAttachmentAsync method attaches the item with the specified Exchange identifier to the item in the compose form. - * If you specify a callback method, the method is called with one parameter, asyncResult, which contains either the attachment identifier or + * The `addItemAttachmentAsync` method attaches the item with the specified Exchange identifier to the item in the compose form. + * If you specify a callback method, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or * a code that indicates any error that occurred while attaching the item. - * You can use the options parameter to pass state information to the callback method, if needed. + * You can use the `options` parameter to pass state information to the callback method, if needed. * - * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * - * If your Office add-in is running in Outlook on the web, the addItemAttachmentAsync method can attach items to items other than the item that + * If your Office Add-in is running in Outlook on the web, the `addItemAttachmentAsync` method can attach items to items other than the item that * you are editing; however, this is not supported and is not recommended. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `NumberOfAttachmentsExceeded`: 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 - 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. - * 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. + * `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`. + * 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?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. * - * The addItemAttachmentAsync method attaches the item with the specified Exchange identifier to the item in the compose form. - * If you specify a callback method, the method is called with one parameter, asyncResult, which contains either the attachment identifier or + * The `addItemAttachmentAsync` method attaches the item with the specified Exchange identifier to the item in the compose form. + * If you specify a callback method, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or * a code that indicates any error that occurred while attaching the item. - * You can use the options parameter to pass state information to the callback method, if needed. + * You can use the `options` parameter to pass state information to the callback method, if needed. * - * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * - * If your Office add-in is running in Outlook on the web, the addItemAttachmentAsync method can attach items to items other than the item that + * If your Office Add-in is running in Outlook on the web, the `addItemAttachmentAsync` method can attach items to items other than the item that * you are editing; however, this is not supported and is not recommended. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `NumberOfAttachmentsExceeded`: 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 - 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 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. + * @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 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?: (asyncResult: Office.AsyncResult) => void): void; /** * Closes the current item that is being composed * - * The behaviors of the close method depends on the current state of the item being composed. + * The behaviors of the `close` method depends on the current state of the item being composed. * If the item has unsaved changes, the client prompts the user to save, discard, or close the action. * - * In the Outlook desktop client, if the message is an inline reply, the close method has no effect. + * In the Outlook desktop client, if the message is an inline reply, the `close` method has no effect. * - * **Note**: In Outlook on the web, if the item is an appointment and it has previously been saved using saveAsync, the user is prompted to save, + * **Note**: In Outlook on the web, if the item is an appointment and it has previously been saved using `saveAsync`, the user is prompted to save, * discard, or cancel even if no changes have occurred since the item was last saved. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer */ close(): void; /** - * Gets an attachment from a message or appointment and returns it as an **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 @@ -9290,27 +9304,27 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - AttachmentTypeNotSupported: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, + * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, * or item attachment types other than email or calendar items (such as a contact or task item). * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: 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. - * 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 - * with the reason for the failure. + * `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 + * an error code with the reason for the failure. */ getAttachmentContentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** - * Gets an attachment from a message or appointment and returns it as an **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 @@ -9322,21 +9336,21 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - AttachmentTypeNotSupported: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, + * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, * or item attachment types other than email or calendar items (such as a contact or task item). * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * * @param attachmentId - The identifier of the attachment you want to get. - * @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. + * @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 + * an error code with the reason for the failure. */ getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -9346,14 +9360,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * @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. If the call fails, the asyncResult.error property will contain and error code with the reason for + * `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`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for * the failure. */ getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; @@ -9364,12 +9378,12 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * - * @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 + * @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 an error code with the reason for * the failure. */ getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; @@ -9386,17 +9400,18 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * * - `ItemNotSaved`: The id can't be retrieved until the item is saved. * * @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. + * `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`. */ getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -9412,68 +9427,70 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * * - `ItemNotSaved`: The id can't be retrieved until the item is saved. * - * @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`. */ getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * * If there is no selection but the cursor is in the body or subject, the method returns an empty string for the selected data. - * If a field other than the body or subject is selected, the method returns the InvalidSelection error. + * If a field other than the body or subject is selected, the method returns the `InvalidSelection` error. * - * To access the selected data from the callback method, call asyncResult.value.data. - * To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject. + * To access the selected data from the callback method, call `asyncResult.value.data`. + * To access the `source` property that the selection comes from, call `asyncResult.value.sourceProperty`, which will be either `body` or `subject`. * * [Api set: Mailbox 1.2] * * @returns - * The selected data as a string with format determined by coercionType. + * The selected data as a string with format determined by `coercionType`. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * If HTML, the method returns the selected text, whether it is plaintext or HTML. + * @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. - * 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. + * `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`. */ getSelectedDataAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * * If there is no selection but the cursor is in the body or subject, the method returns an empty string for the selected data. - * If a field other than the body or subject is selected, the method returns the InvalidSelection error. + * If a field other than the body or subject is selected, the method returns the `InvalidSelection` error. * - * To access the selected data from the callback method, call asyncResult.value.data. - * To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject. + * To access the selected data from the callback method, call `asyncResult.value.data`. + * To access the `source` property that the selection comes from, call `asyncResult.value.sourceProperty`, which will be either `body` or `subject`. * * [Api set: Mailbox 1.2] * * @returns - * The selected data as a string with format determined by coercionType. + * The selected data as a string with format determined by `coercionType`. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * If HTML, the method returns the selected text, whether it is plaintext or HTML. - * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. + * @param coercionType - Requests a format for the data. If `Text`, the method returns the plain text as a string, removing any HTML tags present. + * If `HTML`, the method returns the selected text, whether it is plaintext or HTML. + * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of + * type `Office.AsyncResult`. */ getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -9485,14 +9502,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * @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. + * `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`. * The `value` property of the result is the properties of the shared item. */ getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; @@ -9505,12 +9522,12 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * type Office.AsyncResult. + * type `Office.AsyncResult`. * The `value` property of the result is the properties of the shared item. */ getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void): void; @@ -9518,29 +9535,29 @@ declare namespace Office { * Asynchronously loads custom properties for this add-in on the selected item. * * Custom properties are stored as key/value pairs on a per-app, per-item basis. - * This method returns a CustomProperties object in the callback, which provides methods to access the custom properties specific to the + * This method returns a `CustomProperties` object in the callback, which provides methods to access the custom properties specific to the * current item and the current add-in. Custom properties are not encrypted on the item, so this should not be used as secure storage. * - * The custom properties are provided as a CustomProperties object in the asyncResult.value property. + * The custom properties are provided as a `CustomProperties` object in the `asyncResult.value` property. * This object can be used to get, set, and remove custom properties from the item and save changes to the custom property set back to * the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * 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`. * @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. + * This object can be accessed by the `asyncResult.asyncContext` property in the callback function. */ loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any): void; /** * Removes an attachment from a message or appointment. * - * The removeAttachmentAsync method removes the attachment with the specified identifier from the item. + * The `removeAttachmentAsync` method removes the attachment with the specified identifier from the item. * As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment * in the same session. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session. * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to @@ -9550,25 +9567,26 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: 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. - * 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. - * If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + * `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`. + * 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?: (asyncResult: Office.AsyncResult) => void): void; /** * Removes an attachment from a message or appointment. * - * The removeAttachmentAsync method removes the attachment with the specified identifier from the item. + * The `removeAttachmentAsync` method removes the attachment with the specified identifier from the item. * As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment * in the same session. * In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session. @@ -9579,18 +9597,18 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: 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 Office.AsyncResult. - * If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + * @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?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -9602,15 +9620,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * @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. + * `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. */ removeHandlerAsync(eventType: Office.EventType | string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -9622,96 +9640,98 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 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 | string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. * - * When invoked, this method saves the current message as a draft and returns the item id via the callback method. + * When invoked, this method saves the current message as a draft and returns the item ID via the callback method. * In Outlook on the web or Outlook in online mode, the item is saved to the server. * In Outlook in cached mode, the item is saved to the local cache. * - * Since appointments have no draft state, if saveAsync is called on an appointment in compose mode, the item will be saved as a normal + * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item will be saved as a normal * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. * Saving an existing appointment will send an update to added or removed attendees. * - * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that - * when Outlook is in cached mode, it may take some time before the item is actually synced to the server. - * Until the item is synced, using the itemId will return an error. + * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware + * that when Outlook is in cached mode, it may take some time before the item is actually synced to the server. + * Until the item is synced, using the item ID will return an error. * - * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode: + * **Note**: The following clients have different behavior for `saveAsync` on appointments in compose mode: * * - In Outlook on Mac, only preview build 16.35.205.0 or later with an Office 365 subscription supports saving a meeting. - * Otherwise, the saveAsync method fails when called from a meeting in compose mode. + * Otherwise, the `saveAsync` method fails when called from a meeting in compose mode. * For a workaround, see {@link https://support.microsoft.com/help/4505745 | Cannot save a meeting as a draft in Outlook for Mac by using Office JS API}. * - * - Outlook on the web always sends an invitation or update when saveAsync is called on an appointment in compose mode. + * - Outlook on the web always sends an invitation or update when `saveAsync` is called on an appointment in compose mode. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * * @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. + * `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`. */ saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. * - * When invoked, this method saves the current message as a draft and returns the item id via the callback method. + * When invoked, this method saves the current message as a draft and returns the item ID via the callback method. * In Outlook on the web or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache. * - * Since appointments have no draft state, if saveAsync is called on an appointment in compose mode, the item will be saved as a normal + * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item will be saved as a normal * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. * Saving an existing appointment will send an update to added or removed attendees. * - * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that + * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware that * when Outlook is in cached mode, it may take some time before the item is actually synced to the server. - * Until the item is synced, using the itemId will return an error. + * Until the item is synced, using the item ID will return an error. * - * **Note**: The following clients have different behavior for saveAsync on appointments in compose mode: + * **Note**: The following clients have different behavior for `saveAsync` on appointments in compose mode: * * - In Outlook on Mac, only preview build 16.35.205.0 or later with an Office 365 subscription supports saving a meeting. - * Otherwise, the saveAsync method fails when called from a meeting in compose mode. + * Otherwise, the `saveAsync` method fails when called from a meeting in compose mode. * For a workaround, see {@link https://support.microsoft.com/help/4505745 | Cannot save a meeting as a draft in Outlook for Mac by using Office JS API}. * - * - Outlook on the web always sends an invitation or update when saveAsync is called on an appointment in compose mode. + * - Outlook on the web always sends an invitation or update when `saveAsync` is called on an appointment in compose mode. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * - * @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`. */ saveAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * - * The setSelectedDataAsync method inserts the specified string at the cursor location in the subject or body of the item, or, if text is + * The `setSelectedDataAsync` method inserts the specified string at the cursor location in the subject or body of the item, or, if text is * selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. * After insertion, the cursor is placed at the end of the inserted content. * @@ -9719,63 +9739,63 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * * @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. + * 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. - * asyncContext: Developers can provide any object they wish to access in the callback method. - * coercionType: If text, the current style is applied in Outlook on the web and Windows. + * `asyncContext`: Developers can provide any object they wish to access in the callback method. + * `coercionType`: If text, the current style is applied in Outlook on the web and Windows. * If the field is an HTML editor, only the text data is inserted, even if the data is HTML. * If html and the field supports HTML (the subject doesn't), the current style is applied in Outlook on the web and the * default style is applied in Outlook on desktop clients. - * 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 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 - * 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`. */ setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * - * The setSelectedDataAsync method inserts the specified string at the cursor location in the subject or body of the item, or, if text is - * selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. + * The `setSelectedDataAsync` method inserts the specified string at the cursor location in the subject or body of the item, or, if text is + * selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. * After insertion, the cursor is placed at the end of the inserted content. * * [Api set: Mailbox 1.2] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * * @param data - The data to be inserted. Data is not to exceed 1,000,000 characters. - * If more than 1,000,000 characters are passed in, an ArgumentOutOfRange exception is thrown. - * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. + * If more than 1,000,000 characters are passed in, an `ArgumentOutOfRange` exception is thrown. + * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of + * type `Office.AsyncResult`. */ setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void): void; } /** - * The AppointmentForm namespace is used to access the currently selected appointment. + * The `AppointmentForm` object is used to access the currently selected appointment. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface AppointmentForm { /** @@ -9785,33 +9805,33 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ body: Body | string; /** * Gets or sets the date and time that the appointment is to end. * - * The end property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the convertToLocalClientTime method to - * convert the end property value to the client's local date and time. + * The `end` property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the `convertToLocalClientTime` method to + * convert the `end` property value to the client's local date and time. * * *Read mode* * - * The end property returns a Date object. + * The `end` property returns a `Date` object. * * *Compose mode* * - * The end property returns a Time object. + * The `end` property returns a `Time` object. * - * When you use the Time.setAsync method to set the end time, you should use the convertToUtcClientTime method to convert the local time on + * When you use the `Time.setAsync` method to set the end time, you should use the `convertToUtcClientTime` method to convert the local time on * the client to UTC for the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ end: Time | Date; /** @@ -9819,17 +9839,17 @@ declare namespace Office { * * *Read mode* * - * The location property returns a string that contains the location of the appointment. + * The `location` property returns a string that contains the location of the appointment. * * *Compose mode* * - * The location property returns a Location object that provides methods that are used to get and set the location of the appointment. + * The `location` property returns a `Location` object that provides methods that are used to get and set the location of the appointment. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ location: Location | string; /** @@ -9837,12 +9857,12 @@ declare namespace Office { * * *Read mode* * - * The optionalAttendees property returns an array that contains an EmailAddressDetails object for each optional attendee to the meeting. + * The `optionalAttendees` property returns an array that contains an `EmailAddressDetails` object for each optional attendee to the meeting. * By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, you can get 500 members maximum. * * *Compose mode* * - * The optionalAttendees property returns a Recipients object that provides methods to get or update the optional attendees for a meeting. + * The `optionalAttendees` property returns a `Recipients` object that provides methods to get or update the optional attendees for a meeting. * By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, the following limits apply. * * - Get 500 members maximum. @@ -9851,9 +9871,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ optionalAttendees: Recipients[] | EmailAddressDetails[]; /** @@ -9861,9 +9881,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ resources: string[]; /** @@ -9871,12 +9891,12 @@ declare namespace Office { * * *Read mode* * - * The requiredAttendees property returns an array that contains an EmailAddressDetails object for each required attendee to the meeting. + * The `requiredAttendees` property returns an array that contains an `EmailAddressDetails` object for each required attendee to the meeting. * By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, you can get 500 members maximum. * * *Compose mode* * - * The requiredAttendees property returns a Recipients object that provides methods to get or update the required attendees for a meeting. + * The `requiredAttendees` property returns a `Recipients` object that provides methods to get or update the required attendees for a meeting. * By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, the following limits apply. * * - Get 500 members maximum. @@ -9885,53 +9905,53 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ requiredAttendees: Recipients[] | EmailAddressDetails[]; /** * Gets or sets the date and time that the appointment is to begin. * - * The start property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the convertToLocalClientTime method + * The `start` property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the `convertToLocalClientTime` method * to convert the value to the client's local date and time. * * *Read mode* * - * The start property returns a Date object. + * The `start` property returns a `Date` object. * * *Compose mode* * - * The start property returns a Time object. + * The `start` property returns a `Time` object. * - * When you use the Time.setAsync method to set the start time, you should use the convertToUtcClientTime method to convert the local time on + * When you use the `Time.setAsync` method to set the start time, you should use the `convertToUtcClientTime` method to convert the local time on * the client to UTC for the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ start: Time | Date; /** * Gets or sets the description that appears in the subject field of an item. * - * The subject property gets or sets the entire subject of the item, as sent by the email server. + * The `subject` property gets or sets the entire subject of the item, as sent by the email server. * * *Read mode* * - * The subject property returns a string. Use the normalizedSubject property to get the subject minus any leading prefixes such as RE: and FW:. + * The `subject` property returns a string. Use the `normalizedSubject` property to get the subject minus any leading prefixes such as RE: and FW:. * * *Compose mode* * - * The subject property returns a Subject object that provides methods to get and set the subject. + * The `subject` property returns a `Subject` object that provides methods to get and set the subject. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ subject: Subject | string; } @@ -9939,7 +9959,7 @@ declare namespace Office { * The appointment attendee mode of {@link Office.Item | Office.context.mailbox.item}. * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. - * You should treat this as a mode of Office.context.mailbox.item. Refer to the + * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.8/office.context.mailbox.item | Object Model} page for more information. * * Parent interfaces: @@ -9954,9 +9974,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee * * **Note**: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned. For more information, see * {@link https://support.office.com/article/Blocked-attachments-in-Outlook-434752E1-02D3-4E90-9124-8B81E49A8519 | Blocked attachments in Outlook}. @@ -9970,9 +9990,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ body: Body; /** @@ -9982,9 +10002,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ categories: Categories; /** @@ -9992,9 +10012,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ dateTimeCreated: Date; /** @@ -10004,55 +10024,54 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ dateTimeModified: Date; /** * Gets the date and time that the appointment is to end. * - * The end property is a Date object expressed as a Coordinated Universal Time (UTC) date and time value. - * You can use the convertToLocalClientTime method to convert the end property value to the client's local date and time. + * The `end` property is a `Date` object expressed as a Coordinated Universal Time (UTC) date and time value. + * You can use the `convertToLocalClientTime` method to convert the `end` property value to the client's local date and time. * - * When you use the Time.setAsync method to set the end time, you should use the convertToUtcClientTime method to convert the local time on + * When you use the `Time.setAsync` method to set the end time, you should use the `convertToUtcClientTime` method to convert the local time on * the client to UTC for the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ end: Date; /** * Gets the locations of an appointment. * - * The enhancedLocation property returns an {@link Office.EnhancedLocation | EnhancedLocation} object that allows you to get the set of locations + * The `enhancedLocation` property returns an {@link Office.EnhancedLocation | EnhancedLocation} object that allows you to get the set of locations * (each represented by a {@link Office.LocationDetails | LocationDetails} object) associated with the appointment. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ enhancedLocation: EnhancedLocation; /** * Gets the Exchange Web Services item class of the selected item. * - * - * You can create custom message classes that extends a default message class, for example, a custom appointment message class IPM.Appointment.Contoso. + * You can create custom message classes that extends a default message class, for example, a custom appointment message class `IPM.Appointment.Contoso`. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee * - * The itemClass property specifies the message class of the selected item. The following are the default message classes for the message or appointment item. + * The `itemClass` property specifies the message class of the selected item. The following are the default message classes for the message or appointment item. * *
* @@ -10078,58 +10097,58 @@ declare namespace Office { * Gets the {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services item identifier} * for the current item. * - * 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. + * 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. * - * **Note**: The identifier returned by the itemId property is the same as the + * **Note**: The identifier returned by the `itemId` property is the same as the * {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | 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. - * Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId. - * For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api#get-the-item-id | Use the Outlook REST APIs from an Outlook add-in}. + * The `itemId` property is not identical to the Outlook Entry ID or the ID used by the Outlook REST API. + * Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`. + * For more details, see {@link https://docs.microsoft.com/office/dev/add-ins/outlook/use-rest-api#get-the-item-id | Use the Outlook REST APIs from an Outlook add-in}. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ itemId: string; /** * Gets the type of item that an instance represents. * - * The itemType property returns one of the ItemType enumeration values, indicating whether the item object instance is a message or an appointment. + * The `itemType` property returns one of the `ItemType` enumeration values, indicating whether the item object instance is a message or an appointment. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ itemType: MailboxEnums.ItemType | string; /** * Gets the location of an appointment. * - * The location property returns a string that contains the location of the appointment. + * The `location` property returns a string that contains the location of the appointment. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ location: string; /** * Gets the subject of an item, with all prefixes removed (including RE: and FWD:). * - * The normalizedSubject property gets the subject of the item, with any standard prefixes (such as RE: and FW:) that are added by email programs. - * To get the subject of the item with the prefixes intact, use the subject property. + * The `normalizedSubject` property gets the subject of the item, with any standard prefixes (such as RE: and FW:) that are added by email programs. + * To get the subject of the item with the prefixes intact, use the `subject` property. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ normalizedSubject: string; /** @@ -10139,22 +10158,22 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ 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 array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for each optional attendee to + * The `optionalAttendees` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for each optional attendee to * the meeting. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, you can get 500 members maximum. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ optionalAttendees: EmailAddressDetails[]; /** @@ -10162,18 +10181,18 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ organizer: EmailAddressDetails; /** * Gets the recurrence pattern of an appointment. Gets the recurrence pattern of a meeting request. * - * The recurrence property returns a recurrence object for recurring appointments or meetings requests if an item is a series or an instance - * in a series. `null` is returned for single appointments and meeting requests of single appointments. + * The `recurrence` property returns a {@link Office.Recurrence | Recurrence} object for recurring appointments or meetings requests + * if an item is a series or an instance in a series. `null` is returned for single appointments and meeting requests of single appointments. * - * **Note**: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request. + * **Note**: Meeting requests have an `itemClass` value of `IPM.Schedule.Meeting.Request`. * * **Note**: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single * appointment and NOT a part of a series. @@ -10182,72 +10201,73 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ recurrence: Recurrence; /** * Provides access to the required attendees of an event. The type of object and level of access depends on the mode of the current item. * - * The requiredAttendees property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for each required attendee to - * the meeting. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, you can get 500 members maximum. + * The `requiredAttendees` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object + * for each required attendee to the meeting. By default, the collection is limited to a maximum of 100 members. + * However, on Windows and Mac, you can get 500 members maximum. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ requiredAttendees: EmailAddressDetails[]; /** * Gets the date and time that the appointment is to begin. * - * The start property is a Date object expressed as a Coordinated Universal Time (UTC) date and time value. - * You can use the convertToLocalClientTime method to convert the value to the client's local date and time. + * The `start` property is a `Date` object expressed as a Coordinated Universal Time (UTC) date and time value. + * You can use the `convertToLocalClientTime` method to convert the value to the client's local date and time. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ start: Date; /** - * Gets the id of the series that an instance belongs to. + * Gets the ID of the series that an instance belongs to. * - * In Outlook on the web and desktop clients, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to. - * However, on iOS and Android, the seriesId returns the REST ID of the parent item. + * In Outlook on the web and desktop clients, the `seriesId` returns the Exchange Web Services (EWS) ID of the parent (series) item + * that this item belongs to. However, on iOS and Android, the seriesId returns the REST ID of the parent item. * - * **Note**: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier. - * The seriesId property is not identical to the Outlook IDs used by the Outlook REST API. Before making REST API calls using this value, it - * should be converted using Office.context.mailbox.convertToRestId. - * For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. + * **Note**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier. + * The `seriesId` property is not identical to the Outlook IDs used by the Outlook REST API. Before making REST API calls using this value, it + * should be converted using `Office.context.mailbox.convertToRestId`. + * For more details, see {@link https://docs.microsoft.com/office/dev/add-ins/outlook/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. * - * The seriesId property returns null for items that do not have parent items such as single appointments, series items, or meeting requests - * and returns undefined for any other items that are not meeting requests. + * The `seriesId` property returns `null` for items that do not have parent items such as single appointments, series items, or meeting requests + * and returns `undefined` for any other items that are not meeting requests. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ seriesId: string; /** * Gets the description that appears in the subject field of an item. * - * The subject property gets or sets the entire subject of the item, as sent by the email server. + * The `subject` property gets or sets the entire subject of the item, as sent by the email server. * - * The subject property returns a string. Use the normalizedSubject property to get the subject minus any leading prefixes such as RE: and FW:. + * The `subject` property returns a string. Use the `normalizedSubject` property to get the subject minus any leading prefixes such as RE: and FW:. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ subject: string; @@ -10260,17 +10280,17 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * The type property on the parameter will match the eventType parameter passed to addHandlerAsync. + * 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. - * 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. + * `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. */ addHandlerAsync(eventType: Office.EventType | string, handler: any, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -10282,15 +10302,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * 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. + * 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. */ addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -10299,24 +10319,24 @@ declare namespace Office { * * In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2- or 1-column view. * - * If any of the string parameters exceed their limits, displayReplyAllForm throws an exception. + * If any of the string parameters exceed their limits, `displayReplyAllForm` throws an exception. * - * When attachments are specified in the formData.attachments parameter, Outlook on the web and desktop clients attempt to download all attachments and - * attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. + * When attachments are specified in the `formData.attachments` parameter, Outlook on the web and desktop clients attempt to download + * all attachments and attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. * If this isn't possible, then no error message is thrown. * * **Note**: This method is not supported in Outlook on iOS or Android. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. - * @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. */ displayReplyAllForm(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -10324,28 +10344,28 @@ declare namespace Office { * * In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2- or 1-column view. * - * If any of the string parameters exceed their limits, displayReplyForm throws an exception. + * If any of the string parameters exceed their limits, `displayReplyForm` throws an exception. * - * When attachments are specified in the formData.attachments parameter, Outlook on the web and desktop clients attempt to download all attachments and - * attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. + * When attachments are specified in the `formData.attachments` parameter, Outlook on the web and desktop clients attempt to download + * all attachments and attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. * If this isn't possible, then no error message is thrown. * * **Note**: This method is not supported in Outlook on iOS or Android. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. - * @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. */ displayReplyForm(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void): void; /** - * Gets an attachment from a message or appointment and returns it as an **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 @@ -10357,23 +10377,23 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee * * **Errors**: * - * - AttachmentTypeNotSupported: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, + * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, * or item attachment types other than email or calendar items (such as a contact or task item). * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: 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. - * 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 - * with the reason for the failure. + * `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 + * an error code with the reason for the failure. */ getAttachmentContentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -10389,21 +10409,21 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee * * **Errors**: * - * - AttachmentTypeNotSupported: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, + * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, * or item attachment types other than email or calendar items (such as a contact or task item). * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * * @param attachmentId - The identifier of the attachment you want to get. - * @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. + * @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 + * an error code with the reason for the failure. */ getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -10413,9 +10433,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ getEntities(): Entities; /** @@ -10423,20 +10443,20 @@ declare namespace Office { * * **Note**: This method is not supported in Outlook on iOS or Android. * - * @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. + * If the value passed in `entityType` is not a valid member of the `EntityType` enumeration, the method returns null. * If no entities of the specified type are present in the item's body, the method returns an empty array. - * Otherwise, the type of the objects in the returned array depends on the type of entity requested in the entityType parameter. + * Otherwise, the type of the objects in the returned array depends on the type of entity requested in the `entityType` parameter. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * @param entityType - One of the `EntityType` enumeration values. * - * While the minimum permission level to use this method is Restricted, some entity types require ReadItem to access, as specified in the following table. + * While the minimum permission level to use this method is `Restricted`, some entity types require `ReadItem` to access, as specified in the following table. * *
* @@ -10485,58 +10505,59 @@ declare namespace Office { /** * Returns well-known entities in the selected item that pass the named filter defined in the manifest XML file. * - * The getFilteredEntitiesByName method returns the entities that match the regular expression defined in the ItemHasKnownEntity rule element - * in the manifest XML file with the specified FilterName element value. + * The `getFilteredEntitiesByName` method returns the entities that match the regular expression defined in the `ItemHasKnownEntity` rule element + * in the manifest XML file with the specified `FilterName` element value. * * **Note**: This method is not supported in Outlook on iOS or Android. + * + * @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 matches an `ItemHasKnownEntity` element in the manifest, but there are no entities in the current item that match, + * the method return an empty array. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee * - * @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, - * the method return an empty array. + * @param name - The name of the `ItemHasKnownEntity` rule element that defines the filter to match. */ getFilteredEntitiesByName(name: string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; /** * Returns string values in the selected item that match the regular expressions defined in the manifest XML file. * - * The getRegExMatches method returns the strings that match the regular expression defined in each ItemHasRegularExpressionMatch or - * ItemHasKnownEntity rule element in the manifest XML file. - * For an ItemHasRegularExpressionMatch rule, a matching string has to occur in the property of the item that is specified by that rule. - * The PropertyName simple type defines the supported properties. + * The `getRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or + * `ItemHasKnownEntity` rule element in the manifest XML file. + * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that is specified by that rule. + * The `PropertyName` simple type defines the supported properties. * - * If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body + * If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body * and should not attempt to return the entire body of the item. * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. - * Instead, use the Body.getAsync method to retrieve the entire body. + * Instead, use the `Body.getAsync` method to retrieve the entire body. * * **Note**: This method is not supported in Outlook on iOS or Android. * * @returns * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file. - * The name of each array is equal to the corresponding value of the RegExName attribute of the matching ItemHasRegularExpressionMatch rule - * or the FilterName attribute of the matching ItemHasKnownEntity rule. + * The name of each array is equal to the corresponding value of the RegExName attribute of the matching `ItemHasRegularExpressionMatch` rule + * or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ getRegExMatches(): any; /** * Returns string values in the selected item that match the named regular expression defined in the manifest XML file. * - * The getRegExMatchesByName method returns the strings that match the regular expression defined in the ItemHasRegularExpressionMatch rule - * element in the manifest XML file with the specified RegExName element value. + * The `getRegExMatchesByName` method returns the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule + * element in the manifest XML file with the specified `RegExName` element value. * - * If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body + * If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body * and should not attempt to return the entire body of the item. * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. * @@ -10547,11 +10568,11 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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[]; /** @@ -10563,41 +10584,41 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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; /** * Returns string values in a highlighted match that match the regular expressions defined in the manifest XML file. * Highlighted matches apply to contextual add-ins. * - * The getSelectedRegExMatches method returns the strings that match the regular expression defined in each ItemHasRegularExpressionMatch or - * ItemHasKnownEntity rule element in the manifest XML file. - * For an ItemHasRegularExpressionMatch rule, a matching string has to occur in the property of the item that is specified by that rule. - * The PropertyName simple type defines the supported properties. + * The `getSelectedRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or + * `ItemHasKnownEntity` rule element in the manifest XML file. + * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that is specified by that rule. + * The `PropertyName` simple type defines the supported properties. * - * If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body - * and should not attempt to return the entire body of the item. - * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. - * Instead, use the Body.getAsync method to retrieve the entire body. + * If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body + * and should not attempt to return the entire body of the item. + * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. + * Instead, use the `Body.getAsync` method to retrieve the entire body. * * **Note**: This method is not supported in Outlook on iOS or Android. * * [Api set: Mailbox 1.6] * * @returns - * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file. - * The name of each array is equal to the corresponding value of the RegExName attribute of the matching ItemHasRegularExpressionMatch rule - * or the FilterName attribute of the matching ItemHasKnownEntity rule. + * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file. + * The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule + * or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee */ getSelectedRegExMatches(): any; /** @@ -10609,14 +10630,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee * * @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. + * `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`. * The `value` property of the result is the properties of the shared item. */ getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; @@ -10629,36 +10650,36 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * 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`. * The `value` property of the result is the properties of the shared item. */ getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously loads custom properties for this add-in on the selected item. * - * Custom properties are stored as key/value pairs on a per-app, per-item basis. - * This method returns a CustomProperties object in the callback, which provides methods to access the custom properties specific to the + * Custom properties are stored as key/value pairs on a per-app, per-item basis. + * This method returns a `CustomProperties` object in the callback, which provides methods to access the custom properties specific to the * current item and the current add-in. Custom properties are not encrypted on the item, so this should not be used as secure storage. * - * The custom properties are provided as a CustomProperties object in the asyncResult.value property. - * This object can be used to get, set, and remove custom properties from the item and save changes to the custom property set back to + * The custom properties are provided as a `CustomProperties` object in the asyncResult.value property. + * This object can be used to get, set, and remove custom properties from the item and save changes to the custom property set back to * the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * type Office.AsyncResult. - * @param userContext - Optional. Developers can provide any object they wish to access in the callback function. - * This object can be accessed by the asyncResult.asyncContext property in the callback function. + * @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. + * This object can be accessed by the `asyncResult.asyncContext` property in the callback function. */ loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any): void; /** @@ -10670,15 +10691,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee * * @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. + * `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. */ removeHandlerAsync(eventType: Office.EventType | string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -10690,13 +10711,13 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 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 | string, callback?: (asyncResult: Office.AsyncResult) => void): void; } @@ -10732,9 +10753,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface AttachmentContent { /** @@ -10761,13 +10782,13 @@ declare namespace Office { /** * Represents an attachment on an item from the server. Read mode only. * - * An array of **AttachmentDetails** objects is returned as the attachments property of an appointment or message item. + * An array of `AttachmentDetails` objects is returned as the attachments property of an appointment or message item. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read */ interface AttachmentDetails { /** @@ -10838,55 +10859,55 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface Body { /** * Returns the current body in a specified format. * - * This method returns the entire current body in the format specified by coercionType. + * This method returns the entire current body in the format specified by `coercionType`. * - * When working with HTML-formatted bodies, it is important to note that the Body.getAsync and Body.setAsync methods are not idempotent. - * The value returned from the getAsync method will not necessarily be exactly the same as the value that was passed in the setAsync method previously. - * The client may modify the value passed to setAsync in order to make it render efficiently with its rendering engine. + * When working with HTML-formatted bodies, it is important to note that the `Body.getAsync` and `Body.setAsync` methods are not idempotent. + * The value returned from the `getAsync` method will not necessarily be exactly the same as the value that was passed in the `setAsync` method previously. + * The client may modify the value passed to `setAsync` in order to make it render efficiently with its rendering engine. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * @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 Office.AsyncResult. - * The body is provided in the requested format in the asyncResult.value property. + * `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. The body is provided in the requested format in the `asyncResult.value` property. */ getAsync(coercionType: Office.CoercionType | string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Returns the current body in a specified format. * - * This method returns the entire current body in the format specified by coercionType. + * This method returns the entire current body in the format specified by `coercionType`. * - * When working with HTML-formatted bodies, it is important to note that the Body.getAsync and Body.setAsync methods are not idempotent. - * The value returned from the getAsync method will not necessarily be exactly the same as the value that was passed in the setAsync method previously. - * The client may modify the value passed to setAsync in order to make it render efficiently with its rendering engine. + * When working with HTML-formatted bodies, it is important to note that the `Body.getAsync` and `Body.setAsync` methods are not idempotent. + * The value returned from the `getAsync` method will not necessarily be exactly the same as the value that was passed in the `setAsync` method previously. + * The client may modify the value passed to `setAsync` in order to make it render efficiently with its rendering engine. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * The body is provided in the requested format in the asyncResult.value property. + * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter + * of type Office.AsyncResult. The body is provided in the requested format in the `asyncResult.value` property. */ getAsync(coercionType: Office.CoercionType | string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -10896,14 +10917,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. - * The content type is returned as one of the CoercionType values in the asyncResult.value property. + * `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`. + * The content type is returned as one of the `CoercionType` values in the `asyncResult.value` property. */ getTypeAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -10913,189 +10935,190 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * - * @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. + * @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(callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds the specified content to the beginning of the item body. * - * The prependAsync method inserts the specified string at the beginning of the item body. + * The `prependAsync` method inserts the specified string at the beginning of the item body. * After insertion, the cursor is returned to its original place, relative to the inserted content. * - * When including links in HTML markup, you can disable online link preview by setting the id attribute on the anchor (\) to "LPNoLP" - * (please see the Examples section for a sample). + * When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\) to "LPNoLP" + * (see the **Examples** section for a sample). * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - DataExceedsMaximumSize: The data parameter is longer than 1,000,000 characters. + * - `DataExceedsMaximumSize`: 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. - * 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. - * Any errors encountered will be provided in the asyncResult.error property. + * `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`. Any errors encountered will be provided in the `asyncResult.error` property. */ prependAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds the specified content to the beginning of the item body. * - * The prependAsync method inserts the specified string at the beginning of the item body. + * The `prependAsync` method inserts the specified string at the beginning of the item body. * After insertion, the cursor is returned to its original place, relative to the inserted content. * - * When including links in HTML markup, you can disable online link preview by setting the id attribute on the anchor (\) to "LPNoLP" - * (please see the Examples section for a sample). + * When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\) to "LPNoLP" + * (see the **Examples** section for a sample). * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - DataExceedsMaximumSize: The data parameter is longer than 1,000,000 characters. + * - `DataExceedsMaximumSize`: 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. - * Any errors encountered will be provided in the asyncResult.error property. + * @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?: (asyncResult: Office.AsyncResult) => void): void; /** * Replaces the entire body with the specified text. * - * When working with HTML-formatted bodies, it is important to note that the Body.getAsync and Body.setAsync methods are not idempotent. - * The value returned from the getAsync method will not necessarily be exactly the same as the value that was passed in the setAsync method - * previously. The client may modify the value passed to setAsync in order to make it render efficiently with its rendering engine. + * When working with HTML-formatted bodies, it is important to note that the `Body.getAsync` and `Body.setAsync` methods are not idempotent. + * The value returned from the `getAsync` method will not necessarily be exactly the same as the value that was passed in the `setAsync` method + * previously. The client may modify the value passed to `setAsync` in order to make it render efficiently with its rendering engine. * - * When including links in HTML markup, you can disable online link preview by setting the id attribute on the anchor (\) to "LPNoLP" - * (please see the Examples section for a sample). + * When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\) to "LPNoLP" + * (see the **Examples** section for a sample). * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - DataExceedsMaximumSize: The data parameter is longer than 1,000,000 characters. + * - `DataExceedsMaximumSize`: 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. + * - `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. - * 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. - * Any errors encountered will be provided in the asyncResult.error property. + * `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. Any errors encountered will be provided in the `asyncResult.error` property. */ setAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Replaces the entire body with the specified text. * - * When working with HTML-formatted bodies, it is important to note that the Body.getAsync and Body.setAsync methods are not idempotent. - * The value returned from the getAsync method will not necessarily be exactly the same as the value that was passed in the setAsync method - * previously. The client may modify the value passed to setAsync in order to make it render efficiently with its rendering engine. + * When working with HTML-formatted bodies, it is important to note that the `Body.getAsync` and `Body.setAsync` methods are not idempotent. + * The value returned from the `getAsync` method will not necessarily be exactly the same as the value that was passed in the `setAsync` method + * previously. The client may modify the value passed to `setAsync` in order to make it render efficiently with its rendering engine. * - * When including links in HTML markup, you can disable online link preview by setting the id attribute on the anchor (\) to "LPNoLP" - * (please see the Examples section for a sample). + * When including links in HTML markup, you can disable online link preview by setting the id attribute on the anchor (\) to "LPNoLP" + * (see the **Examples** section for a sample). * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - DataExceedsMaximumSize: The data parameter is longer than 1,000,000 characters. + * - `DataExceedsMaximumSize`: 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. + * - `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. - * Any errors encountered will be provided in the asyncResult.error property. + * @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?: (asyncResult: Office.AsyncResult) => void): void; /** * Replaces the selection in the body with the specified text. * - * The setSelectedDataAsync method inserts the specified string at the cursor location in the body of the item, or, if text is selected in - * the editor, it replaces the selected text. If the cursor was never in the body of the item, or if the body of the item lost focus in the + * The `setSelectedDataAsync` method inserts the specified string at the cursor location in the body of the item, or, if text is selected in + * the editor, it replaces the selected text. If the cursor was never in the body of the item, or if the body of the item lost focus in the * UI, the string will be inserted at the top of the body content. After insertion, the cursor is placed at the end of the inserted content. * - * When including links in HTML markup, you can disable online link preview by setting the id attribute on the anchor (\) to "LPNoLP" - * (please see the Examples section for a sample). + * When including links in HTML markup, you can disable online link preview by setting the id attribute on the anchor (\) to "LPNoLP" + * (see the **Examples** section for a sample). * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - DataExceedsMaximumSize: The data parameter is longer than 1,000,000 characters. + * - `DataExceedsMaximumSize`: 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. + * - `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. - * 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. - * Any errors encountered will be provided in the asyncResult.error property. + * `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`. Any errors encountered will be provided in the `asyncResult.error` property. */ setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Replaces the selection in the body with the specified text. * - * The setSelectedDataAsync method inserts the specified string at the cursor location in the body of the item, or, if text is selected in - * the editor, it replaces the selected text. If the cursor was never in the body of the item, or if the body of the item lost focus in the + * The `setSelectedDataAsync` method inserts the specified string at the cursor location in the body of the item, or, if text is selected in + * the editor, it replaces the selected text. If the cursor was never in the body of the item, or if the body of the item lost focus in the * UI, the string will be inserted at the top of the body content. After insertion, the cursor is placed at the end of the inserted content. * - * When including links in HTML markup, you can disable online link preview by setting the id attribute on the anchor (\) to "LPNoLP" - * (please see the Examples section for a sample). + * When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\) to "LPNoLP" + * (see the **Examples** section for a sample). * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - DataExceedsMaximumSize: The data parameter is longer than 1,000,000 characters. + * - `DataExceedsMaximumSize`: 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. + * - `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. - * Any errors encountered will be provided in the asyncResult.error property. + * @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?: (asyncResult: Office.AsyncResult) => void): void; } @@ -11112,119 +11135,119 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface Categories { /** * Adds categories to an item. Each category must be in the categories master list on that mailbox and so must have a unique name * but multiple categories can use the same color. * - * @param categories - The categories to be added to the item. - * @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. - * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * **Errors**: * - * - InvalidCategory: Invalid categories were provided. + * - `InvalidCategory`: Invalid categories were provided. + * + * @param categories - The categories to be added to the item. + * @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`. */ addAsync(categories: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds categories to an item. Each category must be in the categories master list on that mailbox and so must have a unique name * but multiple categories can use the same color. * - * @param categories - The categories to be added to the item. - * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. If adding categories fails, the asyncResult.error property will contain an error code. - * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * **Errors**: * - * - InvalidCategory: Invalid categories were provided. + * - `InvalidCategory`: Invalid categories were provided. + * + * @param categories - The categories to be added to the item. + * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of + * type `Office.AsyncResult`. If adding categories fails, the `asyncResult.error` property will contain an error code. */ addAsync(categories: string[], callback: (asyncResult: Office.AsyncResult) => void): void; /** * Gets an item's categories. * * @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. If adding categories fails, the asyncResult.error property will contain an error code. + * `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`. If adding categories fails, the `asyncResult.error` property will contain an error code. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** * Gets an item's categories. * - * @param callback - 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.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 + * type `Office.AsyncResult`. */ getAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Removes categories from an item. * - * @param categories - The categories to be removed from the item. - * @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. If removing categories fails, the asyncResult.error property will contain an error code. - * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * @param categories - The categories to be removed from the item. + * @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`. If removing categories fails, the `asyncResult.error` property will contain an error code. */ removeAsync(categories: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Removes categories from an item. * - * @param categories - The categories to be removed from the item. - * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. If removing categories fails, the asyncResult.error property will contain an error code. - * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * @param categories - The categories to be removed from the item. + * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of + * type `Office.AsyncResult`. If removing categories fails, the `asyncResult.error` property will contain an error code. */ removeAsync(categories: string[], callback: (asyncResult: Office.AsyncResult) => void): void; } @@ -11235,9 +11258,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface CategoryDetails { /** @@ -11252,14 +11275,14 @@ declare namespace Office { /** * Represents the details about a contact (similar to what's on a physical contact or business card) extracted from the item's body. Read mode only. * - * The list of contacts extracted from the body of an email message or appointment is returned in the contacts property of the - * {@link Office.Entities | Entities} object returned by the getEntities or getEntitiesByType method of the current item. + * The list of contacts extracted from the body of an email message or appointment is returned in the `contacts` property of the + * {@link Office.Entities | Entities} object returned by the `getEntities` or `getEntitiesByType` method of the current item. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read */ interface Contact { /** @@ -11279,7 +11302,7 @@ declare namespace Office { */ personName: string; /** - * An array containing a PhoneNumber object for each phone number associated with the contact. Nullable. + * An array containing a `PhoneNumber` object for each phone number associated with the contact. Nullable. */ phoneNumbers: PhoneNumber[]; /** @@ -11288,147 +11311,150 @@ declare namespace Office { urls: string[]; } /** - * The CustomProperties object represents custom properties that are specific to a particular item and specific to a mail add-in for Outlook. + * The `CustomProperties` object represents custom properties that are specific to a particular item and specific to a mail add-in for Outlook. * For example, there might be a need for a mail add-in to save some data that is specific to the current email message that activated the add-in. * If the user revisits the same message in the future and activates the mail add-in again, the add-in will be able to retrieve the data that had - * been saved as custom properties. **Important**: The maximum length of a CustomProperties JSON object is 2500 characters. + * been saved as custom properties. **Important**: The maximum length of a `CustomProperties` JSON object is 2500 characters. * * Because Outlook on Mac doesn't cache custom properties, if the user's network goes down, mail add-ins cannot access their custom properties. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface CustomProperties { /** * Returns the value of the specified custom property. - * @param name - The name of the custom property to be returned. + * * @returns The value of the specified custom property. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * @param name - The name of the custom property to be returned. */ get(name: string): any; - /** - * Sets the specified property to the specified value. - * - * The set method sets the specified property to the specified value. You must use the saveAsync method to save the property to the server. - * - * The set method creates a new property if the specified property does not already exist; - * otherwise, the existing value is replaced with the new value. - * The value parameter can be of any type; however, it is always passed to the server as a string. - * - * @remarks - * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem - * - * **{@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. - */ - 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. + * To make the removal of the property permanent, you must call the `saveAsync` method of the `CustomProperties` object. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * @param name - The `name` of the property to be removed. */ remove(name: string): void; /** * Saves item-specific custom properties to the server. * - * You must call the saveAsync method to persist any changes made with the set method or the remove method of the CustomProperties object. + * You must call the `saveAsync` method to persist any changes made with the `set` method or the `remove` method of the `CustomProperties` object. * The saving action is asynchronous. * - * It's a good practice to have your callback function check for and handle errors from saveAsync. - * In particular, a read add-in can be activated while the user is in a connected state in a read form, and subsequently the user becomes + * It's a good practice to have your callback function check for and handle errors from `saveAsync`. + * In particular, a read add-in can be activated while the user is in a connected state in a read form, and subsequently the user becomes * disconnected. - * If the add-in calls saveAsync while in the disconnected state, saveAsync would return an error. + * 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 - * type Office.AsyncResult. - * @param asyncContext - Optional. Any state data that is passed to the callback method. - * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 asyncContext - Optional. Any state data that is passed to the callback method. */ saveAsync(callback?: (asyncResult: Office.AsyncResult) => void, asyncContext?: any): void; + /** + * Sets the specified property to the specified value. + * + * The `set` method sets the specified property to the specified value. You must use the `saveAsync` method to save the property to the server. + * + * The `set` method creates a new property if the specified property does not already exist; + * otherwise, the existing value is replaced with the new value. + * The `value` parameter can be of any type; however, it is always passed to the server as a string. + * + * @remarks + * + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` + * + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. + */ + set(name: string, value: string): void; } /** * Provides diagnostic information to an Outlook add-in. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface Diagnostics { /** * Gets a string that represents the name of the host application. * - * A string that can be one of the following values: "Outlook", "OutlookWebApp", "OutlookIOS", or "OutlookAndroid". + * A string that can be one of the following values: `Outlook`, `OutlookWebApp`, `OutlookIOS`, or `OutlookAndroid`. * - * **Note**: The "Outlook" value is returned for Outlook on desktop clients (i.e., Windows and Mac). + * **Note**: The `Outlook` value is returned for Outlook on desktop clients (i.e., Windows and Mac). * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ hostName: string; /** * Gets a string that represents the version of either the host application or the Exchange Server (e.g., "15.0.468.0"). * - * If the mail add-in is running in Outlook on a desktop or mobile client, the hostVersion property returns the version of the host + * If the mail add-in is running in Outlook on a desktop or mobile client, the `hostVersion` property returns the version of the host * application, Outlook. In Outlook on the web, the property returns the version of the Exchange Server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ hostVersion: string; /** * Gets a string that represents the current view of Outlook on the web. * - * The returned string can be one of the following values: "OneColumn", "TwoColumns", or "ThreeColumns". + * The returned string can be one of the following values: `OneColumn`, `TwoColumns`, or `ThreeColumns`. * * If the host application is not Outlook on the web, then accessing this property results in undefined. * * Outlook on the web has three views that correspond to the width of the screen and the window, and the number of columns that can be displayed: * - * - "OneColumn", which is displayed when the screen is narrow. Outlook on the web uses this single-column layout on the entire screen of a + * - `OneColumn`, which is displayed when the screen is narrow. Outlook on the web uses this single-column layout on the entire screen of a * smartphone. * - * - "TwoColumns", which is displayed when the screen is wider. Outlook on the web uses this view on most tablets. + * - `TwoColumns`, which is displayed when the screen is wider. Outlook on the web uses this view on most tablets. * - * - "ThreeColumns", which is displayed when the screen is wide. For example, Outlook on the web uses this view in a full screen window on a + * - `ThreeColumns`, which is displayed when the screen is wide. For example, Outlook on the web uses this view in a full screen window on a * desktop computer. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ OWAView: MailboxEnums.OWAView | "OneColumn" | "TwoColumns" | "ThreeColumns"; } @@ -11437,9 +11463,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface EmailAddressDetails { /** @@ -11452,7 +11478,7 @@ declare namespace Office { displayName: string; /** * Gets the response that an attendee returned for an appointment. - * This property applies to only an attendee of an appointment, as represented by the optionalAttendees or requiredAttendees property. + * 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: MailboxEnums.ResponseType | string; @@ -11466,9 +11492,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read */ interface EmailUser { /** @@ -11487,9 +11513,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ export interface EnhancedLocation { /** @@ -11499,19 +11525,19 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - InvalidFormatError: The format of the specified data object is not valid. + * - `InvalidFormatError`: The format of the specified data object is not valid. * * @param locationIdentifiers The locations to be added to the current list of locations. * @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. Check the `status` property of asyncResult to determine if the call succeeded. + * `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. Check the `status` property of `asyncResult` to determine if the call succeeded. */ addAsync(locationIdentifiers: LocationIdentifier[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResultStatus) => void): void; /** @@ -11521,17 +11547,17 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - InvalidFormatError: The format of the specified data object is not valid. + * - `InvalidFormatError`: The format of the specified data object is not valid. * * @param locationIdentifiers The locations to be added to the current list of locations. - * @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. Check the `status` property of asyncResult to determine if the call succeeded. + * @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. Check the `status` property of `asyncResult` to determine if the call succeeded. */ addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResultStatus) => void): void; /** @@ -11541,14 +11567,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * @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. + * `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. */ getAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -11558,50 +11584,50 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. */ getAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Removes the set of locations associated with the appointment. * - * If there are multiple locations with the same name, all matching locations will be removed even if only one was specified in locationIdentifiers. + * If there are multiple locations with the same name, all matching locations will be removed even if only one was specified in `locationIdentifiers`. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param locationIdentifiers The locations to be removed from the current list of locations. * @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. Check the `status` property of asyncResult to determine if the call succeeded. + * `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. Check the `status` property of `asyncResult` to determine if the call succeeded. */ removeAsync(locationIdentifiers: LocationIdentifier[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResultStatus) => void): void; /** * Removes the set of locations associated with the appointment. * - * If there are multiple locations with the same name, all matching locations will be removed even if only one was specified in locationIdentifiers. + * If there are multiple locations with the same name, all matching locations will be removed even if only one was specified in `locationIdentifiers`. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param locationIdentifiers The locations to be removed from the current list of locations. - * @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. Check the `status` property of asyncResult to determine if the call succeeded. + * @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. Check the `status` property of `asyncResult` to determine if the call succeeded. */ removeAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResultStatus) => void): void; } @@ -11627,7 +11653,7 @@ declare namespace Office { /** * Represents a collection of entities found in an email message or appointment. Read mode only. * - * The Entities object is a container for the entity arrays returned by the getEntities and getEntitiesByType methods when the item + * The `Entities` object is a container for the entity arrays returned by the `getEntities` and `getEntitiesByType` methods when the item * (either an email message or an appointment) contains one or more entities that have been found by the server. * You can use these entities in your code to provide additional context information to the viewer, such as a map to an address found in the item, * or to open a dialer for a phone number found in the item. @@ -11644,14 +11670,14 @@ declare namespace Office { * Entity recognition relies on natural language recognition that is based on machine learning of large amounts of data. * The recognition of an entity is non-deterministic and success sometimes relies on the particular context in the item. * - * When the property arrays are returned by the getEntitiesByType method, only the property for the specified entity contains data; + * When the property arrays are returned by the `getEntitiesByType` method, only the property for the specified entity contains data; * all other properties are null. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read */ interface Entities { /** @@ -11690,59 +11716,59 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose */ interface From { /** * Gets the from value of a message. * - * The getAsync method starts an asynchronous call to the Exchange server to get the from value of a message. + * The `getAsync` method starts an asynchronous call to the Exchange server to get the from value of a message. * - * The from value of the item is provided as an {@link Office.EmailAddressDetails | EmailAddressDetails} in the asyncResult.value property. + * The from value of the item is provided as an {@link Office.EmailAddressDetails | EmailAddressDetails} in the `asyncResult.value` property. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. - * The `value` property of the result is the item's from value, as an EmailAddressDetails object. + * `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. + * The `value` property of the result is the item's from value, as an `EmailAddressDetails` object. */ getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Gets the from value of a message. * - * The getAsync method starts an asynchronous call to the Exchange server to get the from value of a message. + * The `getAsync` method starts an asynchronous call to the Exchange server to get the from value of a message. * - * The from value of the item is provided as an {@link Office.EmailAddressDetails | EmailAddressDetails} in the asyncResult.value property. + * The from value of the item is provided as an {@link Office.EmailAddressDetails | EmailAddressDetails} in the `asyncResult.value` property. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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 the item's from value, as an EmailAddressDetails object. + * `asyncResult`, which is an `Office.AsyncResult` object. + * The `value` property of the result is the item's from value, as an `EmailAddressDetails` object. */ getAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; } /** - * The InternetHeaders object represents custom internet headers that are preserved after the message item leaves Exchange and is converted to a MIME message. - * These headers are stored as x-headers in the MIME message. + * The `InternetHeaders` object represents custom internet headers that are preserved after the message item leaves Exchange + * and is converted to a MIME message. These headers are stored as x-headers in the MIME message. * - * InternetHeaders are stored as key/value pairs on a per-item basis. + * Internet headers are stored as key/value pairs on a per-item basis. * * **Note**: This object is intended for you to set and get your custom headers on a message item. * @@ -11750,9 +11776,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose */ interface InternetHeaders { /** @@ -11765,15 +11791,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. + * `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. */ getAsync(names: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -11786,13 +11812,13 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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 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. */ getAsync(names: string[], callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -11804,15 +11830,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. + * `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. */ removeAsync(names: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -11824,19 +11850,19 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 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. */ removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Sets the specified internet headers to the specified values. * - * The setAsync method creates a new header if the specified header doesn't already exist; otherwise, the existing value is replaced with + * The `setAsync` method creates a new header if the specified header doesn't already exist; otherwise, the existing value is replaced with * the new value. * * **Note**: This method is intended to set the values of your custom headers. @@ -11845,22 +11871,22 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 * 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. - * 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. - * Any errors encountered will be provided in the asyncResult.error property. + * `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. Any errors encountered will be provided in the `asyncResult.error` property. */ setAsync(headers: Object, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Sets the specified internet headers to the specified values. * - * The setAsync method creates a new header if the specified header doesn't already exist; otherwise, the existing value is replaced with + * The `setAsync` method creates a new header if the specified header doesn't already exist; otherwise, the existing value is replaced with * the new value. * * **Note**: This method is intended to set the values of your custom headers. @@ -11869,14 +11895,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 * 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. - * Any errors encountered will be provided in the asyncResult.error property. + * @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(headers: Object, callback?: (asyncResult: Office.AsyncResult) => void): void; } @@ -11899,17 +11925,17 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer, Appointment Attendee, Message Compose, Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer, Appointment Attendee, Message Compose, Message Read */ interface Item { } /** * The compose mode of {@link Office.Item | Office.context.mailbox.item}. * - * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. - * You should treat this as a mode of Office.context.mailbox.item. Refer to the + * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. + * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.8/office.context.mailbox.item | Object Model} page for more information. * * Child interfaces: @@ -11923,8 +11949,8 @@ declare namespace Office { /** * The read mode of {@link Office.Item | Office.context.mailbox.item}. * - * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. - * You should treat this as a mode of Office.context.mailbox.item. Refer to the + * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. + * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.8/office.context.mailbox.item | Object Model} page for more information. * * Child interfaces: @@ -11940,9 +11966,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read */ interface LocalClientTime { /** @@ -11985,95 +12011,95 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose */ interface Location { /** * 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 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. + * 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. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * @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`. */ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: 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 - When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. + * 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. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 `Office.AsyncResult`. */ getAsync(callback: (asyncResult: 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. + * 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. - * 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. If setting the location fails, the asyncResult.error property will contain an error code. - * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. + * + * @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 + * type `Office.AsyncResult`. If setting the location fails, the `asyncResult.error` property will contain an error code. */ setAsync(location: string, options?: Office.AsyncContextOptions, callback?: (asyncResult: 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. + * 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 - * type Office.AsyncResult. If setting the location fails, the asyncResult.error property will contain an error code. - * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. + * - `DataExceedsMaximumSize`: The location parameter is longer than 255 characters. + * + * @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. */ setAsync(location: string, callback?: (asyncResult: Office.AsyncResult) => void): void; } @@ -12084,13 +12110,13 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ export interface LocationDetails { /** - * The LocationIdentifier of the location. + * The `LocationIdentifier` of the location. */ locationIdentifier: LocationIdentifier; /** @@ -12103,23 +12129,23 @@ declare namespace Office { emailAddress: string; } /** - * Represents the id of a location. + * Represents the ID of a location. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface LocationIdentifier { /** - * The location's unique id. + * The location's unique ID. * - * For **Room** type, it's the room's email address. + * For `Room` type, it's the room's email address. * - * For **Custom** type, it's the displayName. + * For `Custom` type, it's the `displayName`. */ id: string; /** @@ -12128,21 +12154,21 @@ declare namespace Office { type: MailboxEnums.LocationType | string; } /** - * Provides access to the Outlook Add-in object model for Microsoft Outlook and Microsoft Outlook on the web. + * Provides access to the Microsoft Outlook add-in object model. * - * Namespaces: + * Key properties: * - * - diagnostics: Provides diagnostic information to an Outlook add-in. + * - `diagnostics`: Provides diagnostic information to an Outlook add-in. * - * - item: Provides methods and properties for accessing a message or appointment in an Outlook add-in. + * - `item`: Provides methods and properties for accessing a message or appointment in an Outlook add-in. * - * - userProfile: Provides information about the user in an Outlook add-in. + * - `userProfile`: Provides information about the user in an Outlook add-in. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface Mailbox { /** @@ -12150,55 +12176,53 @@ declare namespace Office { * * Contains the following members: * - * - hostName (string): A string that represents the name of the host application. - * It should be one of the following values: "Outlook", "OutlookWebApp", "OutlookIOS", or "OutlookAndroid". + * - `hostName` (string): A string that represents the name of the host application. + * It should be one of the following values: `Outlook`, `OutlookWebApp`, `OutlookIOS`, or `OutlookAndroid`. * **Note**: The "Outlook" value is returned for Outlook on desktop clients (i.e., Windows and Mac). * - * - hostVersion (string): A string that represents the version of either the host application or the Exchange Server (e.g., "15.0.468.0"). - * If the mail add-in is running in Outlook on desktop or mobile clients, the hostVersion property returns the version of the + * - `hostVersion` (string): A string that represents the version of either the host application or the Exchange Server (e.g., "15.0.468.0"). + * If the mail add-in is running in Outlook on desktop or mobile clients, the `hostVersion` property returns the version of the * host application, Outlook. In Outlook on the web, the property returns the version of the Exchange Server. * - * - OWAView (MailboxEnums.OWAView or string): An enum (or string literal) that represents the current view of Outlook on the web. + * - `OWAView` (`MailboxEnums.OWAView` or string): An enum (or string literal) that represents the current view of Outlook on the web. * If the host application is not Outlook on the web, then accessing this property results in undefined. - * Outlook on the web has three views ("OneColumn" - displayed when the screen is narrow, "TwoColumns" - displayed when the screen is wider, - * and "ThreeColumns" - displayed when the screen is wide) that correspond to the width of the screen and the window, and the number of columns + * Outlook on the web has three views (`OneColumn` - displayed when the screen is narrow, `TwoColumns` - displayed when the screen is wider, + * and `ThreeColumns` - displayed when the screen is wide) that correspond to the width of the screen and the window, and the number of columns * that can be displayed. * * More information is under {@link Office.Diagnostics}. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ diagnostics: Diagnostics; /** * Gets the URL of the Exchange Web Services (EWS) endpoint for this email account. Read mode only. * - * Your app must have the ReadItem permission specified in its manifest to call the ewsUrl member in read mode. + * Your app must have the `ReadItem` permission specified in its manifest to call the `ewsUrl` member in read mode. * - * In compose mode you must call the saveAsync method before you can use the ewsUrl member. - * Your app must have ReadWriteItem permissions to call the saveAsync method. + * In compose mode you must call the `saveAsync` method before you can use the `ewsUrl` member. + * Your app must have `ReadWriteItem` permissions to call the `saveAsync` method. * * **Note**: This member is not supported in Outlook on iOS or Android. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * - * The ewsUrl value can be used by a remote service to make EWS calls to the user's mailbox. - * For example, you can create a remote service to {@link https://docs.microsoft.com/outlook/add-ins/get-attachments-of-an-outlook-item | get attachments from the selected item}. + * The `ewsUrl` value can be used by a remote service to make EWS calls to the user's mailbox. + * For example, you can create a remote service to {@link https://docs.microsoft.com/office/dev/add-ins/outlook/get-attachments-of-an-outlook-item | get attachments from the selected item}. */ ewsUrl: string; /** * The mailbox item. Depending on the context in which the add-in opened, the item type may vary. * If you want to see IntelliSense for only a specific type or mode, cast this item to one of the following: * - * {@link Office.ItemCompose | ItemCompose}, {@link Office.ItemRead | ItemRead}, - * {@link Office.Message | Message}, {@link Office.Appointment | Appointment}, * {@link Office.MessageCompose | MessageCompose}, {@link Office.MessageRead | MessageRead}, * {@link Office.AppointmentCompose | AppointmentCompose}, {@link Office.AppointmentRead | AppointmentRead} */ @@ -12210,28 +12234,28 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ masterCategories: MasterCategories; /** * Gets the URL of the REST endpoint for this email account. * - * Your app must have the ReadItem permission specified in its manifest to call the restUrl member in read mode. + * Your app must have the `ReadItem` permission specified in its manifest to call the `restUrl` member in read mode. * - * In compose mode you must call the saveAsync method before you can use the restUrl member. - * Your app must have ReadWriteItem permissions to call the saveAsync method. + * In compose mode you must call the saveAsync method before you can use the `restUrl` member. + * Your app must have `ReadWriteItem` permissions to call the `saveAsync` method. * * [Api set: Mailbox 1.5] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * - * The restUrl value can be used to make {@link https://docs.microsoft.com/outlook/rest/ | REST API} calls to the user's mailbox. + * The `restUrl` value can be used to make {@link https://docs.microsoft.com/outlook/rest/ | REST API} calls to the user's mailbox. */ restUrl: string; /** @@ -12250,16 +12274,16 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * The type property on the parameter will match the eventType parameter passed to addHandlerAsync. + * @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 - * 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`. */ addHandlerAsync(eventType: Office.EventType | string, handler: (type: Office.EventType) => void, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -12271,22 +12295,22 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * 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 of - * type Office.AsyncResult. + * @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 of + * type `Office.AsyncResult`. */ addHandlerAsync(eventType: Office.EventType | string, handler: (type: Office.EventType) => void, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Converts an item ID formatted for REST into EWS format. * - * Item IDs retrieved via a REST API (such as the Outlook Mail API or the Microsoft Graph) use a different format than the format used by - * Exchange Web Services (EWS). The convertToEwsId method converts a REST-formatted ID into the proper format for EWS. + * Item IDs retrieved via a REST API (such as the Outlook Mail API or the Microsoft Graph) use a different format than the format used by + * Exchange Web Services (EWS). The `convertToEwsId` method converts a REST-formatted ID into the proper format for EWS. * * **Note**: This method is not supported in Outlook on iOS or Android. * @@ -12294,9 +12318,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. @@ -12310,18 +12334,18 @@ declare namespace Office { * You should handle date and time values so that the values you display on the user interface are always consistent with the time zone that * the user expects. * - * If the mail app is running in Outlook on desktop clients, the convertToLocalClientTime method will return a dictionary object with the values set to the - * client computer time zone. - * If the mail app is running in Outlook on the web, the convertToLocalClientTime method will return a dictionary object with the values set to - * the time zone specified in the EAC. + * If the mail app is running in Outlook on desktop clients, the `convertToLocalClientTime` method will return a dictionary object + * with the values set to the client computer time zone. + * If the mail app is running in Outlook on the web, the `convertToLocalClientTime` method will return a dictionary object + * with the values set to the time zone specified in the EAC. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * - * @param timeValue - A Date object. + * @param timeValue - A `Date` object. */ convertToLocalClientTime(timeValue: Date): LocalClientTime; /** @@ -12333,38 +12357,40 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * - * Item IDs retrieved via EWS or via the itemId property use a different format than the format used by REST APIs (such as the - * {@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. + * Item IDs retrieved via EWS or via the `itemId` property use a different format than the format used by REST APIs (such as the + * {@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. */ convertToRestId(itemId: string, restVersion: MailboxEnums.RestVersion | string): string; /** - * Gets a Date object from a dictionary containing time information. + * Gets a `Date` object from a dictionary containing time information. * - * The convertToUtcClientTime method converts a dictionary containing a local date and time to a Date object with the correct values for the + * The `convertToUtcClientTime` method converts a dictionary containing a local date and time to a `Date` object with the correct values for the * local date and time. + * + * @returns A Date object with the time expressed in UTC. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * @param input - The local time value to convert. - * @returns A Date object with the time expressed in UTC. */ convertToUtcClientTime(input: LocalClientTime): Date; /** * Displays an existing calendar appointment. * - * The displayAppointmentForm method opens an existing calendar appointment in a new window on the desktop or in a dialog box on + * The `displayAppointmentForm` method opens an existing calendar appointment in a new window on the desktop or in a dialog box on * mobile devices. * * In Outlook on Mac, you can use this method to display a single appointment that is not part of a recurring series, or the @@ -12380,9 +12406,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * @param itemId - The Exchange Web Services (EWS) identifier for an existing calendar appointment. */ @@ -12390,23 +12416,23 @@ declare namespace Office { /** * Displays an existing message. * - * The displayMessageForm method opens an existing message in a new window on the desktop or in a dialog box on mobile devices. + * The `displayMessageForm` method opens an existing message in a new window on the desktop or in a dialog box on mobile devices. * * In Outlook on the web, this method opens the specified form only if the body of the form is less than or equal to 32 KB number of characters. * - * If the specified item identifier does not identify an existing message, no message will be displayed on the client computer, and + * If the specified item identifier does not identify an existing message, no message will be displayed on the client computer, and * no error message will be returned. * - * Do not use the displayMessageForm with an itemId that represents an appointment. Use the displayAppointmentForm method to display - * an existing appointment, and displayNewAppointmentForm to display a form to create a new appointment. + * Do not use the `displayMessageForm` with an itemId that represents an appointment. Use the `displayAppointmentForm` method to display + * an existing appointment, and `displayNewAppointmentForm` to display a form to create a new appointment. * * **Note**: This method is not supported in Outlook on iOS or Android. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * @param itemId - The Exchange Web Services (EWS) identifier for an existing message. */ @@ -12414,16 +12440,16 @@ declare namespace Office { /** * Displays a form for creating a new calendar appointment. * - * The displayNewAppointmentForm method opens a form that enables the user to create a new appointment or meeting. + * The `displayNewAppointmentForm` method opens a form that enables the user to create a new appointment or meeting. * If parameters are specified, the appointment form fields are automatically populated with the contents of the parameters. * - * In Outlook on the web, this method always displays a form with an attendees field. - * If you do not specify any attendees as input arguments, the method displays a form with a Save button. - * If you have specified attendees, the form would include the attendees and a Send button. + * In Outlook on the web, this method always displays a form with an attendees field. + * If you do not specify any attendees as input arguments, the method displays a form with a **Save** button. + * If you have specified attendees, the form would include the attendees and a **Send** button. * - * In the Outlook rich client and Outlook RT, if you specify any attendees or resources in the requiredAttendees, optionalAttendees, or - * resources parameter, this method displays a meeting form with a Send button. - * If you don't specify any recipients, this method displays an appointment form with a Save & Close button. + * In the Outlook rich client and Outlook RT, if you specify any attendees or resources in the `requiredAttendees`, `optionalAttendees`, or + * `resources` parameter, this method displays a meeting form with a **Send** button. + * If you don't specify any recipients, this method displays an appointment form with a **Save & Close** button. * * If any of the parameters exceed the specified size limits, or if an unknown parameter name is specified, an exception is thrown. * @@ -12431,17 +12457,17 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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; /** * Displays a form for creating a new message. * - * The displayNewMessageForm method opens a form that enables the user to create a new message. If parameters are specified, the message form + * The `displayNewMessageForm` method opens a form that enables the user to create a new message. If parameters are specified, the message form * fields are automatically populated with the contents of the parameters. * * If any of the parameters exceed the specified size limits, or if an unknown parameter name is specified, an exception is thrown. @@ -12450,37 +12476,37 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. * - * toRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object + * `toRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object * for each of the recipients on the To line. The array is limited to a maximum of 100 entries. * - * ccRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object + * `ccRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object * for each of the recipients on the Cc line. The array is limited to a maximum of 100 entries. * - * bccRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object + * `bccRecipients`: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object * for each of the recipients on the Bcc line. The array is limited to a maximum of 100 entries. * - * subject: A string containing the subject of the message. The string is limited to a maximum of 255 characters. + * `subject`: A string containing the subject of the message. The string is limited to a maximum of 255 characters. * - * htmlBody: The HTML body of the message. The body content is limited to a maximum size of 32 KB. + * `htmlBody`: The HTML body of the message. The body content is limited to a maximum size of 32 KB. * - * attachments: An array of JSON objects that are either file or item attachments. + * `attachments`: An array of JSON objects that are either file or item attachments. * - * attachments.type: Indicates the type of attachment. Must be file for a file attachment or item for an item attachment. + * `attachments.type`: Indicates the type of attachment. Must be file for a file attachment or item for an item attachment. * - * attachments.name: A string that contains the name of the attachment, up to 255 characters in length. + * `attachments.name`: A string that contains the name of the attachment, up to 255 characters in length. * - * attachments.url: Only used if type is set to file. The URI of the location for the file. + * `attachments.url`: Only used if type is set to file. The URI of the location for the file. * - * attachments.isInline: Only used if type is set to file. If true, indicates that the attachment will be shown inline in the + * `attachments.isInline`: Only used if type is set to file. If true, indicates that the attachment will be shown inline in the * message body, and should not be displayed in the attachment list. * - * attachments.itemId: Only used if type is set to item. The EWS item id of the existing e-mail you want to attach to the new message. + * `attachments.itemId`: Only used if type is set to item. The EWS item id of the existing e-mail you want to attach to the new message. * This is a string up to 100 characters. */ displayNewMessageForm(parameters: any): void; @@ -12492,34 +12518,34 @@ declare namespace Office { * * The token is returned as a string in the `asyncResult.value` property. * - * Calling the `getCallbackTokenAsync` method in read mode requires a minimum permission level of **ReadItem**. + * Calling the `getCallbackTokenAsync` method in read mode requires a minimum permission level of `ReadItem`. * * Calling the `getCallbackTokenAsync` method in compose mode requires you to have saved the item. - * The `saveAsync` method requires a minimum permission level of **ReadWriteItem**. + * The `saveAsync` method requires a minimum permission level of `ReadWriteItem`. * * *REST Tokens* * - * When a REST token is requested (options.isRest = true), the resulting token will not work to authenticate Exchange Web Services calls. - * The token will be limited in scope to read-only access to the current item and its attachments, unless the add-in has specified the - * ReadWriteMailbox permission in its manifest. - * If the ReadWriteMailbox permission is specified, the resulting token will grant read/write access to mail, calendar, and contacts, + * When a REST token is requested (`options.isRest = true`), the resulting token will not work to authenticate Exchange Web Services calls. + * The token will be limited in scope to read-only access to the current item and its attachments, unless the add-in has specified the + * `ReadWriteMailbox` permission in its manifest. + * If the `ReadWriteMailbox` permission is specified, the resulting token will grant read/write access to mail, calendar, and contacts, * including the ability to send mail. * - * The add-in should use the restUrl property to determine the correct URL to use when making REST API calls. + * The add-in should use the `restUrl` property to determine the correct URL to use when making REST API calls. * * *EWS Tokens* * - * When an EWS token is requested (options.isRest = false), the resulting token will not work to authenticate REST API calls. + * When an EWS token is requested (`options.isRest = false`), the resulting token will not work to authenticate REST API calls. * The token will be limited in scope to accessing the current item. * - * The add-in should use the ewsUrl property to determine the correct URL to use when making EWS calls. + * The add-in should use the `ewsUrl` property to determine the correct URL to use when making EWS calls. * * You can pass both the token and either an attachment identifier or item identifier to a third-party system. The third-party system uses * the token as a bearer authorization token to call the Exchange Web Services (EWS) * {@link https://docs.microsoft.com/exchange/client-developer/web-service-reference/getattachment-operation | GetAttachment} operation or * {@link https://docs.microsoft.com/exchange/client-developer/web-service-reference/getitem-operation | GetItem} operation to return an * attachment or item. For example, you can create a remote service to - * {@link https://docs.microsoft.com/outlook/add-ins/get-attachments-of-an-outlook-item | get attachments from the selected item}. + * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/get-attachments-of-an-outlook-item | get attachments from the selected item}. * * **Note**: It is recommended that add-ins use the REST APIs instead of Exchange Web Services whenever possible. * @@ -12527,23 +12553,23 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * **Errors**: * - * - HTTPRequestFailure: The request has failed. Please look at the diagnostics object for the HTTP error code. + * - `HTTPRequestFailure`: The request has failed. Please look at the diagnostics object for the HTTP error code. * - * - InternalServerError: The Exchange server returned an error. Please look at the diagnostics object for more information. + * - `InternalServerError`: The Exchange server returned an error. Please look at the diagnostics object for more information. * - * - NetworkError: The user is no longer connected to the network. Please check your network connection and try again. + * - `NetworkError`: The user is no longer connected to the network. Please check your network connection and try again. * * @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 - * type Office.AsyncResult. The token is returned as a string in the `asyncResult.value` property. + * `isRest`: Determines if the token provided will be used for the Outlook REST APIs or Exchange Web Services. Default value is `false`. + * `asyncContext`: Any state data that is passed to the asynchronous method. + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of + * type `Office.AsyncResult`. The token is returned as a string in the `asyncResult.value` property. * If there was an error, the `asyncResult.error` and `asyncResult.diagnostics` properties may provide additional information. */ getCallbackTokenAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (asyncResult: Office.AsyncResult) => void): void; @@ -12560,31 +12586,31 @@ declare namespace Office { * {@link https://docs.microsoft.com/exchange/client-developer/web-service-reference/getattachment-operation | GetAttachment} operation or * {@link https://docs.microsoft.com/exchange/client-developer/web-service-reference/getitem-operation | GetItem} operation to return an * attachment or item. For example, you can create a remote service to - * {@link https://docs.microsoft.com/outlook/add-ins/get-attachments-of-an-outlook-item | get attachments from the selected item}. + * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/get-attachments-of-an-outlook-item | get attachments from the selected item}. * - * Calling the `getCallbackTokenAsync` method in read mode requires a minimum permission level of **ReadItem**. + * Calling the `getCallbackTokenAsync` method in read mode requires a minimum permission level of `ReadItem`. * * Calling the `getCallbackTokenAsync` method in compose mode requires you to have saved the item. - * The `saveAsync` method requires a minimum permission level of **ReadWriteItem**. + * The `saveAsync` method requires a minimum permission level of `ReadWriteItem`. * * [Api set: All support Read mode; Mailbox 1.3 introduced Compose mode support] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * **Errors**: * - * - HTTPRequestFailure: The request has failed. Please look at the diagnostics object for the HTTP error code. + * - `HTTPRequestFailure`: The request has failed. Please look at the diagnostics object for the HTTP error code. * - * - InternalServerError: The Exchange server returned an error. Please look at the diagnostics object for more information. + * - `InternalServerError`: The Exchange server returned an error. Please look at the diagnostics object for more information. * - * - NetworkError: The user is no longer connected to the network. Please check your network connection and try again. + * - `NetworkError`: The user is no longer connected to the network. Please check your network connection and try again. * - * @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 returned as a string 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`. The token is returned as a string in the `asyncResult.value` property. * If there was an error, the `asyncResult.error` and `asyncResult.diagnostics` properties may provide additional information. * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ @@ -12596,23 +12622,23 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * - * 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}. + * The `getUserIdentityTokenAsync` method returns a token that you can use to identify and + * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/authentication | authenticate the add-in and user with a third-party system}. * * **Errors**: * - * - HTTPRequestFailure: The request has failed. Please look at the diagnostics object for the HTTP error code. + * - `HTTPRequestFailure`: The request has failed. Please look at the diagnostics object for the HTTP error code. * - * - InternalServerError: The Exchange server returned an error. Please look at the diagnostics object for more information. + * - `InternalServerError`: The Exchange server returned an error. Please look at the diagnostics object for more information. * - * - NetworkError: The user is no longer connected to the network. Please check your network connection and try again. + * - `NetworkError`: The user is no longer connected to the network. Please check your network connection and try again. * * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. + * type `Office.AsyncResult`. * The token is returned as a string in the `asyncResult.value` property. * If there was an error, the `asyncResult.error` and `asyncResult.diagnostics` properties may provide additional information. * @param userContext - Optional. Any state data that is passed to the asynchronous method. @@ -12623,17 +12649,17 @@ declare namespace Office { * * In these cases, add-ins should use REST APIs to access the user's mailbox instead. * - * The makeEwsRequestAsync method sends an EWS request on behalf of the add-in to Exchange. + * The `makeEwsRequestAsync` method sends an EWS request on behalf of the add-in to Exchange. * - * You cannot request Folder Associated Items with the makeEwsRequestAsync method. + * You cannot request Folder Associated Items with the `makeEwsRequestAsync` method. * - * The XML request must specify UTF-8 encoding. \ + * The XML request must specify UTF-8 encoding: `\`. * - * Your add-in must have the ReadWriteMailbox permission to use the makeEwsRequestAsync method. - * For information about using the ReadWriteMailbox permission and the EWS operations that you can call with the makeEwsRequestAsync method, - * see {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Specify permissions for mail add-in access to the user's mailbox}. + * Your add-in must have the `ReadWriteMailbox` permission to use the `makeEwsRequestAsync` method. + * For information about using the `ReadWriteMailbox` permission and the EWS operations that you can call with the `makeEwsRequestAsync` method, + * see {@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Specify permissions for mail add-in access to the user's mailbox}. * - * The XML result of the EWS call is provided as a string in the asyncResult.value property. + * The XML result of the EWS call is provided as a string in the `asyncResult.value` property. * If the result exceeds 1 MB in size, an error message is returned instead. * * **Note**: This method is not supported in the following scenarios: @@ -12642,28 +12668,29 @@ declare namespace Office { * * - When the add-in is loaded in a Gmail mailbox. * - * **Note**: The server administrator must set OAuthAuthentication to true on the Client Access Server EWS directory to enable the - * makeEwsRequestAsync method to make EWS requests. + * **Note**: The server administrator must set `OAuthAuthentication` to `true` on the Client Access Server EWS directory to enable the + * `makeEwsRequestAsync` method to make EWS requests. * * *Version differences* * - * When you use the makeEwsRequestAsync method in mail apps running in Outlook versions earlier than version 15.0.4535.1004, you should set + * When you use the `makeEwsRequestAsync` method in mail apps running in Outlook versions earlier than version 15.0.4535.1004, you should set * the encoding value to ISO-8859-1. * * `` * - * You do not need to set the encoding value when your mail app is running in Outlook on the web. - * You can determine whether your mail app is running in Outlook or Outlook on the web by using the mailbox.diagnostics.hostName property. - * You can determine what version of Outlook is running by using the mailbox.diagnostics.hostVersion property. + * You do not need to set the encoding value when your mail app is running in Outlook on the web. + * You can determine whether your mail app is running in Outlook or Outlook on the web by using the `mailbox.diagnostics.hostName` property. + * You can determine what version of Outlook is running by using the `mailbox.diagnostics.hostVersion` property. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or 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 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. @@ -12678,14 +12705,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * 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`. */ removeHandlerAsync(eventType: Office.EventType | string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -12697,13 +12724,13 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 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`. */ removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult) => void): void; } @@ -12717,147 +12744,146 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface MasterCategories { /** * Adds categories to the master list on a mailbox. Each category must have a unique name but multiple categories can use the same color. * - * @param categories - The categories to be added to the master list on the mailbox. - * @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. - * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * **Errors**: * - * - DuplicateCategory: One of the categories provided is already in the master category list. + * - `DuplicateCategory`: One of the categories provided is already in the master category list. * - * - PermissionDenied: The user does not have permission to perform this action. + * - `PermissionDenied`: The user does not have permission to perform this action. + * + * @param categories - The categories to be added to the master list on the mailbox. + * @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`. */ addAsync(categories: CategoryDetails[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds categories to the master list on a mailbox. Each category must have a unique name but multiple categories can use the same color. * - * @param categories - The categories to be added to the master list on the mailbox. - * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. If adding categories fails, the asyncResult.error property will contain an error code. - * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * **Errors**: * - * - DuplicateCategory: One of the categories provided is already in the master category list. + * - `DuplicateCategory`: One of the categories provided is already in the master category list. * - * - PermissionDenied: The user does not have permission to perform this action. + * - `PermissionDenied`: The user does not have permission to perform this action. + * + * @param categories - The categories to be added to the master list on the mailbox. + * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of + * type `Office.AsyncResult`. If adding categories fails, the `asyncResult.error` property will contain an error code. */ addAsync(categories: CategoryDetails[], callback: (asyncResult: Office.AsyncResult) => void): void; /** * Gets the master list of categories on a mailbox. * - * @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. If adding categories fails, the asyncResult.error property will contain an error code. - * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * @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`. If adding categories fails, the `asyncResult.error` property will contain an error code. */ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** * Gets the master list of categories on a mailbox. * - * @param callback - 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.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 + * type `Office.AsyncResult`. */ getAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Removes categories from the master list on a mailbox. * - * @param categories - The categories to be removed from the master list on the mailbox. - * @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. If removing categories fails, the asyncResult.error property will contain an error code. - * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * **Errors**: * - * - PermissionDenied: The user does not have permission to perform this action. + * - `PermissionDenied`: The user does not have permission to perform this action. + * + * @param categories - The categories to be removed from the master list on the mailbox. + * @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`. If removing categories fails, the `asyncResult.error` property will contain an error code. */ removeAsync(categories: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Removes categories from the master list on a mailbox. * - * @param categories - The categories to be removed from the master list on the mailbox. - * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. If removing categories fails, the asyncResult.error property will contain an error code. - * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteMailbox` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * **Errors**: * - * - PermissionDenied: The user does not have permission to perform this action. + * - `PermissionDenied`: The user does not have permission to perform this action. + * + * @param categories - The categories to be removed from the master list on the mailbox. + * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of + * type `Office.AsyncResult`. If removing categories fails, the `asyncResult.error` property will contain an error code. */ removeAsync(categories: string[], callback: (asyncResult: Office.AsyncResult) => void): void; } /** * Represents a suggested meeting found in an item. Read mode only. * - * The list of meetings suggested in an email message is returned in the meetingSuggestions property of the Entities object that is returned when - * the getEntities or getEntitiesByType method is called on the active item. + * The list of meetings suggested in an email message is returned in the `meetingSuggestions` property of the `Entities` object that is returned when + * the `getEntities` or `getEntitiesByType` method is called on the active item. * - * The start and end values are string representations of a Date object that contains the date and time at which the suggested meeting is to - * begin and end. - * The values are in the default time zone specified for the current user. + * The start and end values are string representations of a `Date` object that contains the date and time at which the suggested meeting is to + * begin and end. The values are in the default time zone specified for the current user. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read */ interface MeetingSuggestion { /** @@ -12889,7 +12915,7 @@ declare namespace Office { * A subclass of {@link Office.Item | Item} for messages. * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. - * You should treat this as a mode of Office.context.mailbox.item. Refer to the + * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.8/office.context.mailbox.item | Object Model} page for more information. * * Child interfaces: @@ -12904,7 +12930,7 @@ declare namespace Office { * The message compose mode of {@link Office.Item | Office.context.mailbox.item}. * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. - * You should treat this as a mode of Office.context.mailbox.item. Refer to the + * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.8/office.context.mailbox.item | Object Model} page for more information. * * Parent interfaces: @@ -12927,9 +12953,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ bcc: Recipients; /** @@ -12939,9 +12965,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ body: Body; /** @@ -12951,16 +12977,16 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ categories: Categories; /** * 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. * - * The cc property returns a {@link Office.Recipients | Recipients} object that provides methods to get or update the recipients on the Cc line of + * The `cc` property returns a {@link Office.Recipients | Recipients} object that provides methods to get or update the recipients on the Cc line of * the message. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, the following limits apply. * * - Get 500 members maximum. @@ -12969,9 +12995,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ cc: Recipients; /** @@ -12982,57 +13008,57 @@ declare namespace Office { * and that value you obtained earlier will no longer apply. * * You get null for this property for a new item in a compose form. - * If the user sets a subject and saves the item, the conversationId property will return a value. + * If the user sets a subject and saves the item, the `conversationId` property will return a value. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ conversationId: string; /** * Gets the email address of the sender of a message. * - * The from and sender properties represent the same person unless the message is sent by a delegate. - * In that case, the from property represents the owner, and the sender property represents the delegate. + * The `from` and `sender` properties represent the same person unless the message is sent by a delegate. + * In that case, the `from` property represents the owner, and the `sender` property represents the delegate. * - * The from property returns a From object that provides a method to get the from value. + * The `from` property returns a `From` object that provides a method to get the from value. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ from: From; /** * Gets or sets the custom internet headers of a message. * - * The internetHeaders property returns an InternetHeaders object that provides methods to manage the internet headers on the message. + * The `internetHeaders` property returns an `InternetHeaders` object that provides methods to manage the internet headers on the message. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ internetHeaders: InternetHeaders; /** * Gets the type of item that an instance represents. * - * The itemType property returns one of the ItemType enumeration values, indicating whether the item object instance is a message or + * The `itemType` property returns one of the `ItemType` enumeration values, indicating whether the item object instance is a message or * an appointment. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ itemType: MailboxEnums.ItemType | string; /** @@ -13042,53 +13068,53 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ notificationMessages: NotificationMessages; /** - * Gets the id of the series that an instance belongs to. + * Gets the ID of the series that an instance belongs to. * - * In Outlook on the web and desktop clients, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to. - * However, on iOS and Android, the seriesId returns the REST ID of the parent item. + * In Outlook on the web and desktop clients, the `seriesId` returns the Exchange Web Services (EWS) ID of the parent (series) item + * that this item belongs to. However, on iOS and Android, the seriesId returns the REST ID of the parent item. * - * **Note**: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier. - * The seriesId property is not identical to the Outlook IDs used by the Outlook REST API. - * Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId. - * For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. + * **Note**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier. + * The `seriesId` property is not identical to the Outlook IDs used by the Outlook REST API. + * Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`. + * For more details, see {@link https://docs.microsoft.com/office/dev/add-ins/outlook/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. * - * The seriesId property returns null for items that do not have parent items such as single appointments, series items, or meeting requests - * and returns undefined for any other items that are not meeting requests. + * The `seriesId` property returns `null` for items that do not have parent items such as single appointments, series items, or meeting requests + * and returns `undefined` for any other items that are not meeting requests. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ seriesId: string; /** * Gets or sets the description that appears in the subject field of an item. * - * The subject property gets or sets the entire subject of the item, as sent by the email server. + * The `subject` property gets or sets the entire subject of the item, as sent by the email server. * - * The subject property returns a Subject object that provides methods to get and set the subject. + * The `subject` property returns a `Subject` object that provides methods to get and set the subject. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ subject: Subject; /** - * Provides access to the recipients on the To line of a message. The type of object and level of access depends on the mode of the + * Provides access to the recipients on the To line of a message. The type of object and level of access depends on the mode of the * current item. * - * The to property returns a Recipients object that provides methods to get or update the recipients on the To line of the message. + * The `to` property returns a `Recipients` object that provides methods to get or update the recipients on the To line of the message. * By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, the following limits apply. * * - Get 500 members maximum. @@ -13097,18 +13123,18 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ to: Recipients; /** * Adds a file to a message or appointment as an attachment. * - * The addFileAttachmentAsync method uploads the file at the specified URI and attaches it to the item in the compose form. + * The `addFileAttachmentAsync` method uploads the file at the specified URI and attaches it to the item in the compose form. * - * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * * **Important**: In recent builds of Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to * this action (whether using this API or the Outlook UI). To work around this issue, you can try using the `addFileAttachmentFromBase64` API @@ -13118,36 +13144,36 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - AttachmentSizeExceeded: The attachment is larger than allowed. + * - `AttachmentSizeExceeded`: The attachment is larger than allowed. * - * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * - `FileTypeNotSupported`: The attachment has an extension that is not allowed. * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `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. - * 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 + * `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 - 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 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 + * @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 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 & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds a file to a message or appointment as an attachment. * - * The addFileAttachmentAsync method uploads the file at the specified URI and attaches it to the item in the compose form. + * The `addFileAttachmentAsync` method uploads the file at the specified URI and attaches it to the item in the compose form. * - * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * * **Important**: In recent builds of Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to * this action (whether using this API or the Outlook UI). To work around this issue, you can try using the `addFileAttachmentFromBase64` API @@ -13157,95 +13183,95 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - AttachmentSizeExceeded: The attachment is larger than allowed. + * - `AttachmentSizeExceeded`: The attachment is larger than allowed. * - * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * - `FileTypeNotSupported`: The attachment has an extension that is not allowed. * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `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 - 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 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 + * @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 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?: (asyncResult: 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. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * - * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. + * **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API. * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - AttachmentSizeExceeded: The attachment is larger than allowed. + * - `AttachmentSizeExceeded`: The attachment is larger than allowed. * - * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * - `FileTypeNotSupported`: The attachment has an extension that is not allowed. * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `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 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 - 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 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. + * `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 - 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 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. */ addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: 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. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * - * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. + * **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API. * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - AttachmentSizeExceeded: The attachment is larger than allowed. + * - `AttachmentSizeExceeded`: The attachment is larger than allowed. * - * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * - `FileTypeNotSupported`: The attachment has an extension that is not allowed. * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `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 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 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 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. + * @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 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. */ addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -13257,17 +13283,17 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * The type property on the parameter will match the eventType parameter passed to addHandlerAsync. + * @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. - * 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. + * `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. */ addHandlerAsync(eventType: Office.EventType | string, handler: any, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -13279,82 +13305,82 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * 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 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. */ addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. * - * The addItemAttachmentAsync method attaches the item with the specified Exchange identifier to the item in the compose form. - * If you specify a callback method, the method is called with one parameter, asyncResult, which contains either the attachment identifier or + * The `addItemAttachmentAsync` method attaches the item with the specified Exchange identifier to the item in the compose form. + * If you specify a callback method, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or * a code that indicates any error that occurred while attaching the item. You can use the options parameter to pass state information to the * callback method, if needed. * - * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * - * If your Office add-in is running in Outlook on the web, the addItemAttachmentAsync method can attach items to items other than the item that + * If your Office Add-in is running in Outlook on the web, the `addItemAttachmentAsync` method can attach items to items other than the item that * you are editing; however, this is not supported and is not recommended. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `NumberOfAttachmentsExceeded`: 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 - 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. 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 + * `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`. 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?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. * - * The addItemAttachmentAsync method attaches the item with the specified Exchange identifier to the item in the compose form. - * If you specify a callback method, the method is called with one parameter, asyncResult, which contains either the attachment identifier or - * a code that indicates any error that occurred while attaching the item. + * The `addItemAttachmentAsync` method attaches the item with the specified Exchange identifier to the item in the compose form. + * If you specify a callback method, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or + * a code that indicates any error that occurred while attaching the item. * You can use the options parameter to pass state information to the callback method, if needed. * - * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session. * - * If your Office add-in is running in Outlook on the web, the addItemAttachmentAsync method can attach items to items other than the item that + * If your Office Add-in is running in Outlook on the web, the `addItemAttachmentAsync` method can attach items to items other than the item that * you are editing; however, this is not supported and is not recommended. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * - `NumberOfAttachmentsExceeded`: 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 - 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 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 + * @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 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?: (asyncResult: Office.AsyncResult) => void): void; @@ -13366,78 +13392,78 @@ declare namespace Office { * * In the Outlook desktop client, if the message is an inline reply, the close method has no effect. * - * **Note**: In Outlook on the web, if the item is an appointment and it has previously been saved using saveAsync, the user is prompted to save, + * **Note**: In Outlook on the web, if the item is an appointment and it has previously been saved using `saveAsync`, the user is prompted to save, * discard, or cancel even if no changes have occurred since the item was last saved. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose */ close(): void; /** - * Gets an attachment from a message or appointment and returns it as an **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 - * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session. - * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to + * 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 attachment IDs were retrieved with the `getAttachmentsAsync` or + * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session. + * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to * continue in a separate window. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - AttachmentTypeNotSupported: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, + * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, * or item attachment types other than email or calendar items (such as a contact or task item). * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: 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. - * 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 - * with the reason for the failure. + * `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 + * an error code with the reason for the failure. */ getAttachmentContentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** - * Gets an attachment from a message or appointment and returns it as an **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 - * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session. - * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to + * 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 attachment IDs were retrieved with the `getAttachmentsAsync` or + * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session. + * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to * continue in a separate window. * * [Api set: Mailbox 1.8] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - AttachmentTypeNotSupported: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, + * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, * or item attachment types other than email or calendar items (such as a contact or task item). * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * * @param attachmentId - The identifier of the attachment you want to get. - * @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. + * @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 + * an error code with the reason for the failure. */ getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -13447,14 +13473,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * @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. If the call fails, the asyncResult.error property will contain and error code with the reason for + * `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`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for * the failure. */ getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; @@ -13465,69 +13491,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * - * @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 + * @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 an error code with the reason for * the failure. */ getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; - /** - * Asynchronously returns selected data from the subject or body of a message. - * - * If there is no selection but the cursor is in the body or subject, the method returns an empty string for the selected data. - * If a field other than the body or subject is selected, the method returns the InvalidSelection error. - * - * To access the selected data from the callback method, call asyncResult.value.data. - * To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject. - * - * [Api set: Mailbox 1.2] - * - * @returns - * The selected data as a string with format determined by coercionType. - * - * @remarks - * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem - * - * **{@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. - * 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. - * 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. - */ - getSelectedDataAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; - /** - * Asynchronously returns selected data from the subject or body of a message. - * - * If there is no selection but the cursor is in the body or subject, the method returns an empty string for the selected data. - * If a field other than the body or subject is selected, the method returns the InvalidSelection error. - * - * To access the selected data from the callback method, call asyncResult.value.data. - * To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject. - * - * [Api set: Mailbox 1.2] - * - * @returns - * The selected data as a string with format determined by coercionType. - * - * @remarks - * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem - * - * **{@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. - * If HTML, the method returns the selected text, whether it is plaintext or HTML. - * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. - */ - getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously gets the ID of a saved item. * @@ -13541,17 +13513,18 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * * - `ItemNotSaved`: The id can't be retrieved until the item is saved. * * @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. + * `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`. */ getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -13567,17 +13540,72 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * * - `ItemNotSaved`: The id can't be retrieved until the item is saved. * - * @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`. */ getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void): void; + /** + * Asynchronously returns selected data from the subject or body of a message. + * + * If there is no selection but the cursor is in the body or subject, the method returns an empty string for the selected data. + * If a field other than the body or subject is selected, the method returns the `InvalidSelection` error. + * + * To access the selected data from the callback method, call `asyncResult.value.data`. + * To access the source property that the selection comes from, call `asyncResult.value.sourceProperty`, which will be either `body` or `subject`. + * + * [Api set: Mailbox 1.2] + * + * @returns + * The selected data as a string with format determined by `coercionType`. + * + * @remarks + * + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` + * + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. + * 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. + * `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`. + */ + getSelectedDataAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; + /** + * Asynchronously returns selected data from the subject or body of a message. + * + * If there is no selection but the cursor is in the body or subject, the method returns an empty string for the selected data. + * If a field other than the body or subject is selected, the method returns the `InvalidSelection` error. + * + * To access the selected data from the callback method, call `asyncResult.value.data`. + * To access the source property that the selection comes from, call `asyncResult.value.sourceProperty`, which will be either `body` or `subject`. + * + * [Api set: Mailbox 1.2] + * + * @returns + * The selected data as a string with format determined by `coercionType`. + * + * @remarks + * + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` + * + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. + * If `Html`, the method returns the selected text, whether it is plaintext or HTML. + * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of + * type `Office.AsyncResult`. + */ + getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult) => void): void; /** * Gets the properties of an appointment or message in a shared folder, calendar, or mailbox. * @@ -13587,15 +13615,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * @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. - * The `value` property of the result is the properties of the shared item. + * `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`. The `value` property of the result is the properties of the shared item. */ getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -13607,42 +13634,41 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * type Office.AsyncResult. - * The `value` property of the result is the properties of the shared item. + * @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. */ getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously loads custom properties for this add-in on the selected item. * * Custom properties are stored as key/value pairs on a per-app, per-item basis. - * This method returns a CustomProperties object in the callback, which provides methods to access the custom properties specific to the + * This method returns a `CustomProperties` object in the callback, which provides methods to access the custom properties specific to the * current item and the current add-in. Custom properties are not encrypted on the item, so this should not be used as secure storage. * - * The custom properties are provided as a CustomProperties object in the asyncResult.value property. + * The custom properties are provided as a `CustomProperties` object in the asyncResult.value property. * This object can be used to get, set, and remove custom properties from the item and save changes to the custom property set back to * the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * type Office.AsyncResult. - * @param userContext - Optional. Developers can provide any object they wish to access in the callback function. - * This object can be accessed by the asyncResult.asyncContext property in the callback function. + * @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. + * This object can be accessed by the `asyncResult.asyncContext` property in the callback function. */ loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any): void; /** * Removes an attachment from a message or appointment. * - * The removeAttachmentAsync method removes the attachment with the specified identifier from the item. + * The `removeAttachmentAsync` method removes the attachment with the specified identifier from the item. * As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment * in the same session. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session. * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to @@ -13652,26 +13678,26 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: 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. - * 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. - * If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + * `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`. 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?: (asyncResult: Office.AsyncResult) => void): void; /** * Removes an attachment from a message or appointment. * - * The removeAttachmentAsync method removes the attachment with the specified identifier from the item. + * The `removeAttachmentAsync` method removes the attachment with the specified identifier from the item. * As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment * in the same session. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session. * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to @@ -13681,18 +13707,18 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: 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 Office.AsyncResult. - * If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + * @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?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -13704,15 +13730,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * @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. + * `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. */ removeHandlerAsync(eventType: Office.EventType | string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -13724,83 +13750,83 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 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 | string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. * - * When invoked, this method saves the current message as a draft and returns the item id via the callback method. - * In Outlook on the web or Outlook in online mode, the item is saved to the server. + * When invoked, this method saves the current message as a draft and returns the item ID via the callback method. + * In Outlook on the web or Outlook in online mode, the item is saved to the server. * In Outlook in cached mode, the item is saved to the local cache. * - * Since appointments have no draft state, if saveAsync is called on an appointment in compose mode, the item will be saved as a normal - * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. + * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item will be saved as a normal + * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. * Saving an existing appointment will send an update to added or removed attendees. * - * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that - * when Outlook is in cached mode, it may take some time before the item is actually synced to the server. + * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware + * that when Outlook is in cached mode, it may take some time before the item is actually synced to the server. * Until the item is synced, using the itemId will return an error. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * * @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. + * `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`. */ saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously saves an item. * - * When invoked, this method saves the current message as a draft and returns the item id via the callback method. - * In Outlook on the web or Outlook in online mode, the item is saved to the server. + * When invoked, this method saves the current message as a draft and returns the item id via the callback method. + * In Outlook on the web or Outlook in online mode, the item is saved to the server. * In Outlook in cached mode, the item is saved to the local cache. * - * Since appointments have no draft state, if saveAsync is called on an appointment in compose mode, the item will be saved as a normal - * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. + * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item will be saved as a normal + * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. * Saving an existing appointment will send an update to added or removed attendees. * - * **Note**: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that - * when Outlook is in cached mode, it may take some time before the item is actually synced to the server. - * Until the item is synced, using the itemId will return an error. + * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware + * that when Outlook is in cached mode, it may take some time before the item is actually synced to the server. + * Until the item is synced, using the `itemId` will return an error. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * - * @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`. */ saveAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * - * The setSelectedDataAsync method inserts the specified string at the cursor location in the subject or body of the item, or, if text is + * The `setSelectedDataAsync` method inserts the specified string at the cursor location in the subject or body of the item, or, if text is * selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. * After insertion, the cursor is placed at the end of the inserted content. * @@ -13808,51 +13834,51 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * * @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. + * 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. - * asyncContext: Developers can provide any object they wish to access in the callback method. - * coercionType: If text, the current style is applied in Outlook on the web and desktop clients. + * `asyncContext`: Developers can provide any object they wish to access in the callback method. + * `coercionType`: If text, the current style is applied in Outlook on the web and desktop clients. * If the field is an HTML editor, only the text data is inserted, even if the data is HTML. - * If html and the field supports HTML (the subject doesn't), the current style is applied in Outlook on the web and the default style is - * applied in Outlook on desktop clients. 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 - * type Office.AsyncResult. + * If html and the field supports HTML (the subject doesn't), the current style is applied in Outlook on the web and the default style is + * applied in Outlook on desktop clients. 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 + * type `Office.AsyncResult`. */ setSelectedDataAsync(data: string, options?: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously inserts data into the body or subject of a message. * - * The setSelectedDataAsync method inserts the specified string at the cursor location in the subject or body of the item, or, if text is - * selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. + * The `setSelectedDataAsync` method inserts the specified string at the cursor location in the subject or body of the item, or, if text is + * selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. * After insertion, the cursor is placed at the end of the inserted content. * * [Api set: Mailbox 1.2] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose * * **Errors**: * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * * @param data - The data to be inserted. Data is not to exceed 1,000,000 characters. - * If more than 1,000,000 characters are passed in, an ArgumentOutOfRange exception is thrown. - * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. + * If more than 1,000,000 characters are passed in, an `ArgumentOutOfRange` exception is thrown. + * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of + * type `Office.AsyncResult`. */ setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void): void; } @@ -13860,7 +13886,7 @@ declare namespace Office { * The message read mode of {@link Office.Item | Office.context.mailbox.item}. * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. - * You should treat this as a mode of Office.context.mailbox.item. Refer to the + * You should treat this as a mode of `Office.context.mailbox.item`. Refer to the * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.8/office.context.mailbox.item | Object Model} page for more information. * * Parent interfaces: @@ -13875,9 +13901,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read * * **Note**: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned. * For more information, see @@ -13892,9 +13918,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ body: Body; /** @@ -13906,40 +13932,40 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ categories: Categories; /** * 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. * - * The cc property returns an array that contains an EmailAddressDetails object for each recipient listed on the Cc line of the message. + * The `cc` property returns an array that contains an `EmailAddressDetails` object for each recipient listed on the Cc line of the message. * By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, you can get 500 members maximum. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ cc: EmailAddressDetails[]; /** * Gets an identifier for the email conversation that contains a particular message. * - * You can get an integer for this property if your mail app is activated in read forms or responses in compose forms. - * If subsequently the user changes the subject of the reply message, upon sending the reply, the conversation ID for that message will change + * You can get an integer for this property if your mail app is activated in read forms or responses in compose forms. + * If subsequently the user changes the subject of the reply message, upon sending the reply, the conversation ID for that message will change * and that value you obtained earlier will no longer apply. * - * You get null for this property for a new item in a compose form. - * If the user sets a subject and saves the item, the conversationId property will return a value. + * You get null for this property for a new item in a compose form. + * If the user sets a subject and saves the item, the `conversationId` property will return a value. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ conversationId: string; /** @@ -13947,9 +13973,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ dateTimeCreated: Date; /** @@ -13959,67 +13985,67 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ dateTimeModified: Date; /** * Gets the date and time that the appointment is to end. * - * The end property is a Date object expressed as a Coordinated Universal Time (UTC) date and time value. - * You can use the convertToLocalClientTime method to convert the end property value to the client's local date and time. + * The `end` property is a `Date` object expressed as a Coordinated Universal Time (UTC) date and time value. + * You can use the `convertToLocalClientTime` method to convert the `end` property value to the client's local date and time. * - * When you use the Time.setAsync method to set the end time, you should use the convertToUtcClientTime method to convert the local time on + * When you use the `Time.setAsync` method to set the end time, you should use the `convertToUtcClientTime` method to convert the local time on * the client to UTC for the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ end: Date; /** * Gets the email address of the sender of a message. * - * The from and sender properties represent the same person unless the message is sent by a delegate. - * In that case, the from property represents the delegator, and the sender property represents the delegate. + * The `from` and `sender` properties represent the same person unless the message is sent by a delegate. + * In that case, the `from` property represents the delegator, and the `sender` property represents the delegate. * - * **Note**: The recipientType property of the EmailAddressDetails object in the from property is undefined. + * **Note**: The `recipientType` property of the `EmailAddressDetails` object in the `from` property is undefined. * - * The from property returns an EmailAddressDetails object. + * The `from` property returns an `EmailAddressDetails` object. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ from: EmailAddressDetails; /** - * Gets the Internet message identifier for an email message. + * Gets the internet message identifier for an email message. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ internetMessageId: string; /** * Gets the Exchange Web Services item class of the selected item. * - * You can create custom message classes that extends a default message class, for example, a custom appointment message class - * IPM.Appointment.Contoso. + * You can create custom message classes that extends a default message class, for example, a custom appointment message class + * `IPM.Appointment.Contoso`. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read - - * The itemClass property specifies the message class of the selected item. + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * The `itemClass` property specifies the message class of the selected item. * The following are the default message classes for the message or appointment item. * *
@@ -14046,60 +14072,59 @@ declare namespace Office { * Gets the {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services item identifier} * for the current item. * - * 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. + * 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. * - * **Note**: The identifier returned by the itemId property is the same as the - * {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | 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. - * Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId. - * For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api#get-the-item-id | Use the Outlook REST APIs from an Outlook add-in}. + * **Note**: The identifier returned by the `itemId` property is the same as the + * {@link https://docs.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | 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. + * Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`. + * For more details, see {@link https://docs.microsoft.com/office/dev/add-ins/outlook/use-rest-api#get-the-item-id | Use the Outlook REST APIs from an Outlook add-in}. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ itemId: string; /** * Gets the type of item that an instance represents. * - * The itemType property returns one of the ItemType enumeration values, indicating whether the item object instance is a message or + * The `itemType` property returns one of the `ItemType` enumeration values, indicating whether the item object instance is a message or * an appointment. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ itemType: MailboxEnums.ItemType | string; /** * Gets the location of a meeting request. * - * The location property returns a string that contains the location of the appointment. + * The `location` property returns a string that contains the location of the appointment. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ location: string; /** * Gets the subject of an item, with all prefixes removed (including RE: and FWD:). * - * The normalizedSubject property gets the subject of the item, with any standard prefixes (such as RE: and FW:) that are added by - * email programs. - * To get the subject of the item with the prefixes intact, use the subject property. + * The `normalizedSubject` property gets the subject of the item, with any standard prefixes (such as RE: and FW:) that are added by + * email programs. To get the subject of the item with the prefixes intact, use the `subject` property. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ normalizedSubject: string; /** @@ -14109,110 +14134,110 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ notificationMessages: NotificationMessages; /** - * Gets the recurrence pattern of an appointment. Gets the recurrence pattern of a meeting request. + * 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. * - * The recurrence property returns a recurrence object for recurring appointments or meetings requests if an item is a series or an instance - * in a series. `null` is returned for single appointments and meeting requests of single appointments. + * The `recurrence` property returns a `Recurrence` object for recurring appointments or meetings requests if an item is a series or an instance + * in a series. `null` is returned for single appointments and meeting requests of single appointments. * `undefined` is returned for messages that are not meeting requests. * - * **Note**: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request. + * **Note**: Meeting requests have an itemClass value of `IPM.Schedule.Meeting.Request`. * - * **Note**: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single appointment + * **Note**: If the `recurrence` object is null, this indicates that the object is a single appointment or a meeting request of a single appointment * and NOT a part of a series. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ recurrence: Recurrence; /** * Gets the id of the series that an instance belongs to. * - * In Outlook on the web and desktop clients, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to. - * However, on iOS and Android, the seriesId returns the REST ID of the parent item. + * In Outlook on the web and desktop clients, the `seriesId` returns the Exchange Web Services (EWS) ID of the parent (series) item + * that this item belongs to. However, on iOS and Android, the `seriesId` returns the REST ID of the parent item. * - * **Note**: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier. - * The seriesId property is not identical to the Outlook IDs used by the Outlook REST API. - * Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId. - * For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. + * **Note**: The identifier returned by the `seriesId` property is the same as the Exchange Web Services item identifier. + * The `seriesId` property is not identical to the Outlook IDs used by the Outlook REST API. + * Before making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`. + * For more details, see {@link https://docs.microsoft.com/office/dev/add-ins/outlook/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. * - * The seriesId property returns null for items that do not have parent items such as single appointments, series items, or meeting requests - * and returns undefined for any other items that are not meeting requests. + * The `seriesId` property returns `null` for items that do not have parent items such as single appointments, series items, or meeting requests + * and returns `undefined` for any other items that are not meeting requests. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ seriesId: string; /** * Gets the email address of the sender of an email message. * - * The from and sender properties represent the same person unless the message is sent by a delegate. - * In that case, the from property represents the delegator, and the sender property represents the delegate. + * The `from` and `sender` properties represent the same person unless the message is sent by a delegate. + * In that case, the `from` property represents the delegator, and the `sender` property represents the delegate. * - * **Note**: The recipientType property of the EmailAddressDetails object in the sender property is undefined. + * **Note**: The `recipientType` property of the `EmailAddressDetails` object in the `sender` property is undefined. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ sender: EmailAddressDetails; /** * Gets the date and time that the appointment is to begin. * - * The start property is a Date object expressed as a Coordinated Universal Time (UTC) date and time value. - * You can use the convertToLocalClientTime method to convert the value to the client's local date and time. + * The `start` property is a `Date` object expressed as a Coordinated Universal Time (UTC) date and time value. + * You can use the `convertToLocalClientTime` method to convert the value to the client's local date and time. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ start: Date; /** * Gets the description that appears in the subject field of an item. * - * The subject property gets or sets the entire subject of the item, as sent by the email server. + * The `subject` property gets or sets the entire subject of the item, as sent by the email server. * - * The subject property returns a string. Use the normalizedSubject property to get the subject minus any leading prefixes such as RE: and FW:. + * The `subject` property returns a string. Use the `normalizedSubject` property to get the subject minus any leading prefixes such as RE: and FW:. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ subject: string; /** - * Provides access to the recipients on the To line of a message. The type of object and level of access depends on the mode of the + * Provides access to the recipients on the To line of a message. The type of object and level of access depends on the mode of the * current item. * - * The to property returns an array that contains an EmailAddressDetails object for each recipient listed on the To line of the message. + * The `to` property returns an array that contains an `EmailAddressDetails` object for each recipient listed on the To line of the message. * By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, you can get 500 members maximum. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ to: EmailAddressDetails[]; @@ -14225,17 +14250,17 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * The type property on the parameter will match the eventType parameter passed to addHandlerAsync. + * @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. - * 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. + * `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. */ addHandlerAsync(eventType: Office.EventType | string, handler: any, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14247,15 +14272,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * 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 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. */ addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14264,24 +14289,24 @@ declare namespace Office { * * In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2- or 1-column view. * - * If any of the string parameters exceed their limits, displayReplyAllForm throws an exception. + * If any of the string parameters exceed their limits, `displayReplyAllForm` throws an exception. * - * When attachments are specified in the formData.attachments parameter, Outlook on the web and desktop clients attempt to download all attachments and - * attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. + * When attachments are specified in the `formData.attachments` parameter, Outlook on the web and desktop clients attempt to download + * all attachments and attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. * If this isn't possible, then no error message is thrown. * * **Note**: This method is not supported in Outlook on iOS or Android. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. - * @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. */ displayReplyAllForm(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14289,24 +14314,24 @@ declare namespace Office { * * In Outlook on the web, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2- or 1-column view. * - * If any of the string parameters exceed their limits, displayReplyForm throws an exception. + * If any of the string parameters exceed their limits, `displayReplyForm` throws an exception. * - * When attachments are specified in the formData.attachments parameter, Outlook on the web and desktop clients attempt to download all attachments and - * attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. + * When attachments are specified in the `formData.attachments` parameter, Outlook on the web and desktop clients attempt to download + * all attachments and attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. * If this isn't possible, then no error message is thrown. * * **Note**: This method is not supported in Outlook on iOS or Android. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. - * @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. */ displayReplyForm(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14316,17 +14341,17 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read * * @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. - * On success, the internet headers data is provided in the asyncResult.value property as a string. - * Refer to {@link https://tools.ietf.org/html/rfc2183 | RFC 2183} for the formatting information of the returned string value. - * If the call fails, the asyncResult.error property will contain an error code with the reason for the failure. + * `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. + * On success, the internet headers data is provided in the `asyncResult.value` property as a string. + * Refer to {@link https://tools.ietf.org/html/rfc2183 | RFC 2183} for the formatting information of the returned string value. + * If the call fails, the `asyncResult.error` property will contain an error code with the reason for the failure. */ getAllInternetHeadersAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14336,19 +14361,19 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 internet headers data is provided in the asyncResult.value property as a string. * Refer to {@link https://tools.ietf.org/html/rfc2183 | RFC 2183} for the formatting information of the returned string value. - * If the call fails, the asyncResult.error property will contain an error code with the reason for the failure. + * If the call fails, the `asyncResult.error` property will contain an error code with the reason for the failure. */ getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** - * Gets an attachment from a message or appointment and returns it as an **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 @@ -14360,27 +14385,27 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read * * **Errors**: * - * - AttachmentTypeNotSupported: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, + * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, * or item attachment types other than email or calendar items (such as a contact or task item). * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: 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. - * 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 - * with the reason for the failure. + * `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 + * an error code with the reason for the failure. */ getAttachmentContentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** - * Gets an attachment from a message or appointment and returns it as an **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 @@ -14392,21 +14417,21 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read * * **Errors**: * - * - AttachmentTypeNotSupported: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, + * - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format, * or item attachment types other than email or calendar items (such as a contact or task item). * - * - InvalidAttachmentId: The attachment identifier does not exist. + * - `InvalidAttachmentId`: The attachment identifier does not exist. * - * @param attachmentId - The identifier of the attachment you want to get. - * @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. + * @param attachmentId - The identifier of the attachment you want to get. + * @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 + * an error code with the reason for the failure. */ getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14416,30 +14441,30 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ getEntities(): Entities; /** * Gets an array of all the entities of the specified entity type found in the selected item's body. * * **Note**: This method is not supported in Outlook on iOS or Android. - * - * @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. + * If the value passed in `entityType` is not a valid member of the `EntityType` enumeration, the method returns `null`. * If no entities of the specified type are present in the item's body, the method returns an empty array. - * Otherwise, the type of the objects in the returned array depends on the type of entity requested in the entityType parameter. + * Otherwise, the type of the objects in the returned array depends on the type of entity requested in the `entityType` parameter. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read + * + * @param entityType - One of the `EntityType` enumeration values. * - * While the minimum permission level to use this method is Restricted, some entity types require ReadItem to access, as specified in the + * While the minimum permission level to use this method is `Restricted`, some entity types require `ReadItem` to access, as specified in the * following table. * *
@@ -14489,59 +14514,60 @@ declare namespace Office { /** * Returns well-known entities in the selected item that pass the named filter defined in the manifest XML file. * - * The getFilteredEntitiesByName method returns the entities that match the regular expression defined in the ItemHasKnownEntity rule element - * in the manifest XML file with the specified FilterName element value. + * The `getFilteredEntitiesByName` method returns the entities that match the regular expression defined in the `ItemHasKnownEntity` rule element + * in the manifest XML file with the specified `FilterName` element value. * * **Note**: This method is not supported in Outlook on iOS or Android. + * + * @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, + * the method return an empty array. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read * - * @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, - * the method return an empty array. + * @param name - The name of the `ItemHasKnownEntity` rule element that defines the filter to match. */ getFilteredEntitiesByName(name: string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; /** * Returns string values in the selected item that match the regular expressions defined in the manifest XML file. * - * The getRegExMatches method returns the strings that match the regular expression defined in each ItemHasRegularExpressionMatch or - * ItemHasKnownEntity rule element in the manifest XML file. - * For an ItemHasRegularExpressionMatch rule, a matching string has to occur in the property of the item that is specified by that rule. - * The PropertyName simple type defines the supported properties. + * The `getRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or + * `ItemHasKnownEntity` rule element in the manifest XML file. + * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that is specified by that rule. + * The `PropertyName` simple type defines the supported properties. * - * If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body - * and should not attempt to return the entire body of the item. - * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. - * Instead, use the Body.getAsync method to retrieve the entire body. + * If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter + * the body and should not attempt to return the entire body of the item. + * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. + * Instead, use the `Body.getAsync` method to retrieve the entire body. * * **Note**: This method is not supported in Outlook on iOS or Android. * * @returns * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file. - * The name of each array is equal to the corresponding value of the RegExName attribute of the matching ItemHasRegularExpressionMatch rule - * or the FilterName attribute of the matching ItemHasKnownEntity rule. + * The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule + * or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ getRegExMatches(): any; /** * Returns string values in the selected item that match the named regular expression defined in the manifest XML file. * - * The getRegExMatchesByName method returns the strings that match the regular expression defined in the ItemHasRegularExpressionMatch rule - * element in the manifest XML file with the specified RegExName element value. + * The `getRegExMatchesByName` method returns the strings that match the regular expression defined in the + * `ItemHasRegularExpressionMatch` rule element in the manifest XML file with the specified `RegExName` element value. * - * If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body - * and should not attempt to return the entire body of the item. + * If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter + * the body and should not attempt to return the entire body of the item. * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. * * **Note**: This method is not supported in Outlook on iOS or Android. @@ -14551,11 +14577,11 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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[]; /** @@ -14567,26 +14593,26 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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; /** * Returns string values in a highlighted match that match the regular expressions defined in the manifest XML file. * Highlighted matches apply to contextual add-ins. * - * The getSelectedRegExMatches method returns the strings that match the regular expression defined in each ItemHasRegularExpressionMatch or - * ItemHasKnownEntity rule element in the manifest XML file. - * For an ItemHasRegularExpressionMatch rule, a matching string has to occur in the property of the item that is specified by that rule. - * The PropertyName simple type defines the supported properties. + * The `getSelectedRegExMatches` method returns the strings that match the regular expression defined in + * each `ItemHasRegularExpressionMatch` or `ItemHasKnownEntity` rule element in the manifest XML file. + * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that is specified by that rule. + * The `PropertyName` simple type defines the supported properties. * - * If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body - * and should not attempt to return the entire body of the item. - * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. - * Instead, use the Body.getAsync method to retrieve the entire body. + * If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body + * and should not attempt to return the entire body of the item. + * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. + * Instead, use the `Body.getAsync` method to retrieve the entire body. * * **Note**: This method is not supported in Outlook on iOS or Android. * @@ -14594,14 +14620,14 @@ declare namespace Office { * * @returns * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file. - * The name of each array is equal to the corresponding value of the RegExName attribute of the matching ItemHasRegularExpressionMatch rule or - * the FilterName attribute of the matching ItemHasKnownEntity rule. + * The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule or + * the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read */ getSelectedRegExMatches(): any; /** @@ -14613,15 +14639,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read * * @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. - * The `value` property of the result is the properties of the shared item. + * `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`. The `value` property of the result is the properties of the shared item. */ getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14633,36 +14658,34 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * type Office.AsyncResult. - * The `value` property of the result is the properties of the shared item. + * @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. */ getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously loads custom properties for this add-in on the selected item. * * Custom properties are stored as key/value pairs on a per-app, per-item basis. - * This method returns a CustomProperties object in the callback, which provides methods to access the custom properties specific to the + * This method returns a `CustomProperties` object in the callback, which provides methods to access the custom properties specific to the * current item and the current add-in. Custom properties are not encrypted on the item, so this should not be used as secure storage. * - * The custom properties are provided as a CustomProperties object in the asyncResult.value property. - * This object can be used to get, set, and remove custom properties from the item and save changes to the custom property set back to - * the server. + * The custom properties are provided as a `CustomProperties` object in the `asyncResult.value` property. + * This object can be used to get, set, and remove custom properties from the item and save changes to the custom property set back to the server. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * 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`. * @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. + * This object can be accessed by the `asyncResult.asyncContext` property in the callback function. */ loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any): void; /** @@ -14674,15 +14697,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read * * @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. + * `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. */ removeHandlerAsync(eventType: Office.EventType | string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14694,26 +14717,26 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 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 | string, callback?: (asyncResult: Office.AsyncResult) => void): void; } /** - * An array of NotificationMessageDetails objects are returned by the NotificationMessages.getAllAsync method. + * An array of `NotificationMessageDetails` objects are returned by the `NotificationMessages.getAllAsync` method. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface NotificationMessageDetails { /** @@ -14721,86 +14744,86 @@ declare namespace Office { */ key?: string; /** - * Specifies the ItemNotificationMessageType of message. If type is ProgressIndicator or ErrorMessage, an icon is automatically supplied and - * the message is not persistent. Therefore the icon and persistent properties are not valid for these types of messages. - * 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. + * Specifies the `ItemNotificationMessageType` of message. If type is `ProgressIndicator` or `ErrorMessage`, an icon is automatically supplied + * and the message is not persistent. Therefore the icon and persistent properties are not valid for these types of messages. + * 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: MailboxEnums.ItemNotificationMessageType | string; /** - * 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. + * 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. * * **Note**: At present, the custom icon is displayed in Outlook on Windows only and not on other clients (e.g., Mac, web browser). */ icon?: string; /** - * The text of the notification message. Maximum length is 150 characters. - * If the developer passes in a longer string, an ArgumentOutOfRange exception is thrown. + * The text of the notification message. Maximum length is 150 characters. + * If the developer passes in a longer string, an `ArgumentOutOfRange` exception is thrown. */ message: string; /** - * Only applicable when type is InformationalMessage. If true, the message remains until removed by this add-in or dismissed by the user. - * If false, it is removed when the user navigates to a different item. - * For error notifications, the message persists until the user sees it once. + * Only applicable when type is `InformationalMessage`. If true, the message remains until removed by this add-in or dismissed by the user. + * If false, it is removed when the user navigates to a different item. + * For error notifications, the message persists until the user sees it once. * Specifying this parameter for an unsupported type throws an exception. */ persistent?: Boolean; } /** - * The NotificationMessages object is returned as the notificationMessages property of an item. + * The `NotificationMessages` object is returned as the `notificationMessages` property of an item. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface NotificationMessages { /** * 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. It can't be longer than 32 characters. - * @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. - * 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. + * There are a maximum of 5 notifications per message. Setting more will return a `NumberOfNotificationMessagesExceeded` error. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * @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. + * It contains a `NotificationMessageDetails` 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 + * of type `Office.AsyncResult`. */ addAsync(key: string, JSONmessage: NotificationMessageDetails, options?: Office.AsyncContextOptions, callback?: (asyncResult: 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. - * It can't be longer than 32 characters. - * @param JSONmessage - A JSON object that contains the notification message to be added to the item. - * It contains a NotificationMessageDetails object. - * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. + * There are a maximum of 5 notifications per message. Setting more will return a `NumberOfNotificationMessagesExceeded` error. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * @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. + * It contains a `NotificationMessageDetails` object. + * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter + * of type `Office.AsyncResult`. */ addAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14810,14 +14833,14 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * @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. - * The `value` property of the result is an array of NotificationMessageDetails objects. + * `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`. The `value` property of the result is an array of `NotificationMessageDetails` objects. */ getAllAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14827,12 +14850,12 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * The `value` property of the result is an array of NotificationMessageDetails objects. + * @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?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14842,15 +14865,15 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * 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. + * `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`. */ removeAsync(key: string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14860,55 +14883,55 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 - * 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`. */ removeAsync(key: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Replaces a notification message that has a given key with another message. * - * If a notification message with the specified key doesn't exist, replaceAsync will add the notification. + * If a notification message with the specified key doesn't exist, `replaceAsync` will add the notification. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * It contains a NotificationMessageDetails object. + * It contains a `NotificationMessageDetails` 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 of - * type Office.AsyncResult. + * `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`. */ replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Replaces a notification message that has a given key with another message. * - * If a notification message with the specified key doesn't exist, replaceAsync will add the notification. + * If a notification message with the specified key doesn't exist, `replaceAsync` will add the notification. * * [Api set: Mailbox 1.3] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * It contains a NotificationMessageDetails object. - * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of - * type Office.AsyncResult. + * It contains a `NotificationMessageDetails` object. + * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter + * of type `Office.AsyncResult`. */ replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult) => void): void; } @@ -14920,26 +14943,28 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose */ interface Organizer { /** - * Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails | EmailAddressDetails} object in the asyncResult.value property. + * Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails | EmailAddressDetails} object + * in the `asyncResult.value` property. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. - * The `value` property of the result is the appointment's organizer value, as an EmailAddressDetails object. + * `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. The `value` property of the result is the appointment's organizer value, + * as an `EmailAddressDetails` object. */ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14949,30 +14974,32 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 AsyncResult object. - * The `value` property of the result is the appointment's organizer value, as an EmailAddressDetails 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 the appointment's organizer value, + * as an `EmailAddressDetails` object. */ getAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; } /** * Represents a phone number identified in an item. Read mode only. * - * An array of PhoneNumber objects containing the phone numbers found in an email message is returned in the phoneNumbers property of the - * Entities object that is returned when you call the getEntities method on the selected item. + * An array of `PhoneNumber` objects containing the phone numbers found in an email message is returned in the `phoneNumbers` property of the + * `Entities` object that is returned when you call the `getEntities` method on the selected item. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read */ interface PhoneNumber { /** - * Gets a string containing a phone number. This string contains only the digits of the telephone number and excludes characters like parentheses and hyphens, if they exist in the original item. + * Gets a string containing a phone number. This string contains only the digits of the telephone number and excludes characters + * like parentheses and hyphens, if they exist in the original item. */ phoneString: string; /** @@ -14985,13 +15012,15 @@ declare namespace Office { type: string; } /** + * Represents recipients of an item. Compose mode only. + * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose */ interface Recipients { /** @@ -15001,27 +15030,27 @@ declare namespace Office { * * - Strings containing SMTP email addresses * - * - EmailUser objects + * - {@link Office.EmailUser | EmailUser} objects * - * - EmailAddressDetails objects + * - {@link Office.EmailAddressDetails | EmailAddressDetails} objects * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - NumberOfRecipientsExceeded: The number of recipients exceeded 100 entries. + * - `NumberOfRecipientsExceeded`: 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. - * 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. If adding the recipients fails, the asyncResult.error property will contain an error code. + * `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`. If adding the recipients fails, the `asyncResult.error` property will contain an error code. */ addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -15039,61 +15068,61 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - NumberOfRecipientsExceeded: The number of recipients exceeded 100 entries. + * - `NumberOfRecipientsExceeded`: 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 - * type Office.AsyncResult. If adding the recipients fails, the asyncResult.error property will contain an error code. + * @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?: (asyncResult: Office.AsyncResult) => void): void; /** * Gets a recipient list for an appointment or message. * - * When the call completes, the asyncResult.value property will contain an array of {@link Office.EmailAddressDetails | EmailAddressDetails} objects. + * When the call completes, the `asyncResult.value` property will contain + * an array of {@link Office.EmailAddressDetails | EmailAddressDetails} objects. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. - * The `value` property of the result is an array of EmailAddressDetails objects. + * `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`. The `value` property of the result is an array of `EmailAddressDetails` objects. */ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** * Gets a recipient list for an appointment or message. * - * When the call completes, the asyncResult.value property will contain an array of {@link Office.EmailAddressDetails | EmailAddressDetails} objects. + * When the call completes, the `asyncResult.value` property will contain + * an array of {@link Office.EmailAddressDetails | EmailAddressDetails} objects. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 Office.AsyncResult. - * The `value` property of the result is an array of EmailAddressDetails objects. + * @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: (asyncResult: Office.AsyncResult) => void): void; /** * Sets a recipient list for an appointment or message. * - * The setAsync method overwrites the current recipient list. + * The `setAsync` method overwrites the current recipient list. * * The recipients parameter can be an array of one of the following: * @@ -15107,27 +15136,26 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - NumberOfRecipientsExceeded: The number of recipients exceeded 100 entries. + * - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries. * * @param recipients - The recipients to add to the recipients list. * @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. - * If setting the recipients fails the asyncResult.error property will contain a code that indicates any error that occurred - * while adding the data. + * `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`. 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: (asyncResult: Office.AsyncResult) => void): void; /** * Sets a recipient list for an appointment or message. * - * The setAsync method overwrites the current recipient list. + * The `setAsync` method overwrites the current recipient list. * * The recipients parameter can be an array of one of the following: * @@ -15141,19 +15169,18 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - NumberOfRecipientsExceeded: The number of recipients exceeded 100 entries. + * - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries. * * @param recipients - The recipients to add to the recipients list. - * @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 recipients fails the asyncResult.error property will contain a code that indicates any error that occurred - * while adding the data. + * @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 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: (asyncResult: Office.AsyncResult) => void): void; } @@ -15220,17 +15247,17 @@ declare namespace Office { to: boolean; } /** - * The recurrence object provides methods to get and set the recurrence pattern of appointments but only get the recurrence pattern of + * The `Recurrence` object provides methods to get and set the recurrence pattern of appointments but only get the recurrence pattern of * meeting requests. - * It will have a dictionary with the following keys: seriesTime, recurrenceType, recurrenceProperties, and recurrenceTimeZone (optional). + * It will have a dictionary with the following keys: `seriesTime`, `recurrenceType`, `recurrenceProperties`, and `recurrenceTimeZone` (optional). * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * **States** * @@ -15280,9 +15307,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ recurrenceProperties: RecurrenceProperties; /** @@ -15292,9 +15319,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ recurrenceTimeZone: RecurrenceTimeZone; /** @@ -15304,108 +15331,106 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ recurrenceType: MailboxEnums.RecurrenceType | string; /** - * The {@link Office.SeriesTime | SeriesTime} object enables you to manage the start and end dates of the recurring appointment series and the usual start - * and end times of instances. **This object is not in UTC time.** - * Instead, it is set in the time zone specified by the recurrenceTimeZone value or defaulted to the item's time zone. + * The {@link Office.SeriesTime | SeriesTime} object enables you to manage the start and end dates of the recurring appointment series and + * the usual start and end times of instances. **This object is not in UTC time.** + * Instead, it is set in the time zone specified by the `recurrenceTimeZone` value or defaulted to the item's time zone. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ seriesTime: SeriesTime; /** * Returns the current recurrence object of an appointment series. * - * This method returns the entire recurrence object for the appointment series. + * This method returns the entire `Recurrence` object for the appointment series. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * @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. - * The `value` property of the result is a Recurrence object. + * `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. The `value` property of the result is a `Recurrence` object. */ getAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Returns the current recurrence object of an appointment series. * - * This method returns the entire recurrence object for the appointment series. + * This method returns the entire `Recurrence` object for the appointment series. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. - * The `value` property of the result is 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. The `value` property of the result is a `Recurrence` object. */ getAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Sets the recurrence pattern of an appointment series. * - * **Note**: setAsync should only be available for series items and not instance items. + * **Note**: `setAsync` should only be available for series items and not instance items. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - InvalidEndTime: The appointment end time is before its start time. + * - `InvalidEndTime`: The appointment end time is before its start time. * * @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. + * `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. */ setAsync(recurrencePattern: Recurrence, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Sets the recurrence pattern of an appointment series. * - * **Note**: setAsync should only be available for series items and not instance items. + * **Note**: `setAsync` should only be available for series items and not instance items. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - InvalidEndTime: The appointment end time is before its start time. + * - `InvalidEndTime`: 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 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?: (asyncResult: Office.AsyncResult) => void): void; } @@ -15435,9 +15460,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface RecurrenceProperties { /** @@ -15477,9 +15502,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface RecurrenceTimeZone { /** @@ -15537,7 +15562,7 @@ declare namespace Office { callback?: (asyncResult: Office.AsyncResult) => void; } /** - * The settings created by using the methods of the RoamingSettings object are saved per add-in and per user. + * The settings created by using the methods of the `RoamingSettings` object are saved per add-in and per user. * That is, they are available only to the add-in that created them, and only from the user's mail box in which they are saved. * * While the Outlook Add-in API limits access to these settings to only the add-in that created them, these settings should not be considered @@ -15546,9 +15571,9 @@ declare namespace Office { * * The name of a setting is a String, while the value can be a String, Number, Boolean, null, Object, or Array. * - * The RoamingSettings object is accessible via the roamingSettings property in the Office.context namespace. + * The `RoamingSettings` object is accessible via the `roamingSettings` property in the `Office.context` namespace. * - * **Important**: The RoamingSettings object is initialized from the persisted storage only when the add-in is first loaded. + * **Important**: The `RoamingSettings` object is initialized from the persisted storage only when the add-in is first loaded. * For task panes, this means that it is only initialized when the task pane first opens. * If the task pane navigates to another page or reloads the current page, the in-memory object is reset to its initial values, even if * your add-in has persisted changes. @@ -15556,22 +15581,23 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ export interface RoamingSettings { /** * Retrieves the specified setting. * + * @returns Type: String | Number | Boolean | Object | Array + * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * @param name - The case-sensitive name of the setting to retrieve. - * @returns Type: String | Number | Boolean | Object | Array */ get(name: string): any; /** @@ -15579,9 +15605,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * @param name - The case-sensitive name of the setting to remove. */ @@ -15595,29 +15621,29 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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`. */ saveAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Sets or creates the specified setting. * - * The set method creates a new setting of the specified name if it does not already exist, or sets an existing setting of the specified name. + * The `set` method creates a new setting of the specified name if it does not already exist, or sets an existing setting of the specified name. * The value is stored in the document as the serialized JSON representation of its data type. * * A maximum of 32KB is available for the settings of each add-in. * - * Any changes made to settings using the set function will not be saved to the server until the saveAsync function is called. + * Any changes made to settings using the set function will not be saved to the server until the `saveAsync` function is called. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: Restricted + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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. @@ -15625,16 +15651,16 @@ declare namespace Office { set(name: string, value: any): void; } /** - * The SeriesTime object provides methods to get and set the dates and times of appointments in a recurring series and get the dates and times of - * meeting requests in a recurring series. + * The `SeriesTime` object provides methods to get and set the dates and times of appointments in a recurring series and get the dates and times + * of meeting requests in a recurring series. * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface SeriesTime { /** @@ -15644,60 +15670,62 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ getDuration(): number; /** - * Gets the end date of a recurrence pattern in the following {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD" + * Gets the end date of a recurrence pattern in the following + * {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD". * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ getEndDate(): string; /** * Gets the end time of a usual appointment or meeting request instance of a recurrence pattern in whichever time zone that the user or * add-in set the recurrence pattern using the following {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} format: - * "THH:mm:ss:mmm" + * "THH:mm:ss:mmm". * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ getEndTime(): string; /** - * Gets the start date of a recurrence pattern in the following {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD" + * Gets the start date of a recurrence pattern in the following + * {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD". * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ getStartDate(): string; /** - * Gets the start time of a usual appointment instance of a recurrence pattern in whichever time zone that the user/add-in set the - * recurrence pattern using the following {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} format: "THH:mm:ss:mmm" + * Gets the start time of a usual appointment instance of a recurrence pattern in whichever time zone that the user/add-in set the + * recurrence pattern using the following {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} format: "THH:mm:ss:mmm". * * [Api set: Mailbox 1.7] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ getStartTime(): string; /** @@ -15707,9 +15735,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param minutes - The length of the appointment in minutes. */ @@ -15721,9 +15749,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. @@ -15737,11 +15765,12 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * - * @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; /** @@ -15751,9 +15780,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. @@ -15767,11 +15796,12 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * - * @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; /** @@ -15782,9 +15812,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. @@ -15798,9 +15828,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @param time - Start time of all instances represented by standard datetime string format: "THH:mm:ss:mmm". */ @@ -15813,9 +15843,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface SharedProperties { /** @@ -15824,13 +15854,13 @@ declare namespace Office { owner: string; /** * The REST API's base URL (currently https://outlook.office.com/api). - * Use with targetMailbox to construct REST operation's URL. + * Use with `targetMailbox` to construct REST operation's URL. * * Example usage: `targetRestUrl + "/{api_version}/users/" + targetMailbox + "/{REST_operation}"` */ targetRestUrl: string; /** - * The target/owner's mailbox. Use with targetRestUrl to construct REST operation's URL. + * The target/owner's mailbox. Use with `targetRestUrl` to construct REST operation's URL. * * Example usage: `targetRestUrl + "/{api_version}/users/" + targetMailbox + "/{REST_operation}"` */ @@ -15847,29 +15877,28 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose */ interface Subject { /** * Gets the subject of an appointment or message. * - * The getAsync method starts an asynchronous call to the Exchange server to get the subject of an appointment or message. + * The `getAsync` method starts an asynchronous call to the Exchange server to get the subject of an appointment or message. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. - * The `value` property of the result is the subject of the item. + * `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`. The `value` property of the result is the subject of the item. */ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -15881,74 +15910,74 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 Office.AsyncResult. - * The `value` property of the result is the subject of the item. + * @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: (asyncResult: Office.AsyncResult) => void): void; /** * Sets the subject of an appointment or message. * - * The setAsync method starts an asynchronous call to the Exchange server to set the subject of an appointment or message. + * The `setAsync` method starts an asynchronous call to the Exchange server to set the subject of an appointment or message. * Setting the subject overwrites the current subject, but leaves any prefixes, such as "Fwd:" or "Re:" in place. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - DataExceedsMaximumSize: The subject parameter is longer than 255 characters. + * - `DataExceedsMaximumSize`: 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 - 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. If setting the subject fails, the asyncResult.error property will contain an error code. + * `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`. If setting the subject fails, the `asyncResult.error` property will contain an error code. */ setAsync(subject: string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Sets the subject of an appointment or message. * - * The setAsync method starts an asynchronous call to the Exchange server to set the subject of an appointment or message. + * The `setAsync` method starts an asynchronous call to the Exchange server to set the subject of an appointment or message. * Setting the subject overwrites the current subject, but leaves any prefixes, such as "Fwd:" or "Re:" in place. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - DataExceedsMaximumSize: The subject parameter is longer than 255 characters. + * - `DataExceedsMaximumSize`: 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 - 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 subject fails, the asyncResult.error property will contain an error code. + * @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 subject fails, the `asyncResult.error` property will contain an error code. */ setAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void): void; } /** * Represents a suggested task identified in an item. Read mode only. * - * The list of tasks suggested in an email message is returned in the taskSuggestions property of the {@link Office.Entities | Entities} object - * that is returned when the getEntities or getEntitiesByType method is called on the active item. + * The list of tasks suggested in an email message is returned in the `taskSuggestions` property of the {@link Office.Entities | Entities} object + * that is returned when the `getEntities` or `getEntitiesByType` method is called on the active item. * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read */ interface TaskSuggestion { /** @@ -15961,107 +15990,105 @@ declare namespace Office { taskString: string; } /** - * The Time object is returned as the start or end property of an appointment in compose mode. + * The `Time` object is returned as the start or end property of an appointment in compose mode. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose */ interface Time { /** * Gets the start or end time of an appointment. * - * The date and time is provided as a Date object in the asyncResult.value property. The value is in Coordinated Universal Time (UTC). - * You can convert the UTC time to the local client time by using the convertToLocalClientTime method. + * The date and time is provided as a `Date` object in the `asyncResult.value` property. The value is in Coordinated Universal Time (UTC). + * You can convert the UTC time to the local client time by using the `convertToLocalClientTime` method. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * @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. - * The `value` property of the result is a Date object. + * `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`. The `value` property of the result is a `Date` object. */ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** * Gets the start or end time of an appointment. * - * The date and time is provided as a Date object in the asyncResult.value property. The value is in Coordinated Universal Time (UTC). - * You can convert the UTC time to the local client time by using the convertToLocalClientTime method. + * The date and time is provided as a `Date` object in the `asyncResult.value` property. The value is in Coordinated Universal Time (UTC). + * You can convert the UTC time to the local client time by using the `convertToLocalClientTime` method. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 Office.AsyncResult. - * The `value` property of the result is a Date object. + * @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: (asyncResult: Office.AsyncResult) => void): void; /** * Sets the start or end time of an appointment. * - * If the setAsync method is called on the start property, the end property will be adjusted to maintain the duration of the appointment as - * previously set. If the setAsync method is called on the end property, the duration of the appointment will be extended to the new end time. + * If the `setAsync` method is called on the start property, the `end` property will be adjusted to maintain the duration of the appointment as + * previously set. If the `setAsync` method is called on the `end` property, the duration of the appointment will be extended to the new end time. * - * The time must be in UTC; you can get the correct UTC time by using the convertToUtcClientTime method. + * The time must be in UTC; you can get the correct UTC time by using the `convertToUtcClientTime` method. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - InvalidEndTime: The appointment end time is before the appointment start time. + * - `InvalidEndTime`: The appointment end time is before the appointment start time. * * @param dateTime - A date-time object in Coordinated Universal Time (UTC). * @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. - * If setting the date and time fails, the asyncResult.error property will contain an error code. + * `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`. If setting the date and time fails, the `asyncResult.error` property will contain an error code. */ setAsync(dateTime: Date, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Sets the start or end time of an appointment. * - * If the setAsync method is called on the start property, the end property will be adjusted to maintain the duration of the appointment as - * previously set. If the setAsync method is called on the end property, the duration of the appointment will be extended to the new end time. + * If the `setAsync` method is called on the start property, the `end` property will be adjusted to maintain the duration of the appointment as + * previously set. If the `setAsync` method is called on the `end` property, the duration of the appointment will be extended to the new end time. * - * The time must be in UTC; you can get the correct UTC time by using the convertToUtcClientTime method. + * The time must be in UTC; you can get the correct UTC time by using the `convertToUtcClientTime` method. * * [Api set: Mailbox 1.1] * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * * **Errors**: * - * - InvalidEndTime: The appointment end time is before the appointment start time. + * - `InvalidEndTime`: The appointment end time is before the appointment start time. * * @param dateTime - A date-time object in Coordinated Universal Time (UTC). - * @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 date and time fails, the asyncResult.error property will contain an error code. + * @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 date and time fails, the `asyncResult.error` property will contain an error code. */ setAsync(dateTime: Date, callback?: (asyncResult: Office.AsyncResult) => void): void; } @@ -16070,9 +16097,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ interface UserProfile { /** @@ -16084,9 +16111,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * * The possible account types are listed in the following table. * @@ -16119,9 +16146,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ displayName: string; /** @@ -16129,9 +16156,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ emailAddress: string; /** @@ -16139,9 +16166,9 @@ declare namespace Office { * * @remarks * - * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem` * - * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read */ timeZone: string; }