[office-js][office-js-preview] (Outlook) Document InitializationContextChanged event (DefinitelyTyped#71472)

Author: samantharamon

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

@@ -652,6 +652,22 @@ declare namespace Office {
          * [Api set: Mailbox 1.10]
          */
         InfobarClicked,
+        /**
+         * Occurs in Outlook when an add-in's task pane is opened from an {@link https://learn.microsoft.com/outlook/actionable-messages | actionable message},
+         * {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage} notification,
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts} dialog, or
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting} dialog.
+         * This event prevents an add-in from relaunching if its task pane is already open in Outlook.
+         *
+         * **Important**: The `InitializationContextChanged` event can only be handled in a task pane. Function commands can't register a handler for this event.
+         *
+         * To add an event handler for the `InitializationContextChanged` event, use the `addHandlerAsync` method of the `Item` object.
+         * The event handler receives an argument of type
+         * {@link https://learn.microsoft.com/javascript/api/outlook/office.initializationcontextchangedeventargs?view=outlook-js-1.15 | Office.InitializationContextChangedEventArgs}.
+         *
+         * [Api set: Mailbox 1.15]
+         */
+        InitializationContextChanged,
         /**
          * Occurs when a different Outlook item is selected for viewing while the task pane is pinned.
          *
@@ -14819,6 +14835,33 @@ declare namespace Office {
          */
         infobarType: MailboxEnums.InfobarType;
     }
+    /**
+     * Provides data from an {@link https://learn.microsoft.com/outlook/actionable-messages | actionable message},
+     * {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage} notification,
+     * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts} dialog, or
+     * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting} dialog when the
+     * `Office.EventType.InitializationContextChanged` event occurs.
+     *
+     * @remarks
+     * [Api set: Mailbox 1.15]
+     */
+    export interface InitializationContextChangedEventArgs {
+        /**
+         * Represents the data to be passed to an add-in's task pane from an actionable message, notification message, Smart Alerts dialog, or integrated
+         * spam-reporting dialog.
+         *
+         * @remarks
+         * [Api set: Mailbox 1.15]
+         */
+        initializationContextData: string;
+        /**
+         * Represents the type of the event. For details, refer to {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
+         *
+         * @remarks
+         * [Api set: Mailbox 1.15]
+         */
+        type: "olkInitializationContextChanged";
+    }
     /**
      * The `InternetHeaders` object represents custom internet headers that are preserved after the message item leaves Exchange
      * and is converted to a MIME message.

types/office-js/index.d.ts

@@ -652,6 +652,22 @@ declare namespace Office {
          * [Api set: Mailbox 1.10]
          */
         InfobarClicked,
+        /**
+         * Occurs in Outlook when an add-in's task pane is opened from an {@link https://learn.microsoft.com/outlook/actionable-messages | actionable message},
+         * {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage} notification,
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts} dialog, or
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting} dialog.
+         * This event prevents an add-in from relaunching if its task pane is already open in Outlook.
+         *
+         * **Important**: The `InitializationContextChanged` event can only be handled in a task pane. Function commands can't register a handler for this event.
+         *
+         * To add an event handler for the `InitializationContextChanged` event, use the `addHandlerAsync` method of the `Item` object.
+         * The event handler receives an argument of type
+         * {@link https://learn.microsoft.com/javascript/api/outlook/office.initializationcontextchangedeventargs?view=outlook-js-1.15 | Office.InitializationContextChangedEventArgs}.
+         *
+         * [Api set: Mailbox 1.15]
+         */
+        InitializationContextChanged,
         /**
          * Occurs when a different Outlook item is selected for viewing while the task pane is pinned.
          *
@@ -14505,6 +14521,33 @@ declare namespace Office {
          */
         infobarType: MailboxEnums.InfobarType;
     }
+    /**
+     * Provides data from an {@link https://learn.microsoft.com/outlook/actionable-messages | actionable message},
+     * {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage} notification,
+     * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts} dialog, or
+     * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting} dialog when the
+     * `Office.EventType.InitializationContextChanged` event occurs.
+     *
+     * @remarks
+     * [Api set: Mailbox 1.15]
+     */
+    export interface InitializationContextChangedEventArgs {
+        /**
+         * Represents the data to be passed to an add-in's task pane from an actionable message, notification message, Smart Alerts dialog, or integrated
+         * spam-reporting dialog.
+         *
+         * @remarks
+         * [Api set: Mailbox 1.15]
+         */
+        initializationContextData: string;
+        /**
+         * Represents the type of the event. For details, refer to {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
+         *
+         * @remarks
+         * [Api set: Mailbox 1.15]
+         */
+        type: "olkInitializationContextChanged";
+    }
     /**
      * The `InternetHeaders` object represents custom internet headers that are preserved after the message item leaves Exchange
      * and is converted to a MIME message.