Office.RecurrenceChangedEventArgs interface

Package:

outlook

Provides updated recurrence object that raised the Office.EventType.RecurrenceChanged event.

Remarks

[ API set: Mailbox 1.7 ]

Examples

// Adds an event handler for the RecurrenceChanged event.
Office.onReady(() => {
    document.addEventListener('DOMContentLoaded', () => {
        // Get a reference to the mailbox and use it to add an event handler.
        const mailbox = Office.context.mailbox;
        mailbox.addHandlerAsync(Office.EventType.RecurrenceChanged, recurrenceChangedHandler, (result) => {
            if (result.status === Office.AsyncResultStatus.Failed) {
                console.error(`Failed to add event handler: ${asyncResult.error.message}`);
                return;
            }

            console.log("Event handler added successfully.");
        });
    });
});

// Handles the RecurrenceChanged event.
function recurrenceChangedHandler(event) {
    console.log(`Event: ${event.type}`);
    const recurrence = event.recurrence;

    // Perform operations based on the updated recurrence.
}

Properties

recurrence	Gets the updated recurrence object.
type	Gets the type of the event. For details, refer to Office.EventType.

Property Details

recurrence

Gets the updated recurrence object.

recurrence: Recurrence;

Property Value

Office.Recurrence

Remarks

[ API set: Mailbox 1.7 ]

type

Gets the type of the event. For details, refer to Office.EventType.

type: "olkRecurrenceChanged";

Property Value

"olkRecurrenceChanged"

Remarks

[ API set: Mailbox 1.7 ]