casraf/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/chenasraf/DefinitelyTyped.git synced 2026-05-18 01:49:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

[office-js-preview] (insightMessage) Note support for related API (#49955)

Browse Source
This commit is contained in:
Elizabeth Samuel
2020-12-09 09:53:04 -08:00
committed by GitHub
parent c39c9481fe
commit c804b5039d
1 changed files with 33 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
types/office-js-preview/index.d.ts vendored
View File

@@ -9759,7 +9759,7 @@ 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.
* and Outlook on the web for Microsoft 365.
*
* [Api set: Mailbox Preview]
*
@@ -9775,7 +9775,7 @@ 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
* of type `Office.AsyncResult`.
* On success, the initialization data is provided in the `asyncResult.value` property as a string.
* On success, the initialization context 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`.
*
@@ -10844,7 +10844,7 @@ 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.
* and Outlook on the web for Microsoft 365.
*
* [Api set: Mailbox Preview]
*
@@ -10856,11 +10856,11 @@ declare namespace Office {
*
* @param options - Optional. An object 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`.
* @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 context 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
*/
@@ -13766,7 +13766,7 @@ 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.
* and Outlook on the web for Microsoft 365.
*
* [Api set: Mailbox Preview]
*
@@ -13780,10 +13780,11 @@ declare namespace Office {
*
* @param options - Optional. An object 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`.
* @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 context 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
*/
@@ -14726,7 +14727,7 @@ declare namespace Office {
* {@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.
* and Outlook on the web for Microsoft 365.
*
* [Api set: Mailbox Preview]
*
@@ -14738,11 +14739,11 @@ declare namespace Office {
*
* @param options - Optional. An object 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`.
* @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 context 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
*/
@@ -15103,13 +15104,15 @@ declare namespace Office {
/**
* The definition of the action for a notification message.
*
* **Important**: In modern Outlook on the web, the `NotificationMessageAction` object is available in Compose mode only.
*
* [Api set: Mailbox Preview]
*
* @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
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
*
* @beta
*/
@@ -15129,6 +15132,7 @@ declare namespace Office {
commandId: string;
/**
* Any JSON data the button needs to pass on.
* This data can be retrieved by calling `item.getInitializationContextAsync`.
*/
contextData: any;
}
@@ -15183,11 +15187,13 @@ declare namespace Office {
* Only applicable when the type is `InsightMessage`.
* Specifying this property for an unsupported type or including too many actions throws an error.
*
* **Important**: In modern Outlook on the web, the `actions` property is available in Compose mode only.
*
* [Api set: Mailbox Preview]
*
* @remarks
*
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#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 or Read
*
* @beta
*/
@@ -15210,9 +15216,13 @@ declare namespace Office {
*
* There are a maximum of 5 notifications per message. Setting more will return a `NumberOfNotificationMessagesExceeded` error.
*
* **Important**: Only one notification of type `InsightMessage` is allowed per add-in.
* **Important**:
*
* - Only one notification of type `InsightMessage` is allowed per add-in.
* (The `InsightMessage` type is currently in preview.) Attempting to add more will throw an error.
*
* - In modern Outlook on the web, you can add an `InsightMessage` notification only in Compose mode.
*
* [Api set: Mailbox 1.3]
*
* @remarks
@@ -16603,7 +16613,7 @@ declare namespace Office {
* </tr>
* <tr>
* <td>office365</td>
* <td>The mailbox is associated with an Office 365 work or school account.</td>
* <td>The mailbox is associated with a Microsoft 365 work or school account.</td>
* </tr>
* <tr>
* <td>outlookCom</td>