Skip to content

Commit 5c69929

Browse files
[office-js][office-js-preview] (Outlook) Clarify mail add-in types that support the Event object (DefinitelyTyped#72196)
1 parent 3573a7c commit 5c69929

File tree

2 files changed

+38
-18
lines changed

2 files changed

+38
-18
lines changed

types/office-js-preview/index.d.ts

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3365,11 +3365,13 @@ declare namespace Office {
33653365
*
33663366
* This method must be called at the end of a function which was invoked by the following:
33673367
*
3368-
* - A function command button (that is, an add-in command defined with an **\<Action\>** element, where the `xsi:type` attribute is set to `ExecuteFunction`).
3368+
* - A {@link https://learn.microsoft.com/office/dev/add-ins/design/add-in-commands | function command} button.
33693369
*
3370-
* - An {@link https://learn.microsoft.com/javascript/api/manifest/event | event} defined in the
3371-
* {@link https://learn.microsoft.com/javascript/api/manifest/extensionpoint#events | Events extension point} of an on-send add-in in Outlook.
3372-
* For example, an `ItemSend` event.
3370+
* - An {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins | on-send add-in} in Outlook.
3371+
*
3372+
* - An {@link https://learn.microsoft.com/office/dev/add-ins/outlook/online-meeting | online-meeting provider add-in} in Outlook.
3373+
*
3374+
* - A {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-log-appointments | note-logging add-in} in Outlook on mobile devices.
33733375
*
33743376
* @remarks
33753377
*
@@ -3381,16 +3383,20 @@ declare namespace Office {
33813383
*
33823384
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
33833385
*
3384-
* **Important**: The `options` parameter only applies to Outlook add-ins that implement the
3385-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins | on-send feature}. It was introduced in Mailbox 1.8.
3386+
* **Important**: The `options` parameter only applies to Outlook add-ins. It was introduced in Mailbox 1.8. Although Outlook on Android and on iOS support up to
3387+
* Mailbox 1.5, the `options` parameter is supported in online-meeting provider and note-logging mobile add-ins. For more information on API support in
3388+
* Outlook on mobile devices, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
33863389
*
3387-
* @param options Optional. An object that specifies the behavior of an on-send add-in in Outlook when it completes processing an `ItemSend` event.
3390+
* @param options Optional. In Outlook, an object that specifies the behavior of an on-send add-in, online-meeting provider add-in, or note-logging mobile add-in
3391+
* when it completes processing an event.
33883392
*/
33893393
completed(options?: EventCompletedOptions): void;
33903394
}
33913395
/**
3392-
* Specifies the behavior of an {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins | on-send} add-in in Outlook
3393-
* when it completes processing an `ItemSend` event.
3396+
* Specifies the behavior of an {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins | on-send add-in},
3397+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/online-meeting | online-meeting provider add-in}, or
3398+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-log-appointments | note-logging mobile add-in}
3399+
* when it completes processing an event in Outlook.
33943400
*
33953401
* @remarks
33963402
*
@@ -3399,6 +3405,10 @@ declare namespace Office {
33993405
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
34003406
*
34013407
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
3408+
*
3409+
* **Important**: Although Outlook on Android and on iOS support up to Mailbox 1.5, the `EventCompletedOptions` object is supported in online-meeting provider and
3410+
* note-logging mobile add-ins. For more information on API support in Outlook on mobile devices, see
3411+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
34023412
*/
34033413
interface EventCompletedOptions {
34043414
/**

types/office-js/index.d.ts

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3363,11 +3363,13 @@ declare namespace Office {
33633363
*
33643364
* This method must be called at the end of a function which was invoked by the following:
33653365
*
3366-
* - A function command button (that is, an add-in command defined with an **\<Action\>** element, where the `xsi:type` attribute is set to `ExecuteFunction`).
3366+
* - A {@link https://learn.microsoft.com/office/dev/add-ins/design/add-in-commands | function command} button.
33673367
*
3368-
* - An {@link https://learn.microsoft.com/javascript/api/manifest/event | event} defined in the
3369-
* {@link https://learn.microsoft.com/javascript/api/manifest/extensionpoint#events | Events extension point} of an on-send add-in in Outlook.
3370-
* For example, an `ItemSend` event.
3368+
* - An {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins | on-send add-in} in Outlook.
3369+
*
3370+
* - An {@link https://learn.microsoft.com/office/dev/add-ins/outlook/online-meeting | online-meeting provider add-in} in Outlook.
3371+
*
3372+
* - A {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-log-appointments | note-logging add-in} in Outlook on mobile devices.
33713373
*
33723374
* @remarks
33733375
*
@@ -3379,16 +3381,20 @@ declare namespace Office {
33793381
*
33803382
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
33813383
*
3382-
* **Important**: The `options` parameter only applies to Outlook add-ins that implement the
3383-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins | on-send feature}. It was introduced in Mailbox 1.8.
3384+
* **Important**: The `options` parameter only applies to Outlook add-ins. It was introduced in Mailbox 1.8. Although Outlook on Android and on iOS support up to
3385+
* Mailbox 1.5, the `options` parameter is supported in online-meeting provider and note-logging mobile add-ins. For more information on API support in
3386+
* Outlook on mobile devices, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
33843387
*
3385-
* @param options Optional. An object that specifies the behavior of an on-send add-in in Outlook when it completes processing an `ItemSend` event.
3388+
* @param options Optional. In Outlook, an object that specifies the behavior of an on-send add-in, online-meeting provider add-in, or note-logging mobile add-in
3389+
* when it completes processing an event.
33863390
*/
33873391
completed(options?: EventCompletedOptions): void;
33883392
}
33893393
/**
3390-
* Specifies the behavior of an {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins | on-send} add-in in Outlook
3391-
* when it completes processing an `ItemSend` event.
3394+
* Specifies the behavior of an {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins | on-send add-in},
3395+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/online-meeting | online-meeting provider add-in}, or
3396+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-log-appointments | note-logging mobile add-in}
3397+
* when it completes processing an event in Outlook.
33923398
*
33933399
* @remarks
33943400
*
@@ -3397,6 +3403,10 @@ declare namespace Office {
33973403
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
33983404
*
33993405
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
3406+
*
3407+
* **Important**: Although Outlook on Android and on iOS support up to Mailbox 1.5, the `EventCompletedOptions` object is supported in online-meeting provider and
3408+
* note-logging mobile add-ins. For more information on API support in Outlook on mobile devices, see
3409+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
34003410
*/
34013411
interface EventCompletedOptions {
34023412
/**

0 commit comments

Comments
 (0)