Edit

Share via

Office.RecurrenceProperties interface

Package:
outlook

Represents the properties 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) {
        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

dayOfMonth

Represents the day of the month.
dayOfWeek

Represents the day of the week or type of day, for example, weekend day vs weekday.
days

Represents the set of days for this recurrence. Valid values are: 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', and 'Sun'.
firstDayOfWeek

Represents your chosen first day of the week otherwise the default is the value in the current user's settings. Valid values are: 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', and 'Sun'.
interval

Represents the period between instances of the same recurring series.
month

Represents the month.
weekNumber

Represents the number of the week in the selected month e.g., 'first' for first week of the month.

Property Details

dayOfMonth

Represents the day of the month.

dayOfMonth?: number;

Property Value

number

dayOfWeek

Represents the day of the week or type of day, for example, weekend day vs weekday.

dayOfWeek?: MailboxEnums.Days | string;

Property Value

Office.MailboxEnums.Days | string

days

Represents the set of days for this recurrence. Valid values are: 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', and 'Sun'.

days?: MailboxEnums.Days[] | string[];

Property Value

Office.MailboxEnums.Days[] | string[]

firstDayOfWeek

Represents your chosen first day of the week otherwise the default is the value in the current user's settings. Valid values are: 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', and 'Sun'.

firstDayOfWeek?: MailboxEnums.Days | string;

Property Value

Office.MailboxEnums.Days | string

interval

Represents the period between instances of the same recurring series.

interval: number;

Property Value

number

month

Represents the month.

month?: MailboxEnums.Month | string;

Property Value

Office.MailboxEnums.Month | string

weekNumber

Represents the number of the week in the selected month e.g., 'first' for first week of the month.

weekNumber?: MailboxEnums.WeekNumber | string;

Property Value

Office.MailboxEnums.WeekNumber | string