Office.RecurrenceTimeZone interface

Package:

outlook

Represents the time zone of the recurrence.

Remarks

[ API set: Mailbox 1.7 ]

Minimum permission level: read item

Applicable Outlook mode: Compose or Read

Examples

// This example gets the Recurrence object of an appointment item.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    if (!recurrence) {
    //if (recurrence == null) {
        console.log("One-time appointment or meeting");
    } else {
        console.log(JSON.stringify(recurrence));
    }
}

// The following example shows the results of the getAsync call that retrieves the recurrence for a series.
// NOTE: In this example, seriesTimeObject is a placeholder for the JSON representing the
// recurrence.seriesTime property. You should use the SeriesTime object's methods to get the
// recurrence date and time properties.
Recurrence = {
    "recurrenceType": "weekly",
    "recurrenceProperties": {"interval": 2, "days": ["mon","thu","fri"], "firstDayOfWeek": "sun"},
    "seriesTime": {seriesTimeObject},
    "recurrenceTimeZone": {"name": "Pacific Standard Time", "offset": -480}
}

Properties

name	Represents the name of the recurrence time zone.
offset	Integer value representing the difference in minutes between the local time zone and UTC at the date that the meeting series began.

Property Details

name

Represents the name of the recurrence time zone.

name: MailboxEnums.RecurrenceTimeZone | string;

Property Value

Office.MailboxEnums.RecurrenceTimeZone | string

offset

Integer value representing the difference in minutes between the local time zone and UTC at the date that the meeting series began.

offset?: number;

Property Value

number