diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 96da063a76..ca3f7b413d 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -1478,7 +1478,7 @@ declare namespace Office { * * * - * + * * * *
Office for Windows desktop
Excel Y
Outlook Y
Outlook Y (in preview)
PowerPoint Y
Word Y
@@ -1817,11 +1817,9 @@ declare namespace Office { */ ActiveViewChanged, /** - * Triggers when the appointment date or time of the selected series is changed in Outlook. + * Triggers when any date or time of the selected appointment or series is changed in Outlook. * - * [Api set: Mailbox Preview] - * - * @beta + * [Api set: Mailbox 1.7] */ AppointmentTimeChanged, /** @@ -1920,26 +1918,20 @@ declare namespace Office { * Triggers when the OfficeTheme is changed in Outlook. * * [Api set: Mailbox Preview] - * - * @beta */ OfficeThemeChanged, /** - * Triggers when the recipient list of the selected item is changed in Outlook. + * Triggers when the recipient list of the selected item or the appointment location is changed in Outlook. * - * [Api set: Mailbox Preview] - * - * @beta + * [Api set: Mailbox 1.7] */ RecipientsChanged, /** * Triggers when the recurrence pattern of the selected series is changed in Outlook. * - * [Api set: Mailbox Preview] - * - * @beta + * [Api set: Mailbox 1.7] */ - RecurrencePatternChanged, + RecurrenceChanged, /** * Triggers when a Resource selection happens in Project. */ @@ -7374,14 +7366,12 @@ declare namespace Office { /** * Specifies the day of week or type of day. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks *
* {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} * Compose or read
- * - * @beta */ enum Days { /** @@ -7425,6 +7415,44 @@ declare namespace Office { */ Day = "day" } + /** + * This bit mask represents a delegate's permissions on a shared folder. + * + * [Api set: Mailbox Preview] + * + * @remarks + *
+ * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} + * Compose or read
+ * + * @beta + */ + enum DelegatePermissions { + /** + * Delegate has permission to read items. + */ + Read = 1, + /** + * Delegate has permission to create and write items. + */ + Write = 2, + /** + * Delegate has permission to delete only the items they created. + */ + DeleteOwn = 4, + /** + * Delegate has permission to delete any items. + */ + DeleteAll = 8, + /** + * Delegate has permission to edit only they items they created. + */ + EditOwn = 16, + /** + * Delegate has permission to edit any items. + */ + EditAll = 32 + } /** * Specifies an entity's type. * @@ -7512,14 +7540,12 @@ declare namespace Office { /** * Specifies the month. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks *
* {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} * Compose or read
- * - * @beta */ enum Month { /** @@ -7620,14 +7646,12 @@ declare namespace Office { /** * Specifies the time zone applied to the recurrence. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks *
* {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} * Compose or read
- * - * @beta */ enum RecurrenceTimeZone { /** @@ -8180,14 +8204,12 @@ declare namespace Office { /** * Specifies the type of recurrence. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks *
* {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} * Compose or read
- * - * @beta */ enum RecurrenceType { /** @@ -8270,14 +8292,12 @@ declare namespace Office { /** * Specifies the week of the month. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks *
* {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} * Compose or read
- * - * @beta */ enum WeekNumber { /** @@ -8539,7 +8559,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * In addition to the main signature, this method also has this signature: + * In addition to this signature, this method also has the following signature: * * `getAsync(coerciontype: Office.CoercionType, callback: (result: AsyncResult) => void): void;` * @@ -8606,7 +8626,7 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters. * - * In addition to the main signature, this method also has these signatures: + * In addition to this signature, this method also has the following signatures: * * `prependAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions): void;` * @@ -8705,7 +8725,7 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters.InvalidFormatError - The options.coercionType parameter is set to Office.CoercionType.Html and the message body is in plain text. * - * In addition to the main signature, this method also has these signatures: + * In addition to this signature, this method also has the following signatures: * * `setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions): void;` * @@ -8812,7 +8832,7 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters.InvalidFormatError - The options.coercionType parameter is set to Office.CoercionType.Html and the message body is in plain text. * - * In addition to the main signature, this method also has these signatures: + * In addition to this signature, this method also has the following signatures: * * `setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions): void;` * @@ -9205,14 +9225,12 @@ declare namespace Office { /** * Provides a method to get the from value of a message in an Outlook add-in. * - * [Api set: Mailbox Preview] + * [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/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose
- * - * @beta */ export interface From { /** @@ -9222,7 +9240,7 @@ declare namespace Office { * * The from value of the item is provided as an {@link Office.EmailAddressDetails} in the asyncResult.value property. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -9246,7 +9264,7 @@ declare namespace Office { * * The from value of the item is provided as an {@link Office.EmailAddressDetails} in the asyncResult.value property. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -9264,20 +9282,18 @@ declare namespace Office { * Represents the appointment organizer, even if an alias or a delegate was used to create the appointment. * This object provides a method to get the organizer value of an appointment in an Outlook add-in. * - * [Api set: Mailbox Preview] + * [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/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
- * - * @beta */ export interface Organizer { /** * Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails} in the asyncResult.value property. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -9421,15 +9437,13 @@ declare namespace Office { * * The organizer property returns an {@link Office.Organizer | Organizer} object that provides a method to get the organizer value. * - * [Api set: Mailbox Preview] + * [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/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}Appointment Organizer
- * - * @beta */ organizer: Office.Organizer; /** @@ -9443,15 +9457,13 @@ declare namespace Office { * 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 Preview] + * [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/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer
- * - * @beta */ recurrence: Recurrence; /** @@ -9482,15 +9494,13 @@ declare namespace Office { * 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 Preview] + * [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/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Organizer
- * - * @beta */ seriesId: string; /** @@ -9651,14 +9661,16 @@ declare namespace Office { * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type asyncResult. * On success, the attachment identifier will be provided in the asyncResult.value property. * If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. + * + * @beta */ addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** * Adds an event handler for a supported event. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and `Office.EventType.RecurrencePatternChanged`. + * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -9677,17 +9689,15 @@ declare namespace Office { * asyncContext: Developers can provide any object they wish to access 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. - * - * @beta */ addHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; /** * Adds an event handler for a supported event. * * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrencePatternChanged`. + * `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -9700,8 +9710,6 @@ declare namespace Office { * 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. - * - * @beta */ addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; /** @@ -9726,7 +9734,7 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * In addition to the main signature, this method also has these signatures: + * In addition to this signature, this method also has the following signatures: * * `addItemAttachmentAsync(itemId: any, attachmentName: string): void;` * @@ -10058,9 +10066,9 @@ declare namespace Office { * Removes an event handler for a supported event. * * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrencePatternChanged`. + * `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -10079,16 +10087,14 @@ declare namespace Office { * asyncContext: Developers can provide any object they wish to access 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. - * - * @beta */ removeHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; /** * Removes an event handler for a supported event. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and `Office.EventType.RecurrencePatternChanged`. + * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -10101,8 +10107,6 @@ declare namespace Office { * The type property on the parameter will match the eventType parameter passed to removeHandlerAsync. * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. - * - * @beta */ removeHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; /** @@ -10594,15 +10598,13 @@ declare namespace Office { * 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 Preview] + * [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/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee
- * - * @beta */ recurrence: Recurrence; /** @@ -10649,15 +10651,13 @@ declare namespace Office { * 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 Preview] + * [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/outlook/add-ins/#extension-points | Applicable Outlook mode}Appointment Attendee
- * - * @beta */ seriesId: string; /** @@ -10681,9 +10681,9 @@ declare namespace Office { * Adds an event handler for a supported event. * * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrencePatternChanged`. + * `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -10702,8 +10702,6 @@ declare namespace Office { * asyncContext: Developers can provide any object they wish to access 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. - * - * @beta */ addHandlerAsync(eventType: Office.EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; @@ -10711,9 +10709,9 @@ declare namespace Office { * Adds an event handler for a supported event. * * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrencePatternChanged`. + * `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -10726,8 +10724,6 @@ declare namespace Office { * 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. - * - * @beta */ addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; /** @@ -11066,9 +11062,9 @@ declare namespace Office { * Removes an event handler for a supported event. * * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrencePatternChanged`. + * `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -11087,17 +11083,15 @@ declare namespace Office { * asyncContext: Developers can provide any object they wish to access 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. - * - * @beta */ removeHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; /** * Removes an event handler for a supported event. * * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrencePatternChanged`. + * `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -11110,8 +11104,6 @@ declare namespace Office { * The type property on the parameter will match the eventType parameter passed to removeHandlerAsync. * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. - * - * @beta */ removeHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; } @@ -11207,15 +11199,13 @@ declare namespace Office { * 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 Preview] + * [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/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read
- * - * @beta */ recurrence: Office.Recurrence; @@ -11233,24 +11223,22 @@ declare namespace Office { * 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 Preview] + * [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/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read
- * - * @beta */ seriesId: string; /** * Adds an event handler for a supported event. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and `Office.EventType.RecurrencePatternChanged`. + * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -11269,17 +11257,15 @@ declare namespace Office { * asyncContext: Developers can provide any object they wish to access 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. - * - * @beta */ addHandlerAsync(eventType: Office.EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; /** * Adds an event handler for a supported event. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and `Office.EventType.RecurrencePatternChanged`. + * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -11292,8 +11278,6 @@ declare namespace Office { * 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. - * - * @beta */ addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: AsyncResult) => void): void; @@ -11327,6 +11311,48 @@ declare namespace Office { */ getInitializationContextAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + /** + * Gets the properties of an appointment or message in a shared folder, calendar, or mailbox. + * + * [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/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read
+ * + * In addition to this signature, this method also has the following signature: + * + * `getAsync(callback: (result: AsyncResult) => void): void;` + * + * @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. + * + * @beta + */ + getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (result: AsyncResult) => void): void; + + /** + * Gets the properties of an appointment or message in a shared folder, calendar, or mailbox. + * + * [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/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read
+ * + * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. + * The `value` property of the result is the properties of the shared item. + * + * @beta + */ + getSharedPropertiesAsync(callback: (result: AsyncResult) => void): void; + /** * Asynchronously loads custom properties for this add-in on the selected item. * @@ -11357,9 +11383,9 @@ declare namespace Office { * Removes an event handler for a supported event. * * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrencePatternChanged`. + * `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -11378,8 +11404,6 @@ declare namespace Office { * asyncContext: Developers can provide any object they wish to access 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. - * - * @beta */ removeHandlerAsync(eventType: Office.EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; @@ -11387,9 +11411,9 @@ declare namespace Office { * Removes an event handler for a supported event. * * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrencePatternChanged`. + * `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -11402,8 +11426,6 @@ declare namespace Office { * The type property on the parameter will match the eventType parameter passed to removeHandlerAsync. * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. - * - * @beta */ removeHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: AsyncResult) => void): void; } @@ -11559,6 +11581,8 @@ declare namespace Office { * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type asyncResult. * On success, the attachment identifier will be provided in the asyncResult.value property. * If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. + * + * @beta */ addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; @@ -11584,7 +11608,7 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * In addition to the main signature, this method also has these signatures: + * In addition to this signature, this method also has the following signatures: * * `addItemAttachmentAsync(itemId: any, attachmentName: string): void;` * @@ -12702,19 +12726,17 @@ declare namespace Office { * 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. + * 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. * - * [Api set: Mailbox Preview] + * [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/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose
- * - * @beta */ from: Office.From; /** @@ -12757,15 +12779,13 @@ declare namespace Office { * 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 Preview] + * [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/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose
- * - * @beta */ recurrence: Recurrence; /** @@ -12782,15 +12802,13 @@ declare namespace Office { * 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 Preview] + * [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/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Compose
- * - * @beta */ seriesId: string; /** @@ -12952,14 +12970,16 @@ declare namespace Office { * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type asyncResult. * On success, the attachment identifier will be provided in the asyncResult.value property. * If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. + * + * @beta */ addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** * Adds an event handler for a supported event. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and `Office.EventType.RecurrencePatternChanged`. + * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -12978,17 +12998,15 @@ declare namespace Office { * asyncContext: Developers can provide any object they wish to access 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. - * - * @beta */ addHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; /** * Adds an event handler for a supported event. * * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrencePatternChanged`. + * `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -13001,8 +13019,6 @@ declare namespace Office { * 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. - * - * @beta */ addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; /** @@ -13027,7 +13043,7 @@ declare namespace Office { * * ErrorsNumberOfAttachmentsExceeded - The message or appointment has too many attachments. * - * In addition to the main signature, this method also has these signatures: + * In addition to this signature, this method also has the following signatures: * * `addItemAttachmentAsync(itemId: any, attachmentName: string): void;` * @@ -13365,9 +13381,9 @@ declare namespace Office { * Removes an event handler for a supported event. * * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrencePatternChanged`. + * `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -13386,17 +13402,15 @@ declare namespace Office { * asyncContext: Developers can provide any object they wish to access 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. - * - * @beta */ removeHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; /** * Removes an event handler for a supported event. * * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrencePatternChanged`. + * `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -13409,8 +13423,6 @@ declare namespace Office { * The type property on the parameter will match the eventType parameter passed to removeHandlerAsync. * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. - * - * @beta */ removeHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; /** @@ -13915,15 +13927,13 @@ declare namespace Office { * 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 Preview] + * [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/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read
- * - * @beta */ recurrence: Recurrence; /** @@ -13940,15 +13950,13 @@ declare namespace Office { * 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 Preview] + * [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/outlook/add-ins/#extension-points | Applicable Outlook mode}Message Read
- * - * @beta */ seriesId: string; /** @@ -14005,9 +14013,9 @@ declare namespace Office { * Adds an event handler for a supported event. * * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrencePatternChanged`. + * `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -14026,8 +14034,6 @@ declare namespace Office { * asyncContext: Developers can provide any object they wish to access 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. - * - * @beta */ addHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; @@ -14035,9 +14041,9 @@ declare namespace Office { * Adds an event handler for a supported event. * * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrencePatternChanged`. + * `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -14050,8 +14056,6 @@ declare namespace Office { * 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. - * - * @beta */ addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; /** @@ -14394,9 +14398,9 @@ declare namespace Office { * Removes an event handler for a supported event. * * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrencePatternChanged`. + * `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -14415,17 +14419,15 @@ declare namespace Office { * asyncContext: Developers can provide any object they wish to access 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. - * - * @beta */ removeHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; /** * Removes an event handler for a supported event. * * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrencePatternChanged`. + * `Office.EventType.RecurrenceChanged`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -14438,8 +14440,6 @@ declare namespace Office { * The type property on the parameter will match the eventType parameter passed to removeHandlerAsync. * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. - * - * @beta */ removeHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; } @@ -14693,7 +14693,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#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://msdn.microsoft.com/library/office/dn148008.aspx | 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/outlook/add-ins/get-attachments-of-an-outlook-item | get attachments from the selected item}. * * Note: This member is not supported in Outlook for iOS or Outlook for Android. */ @@ -14808,7 +14808,7 @@ declare namespace Office { * {@link https://docs.microsoft.com/outlook/add-ins/#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://msdn.microsoft.com/office/office365/APi/mail-rest-operations | Outlook Mail API} or the {@link http://graph.microsoft.io/ | Microsoft Graph}. + * {@link https://docs.microsoft.com/previous-versions/office/office-365-api/api/version-2.0/mail-rest-operations | Outlook Mail API} or the {@link http://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) @@ -15077,7 +15077,7 @@ declare namespace Office { * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose and read * * The getUserIdentityTokenAsync method returns a token that you can use to identify and - * {@link https://msdn.microsoft.com/library/office/fp179828.aspx | authenticate the add-in and user with a third-party system}. + * {@link https://docs.microsoft.com/outlook/add-ins/authentication | authenticate the add-in and user with a third-party system}. * * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. @@ -15333,7 +15333,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * In addition to the main signature, this method also has this signature: + * In addition to this signature, this method also has the following signature: * * `getAllAsync(callback: (result: AsyncResult) => void): void;` * @@ -15367,7 +15367,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * In addition to the main signature, this method also has these signatures: + * In addition to this signature, this method also has the following signatures: * * `removeAsync(key: string): void;` * @@ -15437,7 +15437,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * In addition to the main signature, this method also has these signatures: + * In addition to this signature, this method also has the following signatures: * * `replaceAsync(key: string, JSONmessage: NotificationMessageDetails): void;` * @@ -15566,7 +15566,7 @@ declare namespace Office { * * ErrorsNumberOfRecipientsExceeded - The number of recipients exceeded 100 entries. * - * In addition to the main signature, this method also has these signatures: + * In addition to this signature, this method also has the following signatures: * * `addAsync(recipients: (string | EmailUser | EmailAddressDetails)[]): void;` * @@ -15666,7 +15666,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * In addition to the main signature, this method also has this signature: + * In addition to this signature, this method also has the following signature: * * `getAsync(callback: (result: AsyncResult) => void): void;` * @@ -15716,7 +15716,7 @@ declare namespace Office { * * ErrorsNumberOfRecipientsExceeded - The number of recipients exceeded 100 entries. * - * In addition to the main signature, this method also has these signatures: + * In addition to this signature, this method also has the following signatures: * * `setAsync(recipients: (string | EmailUser | EmailAddressDetails)[]): void;` * @@ -15822,7 +15822,7 @@ declare namespace Office { * meeting requests. * It will have a dictionary with the following keys: seriesTime, recurrenceType, recurrenceProperties, and recurrenceTimeZone (optional). * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -15869,14 +15869,12 @@ declare namespace Office { * Yes (item.recurrence) * * - * - * @beta */ export interface Recurrence { /** * Gets or sets the properties of the recurring appointment series. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -15884,11 +15882,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - recurrenceProperties: RecurrenceProperties; + recurrenceProperties: Office.RecurrenceProperties; /** * Gets or sets the properties of the recurring appointment series. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -15896,12 +15894,12 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read */ - recurrenceTimeZone: Office.MailboxEnums.RecurrenceTimeZone; + recurrenceTimeZone: Office.RecurrenceTimeZone; /** * Gets or sets the type of the recurring appointment series. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -15916,7 +15914,7 @@ declare namespace Office { * 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 Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -15931,7 +15929,7 @@ declare namespace Office { * * This method returns the entire recurrence object for the appointment series. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -15939,7 +15937,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read * - * In addition to the main signature, this method also has this signature: + * In addition to this signature, this method also has the following signature: * * `getAsync(callback?: (result: AsyncResult) => void): void;` * @@ -15956,7 +15954,7 @@ declare namespace Office { * * This method returns the entire recurrence object for the appointment series. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -15975,7 +15973,7 @@ declare namespace Office { * * Note: setAsync should only be available for series items and not instance items. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -15985,7 +15983,7 @@ declare namespace Office { * * ErrorsInvalidEndTime - The appointment end time is before its start time. * - * In addition to the main signature, this method also has this signature: + * In addition to this signature, this method also has the following signature: * * `setAsync(recurrencePattern: Recurrence, callback?: (result: AsyncResult) => void): void;` * @@ -16002,7 +16000,7 @@ declare namespace Office { * * Note: setAsync should only be available for series items and not instance items. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -16020,17 +16018,15 @@ declare namespace Office { } /** - * Gets or sets the properties of the recurrence. + * Represents the properties of the recurrence. * - * [Api set: Mailbox Preview] + * [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/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read
- * - * @beta */ export interface RecurrenceProperties { /** @@ -16064,6 +16060,29 @@ declare namespace Office { firstDayOfWeek: Office.MailboxEnums.Days; } + /** + * Represents the time zone of the recurrence. + * + * [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/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read
+ */ + export interface RecurrenceTimeZone { + /** + * Represents the name of the recurrence time zone. + */ + name: Office.MailboxEnums.RecurrenceTimeZone; + + /** + * Integer value representing the difference in minutes between the local time zone and UTC at the date that the meeting series began. + */ + offset: number; + } + /** * A file or item attachment. Used when displaying a reply form. */ @@ -16206,20 +16225,18 @@ declare namespace Office { * 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 Preview] + * [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/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose or read
- * - * @beta */ interface SeriesTime { /** * Gets the duration in minutes of a usual instance in a recurring appointment series. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -16231,7 +16248,7 @@ declare namespace Office { /** * 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 Preview] + * [Api set: Mailbox 1.7] * * @remarks *
{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}ReadItem
@@ -16245,7 +16262,7 @@ declare namespace Office { * 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 Preview] + * [Api set: Mailbox 1.7] * * @remarks *
{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}ReadItem
@@ -16257,7 +16274,7 @@ declare namespace Office { /** * 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 Preview] + * [Api set: Mailbox 1.7] * * @remarks *
{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}ReadItem
@@ -16270,7 +16287,7 @@ declare namespace Office { * 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 Preview] + * [Api set: Mailbox 1.7] * * @remarks *
{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}ReadItem
@@ -16282,7 +16299,7 @@ declare namespace Office { /** * Sets the duration of all appointments in a recurrence pattern. This will also change the end time of the recurrence pattern. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks *
{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}ReadItem
@@ -16296,7 +16313,7 @@ declare namespace Office { /** * Sets the end date of a recurring appointment series. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks *
{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}ReadWriteItem
@@ -16305,7 +16322,7 @@ declare namespace Office { * *
{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}ReadWriteItem
ErrorsInvalid date format - The date is not in an acceptable format.
* - * In addition to the main signature, this method also has this signature: + * In addition to this signature, this method also has the following signature: * * `setEndDate(date: string): void;` (Where date is the end date of the recurring appointment series represented in the * {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD"). @@ -16318,7 +16335,7 @@ declare namespace Office { /** * Sets the end date of a recurring appointment series. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -16333,7 +16350,7 @@ declare namespace Office { /** * Sets the start date of a recurring appointment series. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks *
{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}ReadWriteItem
@@ -16342,7 +16359,7 @@ declare namespace Office { * *
{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}ReadWriteItem
ErrorsInvalid date format - The date is not in an acceptable format.
* - * In addition to the main signature, this method also has this signature: + * In addition to this signature, this method also has the following signature: * * `setStartDate(date: string): void;` (Where date is the start date of the recurring appointment series represented in the {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD"). * @@ -16355,7 +16372,7 @@ declare namespace Office { /** * Sets the start date of a recurring appointment series. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -16372,7 +16389,7 @@ declare namespace Office { * Sets the start time of all instances of a recurring appointment series in whichever time zone the recurrence pattern is set * (the item's time zone is used by default). * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks *
{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}ReadWriteItem
@@ -16381,7 +16398,7 @@ declare namespace Office { * *
{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}ReadWriteItem
ErrorsInvalid time format - The time is not in an acceptable format.
* - * In addition to the main signature, this method also has this signature: + * In addition to this signature, this method also has the following signature: * * `setStartTime(time: string): void;` (Where time is the start time of all instances represented by standard datetime string format: "THH:mm:ss:mmm"). * @@ -16394,7 +16411,7 @@ declare namespace Office { * Sets the start time of all instances of a recurring appointment series in whichever time zone the recurrence pattern is set * (the item's time zone is used by default). * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.7] * * @remarks * @@ -16408,6 +16425,33 @@ declare namespace Office { setStartTime(time: string): void; } + /** + * Represents the properties of an appointment or message in a shared folder, mailbox, or calendar. + * + * [Api set: Mailbox Preview] + * + * @remarks + *
{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}ReadWriteItem
+ * + *
{@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
+ * + * @beta + */ + interface SharedProperties { + /** + * The email address of the owner of a shared item. + */ + owner: String; + /** + * The remote REST url related to the owner’s mailbox. + */ + restUrl: String; + /** + * The permissions that the delegate has on a shared folder. + */ + delegatePermissions: Office.MailboxEnums.DelegatePermissions; + } + /** * Provides methods to get and set the subject of an appointment or message in an Outlook add-in. * @@ -16431,7 +16475,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * In addition to the main signature, this method also has this signature: + * In addition to this signature, this method also has the following signature: * * `getAsync(callback: (result: AsyncResult) => void): void;` * @@ -16473,7 +16517,7 @@ declare namespace Office { * * ErrorsDataExceedsMaximumSize - The subject parameter is longer than 255 characters. * - * In addition to the main signature, this method also has these signatures: + * In addition to this signature, this method also has the following signatures: * * `setAsync(subject: string): void;` * @@ -16595,7 +16639,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}Compose * - * In addition to the main signature, this method also has this signature: + * In addition to this signature, this method also has the following signature: * * `getAsync(callback: (result: AsyncResult) => void): void;` * @@ -16639,7 +16683,7 @@ declare namespace Office { * * ErrorsInvalidEndTime - The appointment end time is before the appointment start time. * - * In addition to the main signature, this method also has these signatures: + * In addition to this signature, this method also has the following signatures: * * `setAsync(dateTime: Date): void;` *