Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Office.InfobarDetails interface

Package:
outlook

Provides additional details about the notification message that raised the Office.EventType.InfobarClicked event.

Remarks

API set: Mailbox 1.10

Used by

Examples

/*
* This snippet activates when a notification message is dismissed from an Outlook message or appointment.
* The event handler logs the custom action and notification type to the console.
*/
Office.context.mailbox.item.addHandlerAsync(Office.EventType.InfobarClicked, eventHandler, callback);

function eventHandler(event) {
 const infobarDetails = event.infobarDetails;

 // Log the custom action type.
 console.log(`Custom action type: ${infobarDetails.actionType}`);

 // Log the notification type.
 switch (infobarDetails.infobarType) {
 case Office.MailboxEnums.InfobarType.Error:
 console.log("Notification type: Error message");
 break;
 case Office.MailboxEnums.InfobarType.Informational:
 console.log("Notification type: Informational message");
 break;
 case Office.MailboxEnums.InfobarType.Insight:
 console.log("Notification type: Informational message with available actions from the task pane");
 break;
 case Office.MailboxEnums.InfobarType.ProgressIndicator:
 console.log("Notification type: Progress indicator");
 break;
 }
}

Properties

actionType

The action type. Currently, "Dismiss" is the only supported action.

infobarType

The notification type.

Property Details

actionType

The action type. Currently, "Dismiss" is the only supported action.

actionType: MailboxEnums.InfobarActionType;

Property Value

Remarks

API set: Mailbox 1.10

infobarType

The notification type.

infobarType: MailboxEnums.InfobarType;

Property Value

Remarks

API set: Mailbox 1.10


Feedback

Was this page helpful?