diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 809a710809..82243de393 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -2252,12 +2252,28 @@ declare namespace Office { * * In the callback function passed to the closeAsync method, you can use the properties of the AsyncResult object to return the following information. * - * |Property |Use to...| - * |---------|---------| - * |AsyncResult.value|Always returns undefined because there is no object or data to retrieve.| - * |AsyncResult.status|Determine the success or failure of the operation.| - * |AsyncResult.error|Access an Error object that provides error information if the operation failed.| - * |AsyncResult.asyncContext|A user-defined item of any type that is returned in the AsyncResult object without being altered.| + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse to...
AsyncResult.valueAlways returns undefined because there is no object or data to retrieve.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextA user-defined item of any type that is returned in the AsyncResult object without being altered.
* * Hosts: PowerPoint, Word * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. When the function you passed to the callback parameter executes, it receives an AsyncResult object that you can access from the callback function's only parameter. @@ -2272,12 +2288,28 @@ declare namespace Office { * * In the callback function passed to the getSliceAsync method, you can use the properties of the AsyncResult object to return the following information. * - * |Property |Use to...| - * |---------|---------| - * |AsyncResult.value|Access the Slice object.| - * |AsyncResult.status|Determine the success or failure of the operation.| - * |AsyncResult.error|Access an Error object that provides error information if the operation failed.| - * |AsyncResult.asyncContext|A user-defined item of any type that is returned in the AsyncResult object without being altered.| + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse to...
AsyncResult.valueAccess the Slice object.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextA user-defined item of any type that is returned in the AsyncResult object without being altered.
* * Hosts: PowerPoint, Word * @param sliceIndex Specifies the zero-based index of the slice to be retrieved. Required. @@ -2348,12 +2380,28 @@ declare namespace Office { * * In the callback function passed to the addHandlerAsync method, you can use the properties of the AsyncResult object to return the following information. * - * |Property |Use to...| - * |---------|---------| - * |AsyncResult.value|Always returns undefined because there is no data or object to retrieve when adding an event handler.| - * |AsyncResult.status|Determine the success or failure of the operation.| - * |AsyncResult.error|Access an Error object that provides error information if the operation failed.| - * |AsyncResult.asyncContext|A user-defined item of any type that is returned in the AsyncResult object without being altered.| + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse to...
AsyncResult.valueAlways returns undefined because there is no data or object to retrieve when adding an event handler.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextA user-defined item of any type that is returned in the AsyncResult object without being altered.
* * Hosts: Excel * @@ -2387,12 +2435,28 @@ declare namespace Office { * * In the callback function passed to the refreshAsync method, you can use the properties of the AsyncResult object to return the following information. * - * |Property |Use to...| - * |---------|---------| - * |AsyncResult.value|Access a Settings object with the refreshed values.| - * |AsyncResult.status|Determine the success or failure of the operation.| - * |AsyncResult.error|Access an Error object that provides error information if the operation failed.| - * |AsyncResult.asyncContext|A user-defined item of any type that is returned in the AsyncResult object without being altered.| + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse to...
AsyncResult.valueAccess a Settings object with the refreshed values.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextA user-defined item of any type that is returned in the AsyncResult object without being altered.
* * Hosts: Access, Excel, PowerPoint, Word * @@ -2444,12 +2508,28 @@ declare namespace Office { * * In the callback function passed to the saveAsync method, you can use the properties of the AsyncResult object to return the following information. * - * |Property |Use to...| - * |---------|---------| - * |AsyncResult.value|Always returns undefined because there is no object or data to retrieve.| - * |AsyncResult.status|Determine the success or failure of the operation.| - * |AsyncResult.error|Access an Error object that provides error information if the operation failed.| - * |AsyncResult.asyncContext|A user-defined item of any type that is returned in the AsyncResult object without being altered.| + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
PropertyUse to...
AsyncResult.valueAlways returns undefined because there is no object or data to retrieve.
AsyncResult.statusDetermine the success or failure of the operation.
AsyncResult.errorAccess an Error object that provides error information if the operation failed.
AsyncResult.asyncContextA user-defined item of any type that is returned in the AsyncResult object without being altered.
* * Hosts: Access, Excel, PowerPoint, Word * @param options Provides options for saving settings. @@ -7694,10 +7774,23 @@ declare namespace Office { * * @remarks * - * |Type|Description|Item Class| - * |-----------|------------|------------| - * |Appointment items|These are calendar items of the item class IPM.Appointment or IPM.Appointment.Occurence.|IPM.Appointment,IPM.Appointment.Occurence| - * |Message items|These include email messages that have the default message class IPM.Note, and meeting requests, responses, and cancellations, that use IPM.Schedule.Meeting as the base message class.|IPM.Note,IPM.Schedule.Meeting.Request,IPM.Schedule.Meeting.Neg,IPM.Schedule.Meeting.Pos,IPM.Schedule.Meeting.Tent,IPM.Schedule.Meeting.Canceled| + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
TypeDescriptionItem Class
Appointment itemsThese are calendar items of the item class IPM.Appointment or IPM.Appointment.Occurence.IPM.Appointment,IPM.Appointment.Occurence
Message itemsThese include email messages that have the default message class IPM.Note, and meeting requests, responses, and cancellations, that use IPM.Schedule.Meeting as the base message class.IPM.Note,IPM.Schedule.Meeting.Request,IPM.Schedule.Meeting.Neg,IPM.Schedule.Meeting.Pos,IPM.Schedule.Meeting.Tent,IPM.Schedule.Meeting.Canceled
* * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * @@ -7862,15 +7955,48 @@ declare namespace Office { * * While the minimum permission level to use this method is Restricted, some entity types require ReadItem to access, as specified in the following table. * - * |Value of entityType|Type of objects in returned array|Required Permission Level| - * |-------|-----------|----------| - * |Address|String|Restricted| - * |Contact|Contact|ReadItem| - * |EmailAddress|String|ReadItem| - * |MeetingSuggestion|MeetingSuggestion|ReadItem| - * |PhoneNumber|PhoneNumber|Restricted| - * |TaskSuggestion|TaskSuggestion|ReadItem| - * |URL|String|Restricted| + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
Value of entityTypeType of objects in returned arrayRequired Permission Leve
AddressStringRestricted
ContactContactReadItem
EmailAddressStringReadItem
MeetingSuggestionMeetingSuggestionReadItem
PhoneNumberPhoneNumberRestricted
TaskSuggestionTaskSuggestionReadItem
URLStringRestricted
* * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: Restricted * @@ -9340,14 +9466,43 @@ declare namespace Office { * * @remarks * - * |State|Editable?|Viewable?| - * |-----|---------|---------| - * |Appointment Organizer - Compose Series|Yes (setAsync)|Yes (getAsync)| - * |Appointment Organizer - Compose Instance|No (setAsync returns error)|Yes (getAsync)| - * |Appointment Attendee - Read Series|No (setAsync not available)|Yes (item.recurrence)| - * |Appointment Attendee - Read Instance|No (setAsync not available)|Yes (item.recurrence)| - * |Meeting Request - Read Series|No (setAsync not available)|Yes (item.recurrence)| - * |Meeting Request - Read Instance|No (setAsync not available)|Yes (item.recurrence)| + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
StateEditable?Viewable?
Appointment Organizer - Compose SeriesYes (setAsync)Yes (getAsync)
Appointment Organizer - Compose InstanceNo (setAsync returns error)Yes (getAsync)
Appointment Attendee - Read SeriesNo (setAsync not available)Yes (item.recurrence)
Appointment Attendee - Read InstanceNo (setAsync not available)Yes (item.recurrence)
Meeting Request - Read SeriesNo (setAsync not available)Yes (item.recurrence)
Meeting Request - Read InstanceNo (setAsync not available)Yes (item.recurrence)
* * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * @@ -10156,12 +10311,28 @@ declare namespace Office { * * @remarks * - * |Value |Description | - * |---------|--------------| - * |enterprise |The mailbox is on an on-premises Exchange server.| - * |gmail |The mailbox is associated with a Gmail account.| - * |office365 |The mailbox is associated with an Office 365 work or school account.| - * |outlookCom |The mailbox is associated with a personal Outlook.com account.| + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
ValueDescription?
enterpriseThe mailbox is on an on-premises Exchange server.
gmailThe mailbox is associated with a Gmail account.
office365The mailbox is associated with an Office 365 work or school account.
outlookComThe mailbox is associated with a personal Outlook.com account.
* * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem *