Office.SeriesTime interface

Пакет:

outlook

Объект SeriesTime предоставляет методы для получения и установки даты и времени встреч в повторяющемся ряду, а также получения даты и времени приглашений на собрания в повторяющемся ряду.

Комментарии

Набор API: Почтовый ящик 1.7

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose или чтение

Используется

• Office.Recurrence: seriesTime

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-set-recurrence-appointment-organizer.yaml

// Important: Can only set the recurrence pattern of an appointment series.

const currentDate = new Date();
let seriesTimeObject: Office.SeriesTime;
// Set series start date to tomorrow.
seriesTimeObject.setStartDate(currentDate.getFullYear(), currentDate.getMonth(), currentDate.getDay() + 1);
// Set series end date to one year from now.
seriesTimeObject.setEndDate(currentDate.getFullYear() + 1, currentDate.getMonth() + 1, currentDate.getDay());
// Set start time to 1:30 PM.
seriesTimeObject.setStartTime(13, 30);
// Set duration to 30 minutes.
seriesTimeObject.setDuration(30);

const pattern = {
  seriesTime: seriesTimeObject,
  recurrenceType: Office.MailboxEnums.RecurrenceType.Yearly,
  recurrenceProperties: {
    interval: 1,
    dayOfWeek: Office.MailboxEnums.Days.Tue,
    weekNumber: Office.MailboxEnums.WeekNumber.Second,
    month: Office.MailboxEnums.Month.Sep
  },
  recurrenceTimeZone: { name: Office.MailboxEnums.RecurrenceTimeZone.PacificStandardTime }
};

Office.context.mailbox.item.recurrence.setAsync(pattern as any, (asyncResult) => {
  if (asyncResult.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Failed to set recurrence. Error: ${asyncResult.error.message}`);
    return;
  }
  console.log(`Succeeded in setting recurrence pattern ${JSON.stringify(pattern)}`);
});

Методы

getDuration()	Возвращает длительность в минутах для обычного экземпляра в ряду повторяющихся встреч.
getEndDate()	Получает дату окончания шаблона повторения в следующем формате ISO 8601 : "ГГГГ-ММ-ДД".
getEndTime()	Получает время окончания обычного экземпляра шаблона повторения встречи или приглашения на собрание, в котором пользователь или надстройка установили шаблон повторения в следующем формате ISO 8601 : "THH:mm:ss:mmm".
getStartDate()	Возвращает дату начала шаблона повторения в следующем формате ISO 8601 : "ГГГГ-ММ-ДД".
getStartTime()	Получает время начала обычного экземпляра шаблона повторения встречи, в котором пользователь или надстройка установили шаблон повторения в следующем формате ISO 8601 : "THH:mm:ss:mmm".
setDuration(minutes)	Устанавливает продолжительность всех встреч в шаблоне повторений. Это также приведет к изменению времени окончания шаблона повторения.
setEndDate(year, month, day)	Устанавливает дату окончания ряда повторяющихся встреч.
setEndDate(date)	Устанавливает дату окончания ряда повторяющихся встреч.
setStartDate(year, month, day)	Задает дату начала ряда повторяющихся встреч.
setStartDate(date)	Задает дату начала ряда повторяющихся встреч.
setStartTime(hours, minutes)	Устанавливает время начала всех экземпляров ряда повторяющихся встреч в любом часовом поясе, настроенном шаблоном повторения (часовой пояс элемента используется по умолчанию).
setStartTime(time)	Устанавливает время начала всех экземпляров ряда повторяющихся встреч в любом часовом поясе, настроенном шаблоном повторения (часовой пояс элемента используется по умолчанию).

Сведения о методе

getDuration()

Возвращает длительность в минутах для обычного экземпляра в ряду повторяющихся встреч.

getDuration(): number;

Возвращаемое значение

number

Комментарии

Набор API: Почтовый ящик 1.7

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose или чтение

Примеры

// This example gets the duration of a usual instance in a recurring appointment series.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const duration = recurrence.seriesTime.getDuration();
}

getEndDate()

Получает дату окончания шаблона повторения в следующем формате ISO 8601 : "ГГГГ-ММ-ДД".

getEndDate(): string;

Возвращаемое значение

string

Комментарии

Набор API: Почтовый ящик 1.7

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose или чтение

Примеры

// This example gets the end date of a recurring appointment series.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const endDate = recurrence.seriesTime.getEndDate();
}

getEndTime()

Получает время окончания обычного экземпляра шаблона повторения встречи или приглашения на собрание, в котором пользователь или надстройка установили шаблон повторения в следующем формате ISO 8601 : "THH:mm:ss:mmm".

getEndTime(): string;

Возвращаемое значение

string

Комментарии

Набор API: Почтовый ящик 1.7

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose или чтение

Примеры

// This example gets the end time of a usual instance in a recurring appointment series.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const endDate = recurrence.seriesTime.getEndTime();
}

getStartDate()

Возвращает дату начала шаблона повторения в следующем формате ISO 8601 : "ГГГГ-ММ-ДД".

getStartDate(): string;

Возвращаемое значение

string

Комментарии

Набор API: Почтовый ящик 1.7

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose или чтение

Примеры

// This example gets the start date of a recurring appointment series.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const endDate = recurrence.seriesTime.getStartDate();
}

getStartTime()

Получает время начала обычного экземпляра шаблона повторения встречи, в котором пользователь или надстройка установили шаблон повторения в следующем формате ISO 8601 : "THH:mm:ss:mmm".

getStartTime(): string;

Возвращаемое значение

string

Комментарии

Набор API: Почтовый ящик 1.7

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose или чтение

Примеры

// This example gets the start time of a usual
// instance in a recurring appointment series.
const seriesTimeObject = new SeriesTime();
seriesTimeObject.setDuration(120);

setDuration(minutes)

Устанавливает продолжительность всех встреч в шаблоне повторений. Это также приведет к изменению времени окончания шаблона повторения.

setDuration(minutes: number): void;

Параметры

minutes

number

Продолжительность встречи в минутах.

Возвращаемое значение

void

Комментарии

Набор API: Почтовый ящик 1.7

Минимальный уровень разрешений: элемент для чтения и записи

Применимый режим Outlook: Compose

Примеры

// This example sets the duration of each appointment
// in a recurring series to 2 hours.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const endDate = recurrence.seriesTime.getStartTime();
}

setEndDate(year, month, day)

Устанавливает дату окончания ряда повторяющихся встреч.

setEndDate(year: number, month: number, day: number): void;

Параметры

year

number

Значение года конечной даты.

month

number

Значение месяца конечной даты. Допустимый диапазон: 0–11, где 0 соответствует первому месяцу, а 11 — 12-му месяцу.

day

number

Значение дня конечной даты.

Возвращаемое значение

void

Комментарии

Набор API: Почтовый ящик 1.7

Минимальный уровень разрешений: элемент для чтения и записи

Применимый режим Outlook: Compose

Примеры

// This example sets the end date of a recurring
// appointment series to November 2, 2017.
const seriesTimeObject = new SeriesTime();
seriesTimeObject.setEndDate(2017, 10, 2);

setEndDate(date)

Устанавливает дату окончания ряда повторяющихся встреч.

setEndDate(date: string): void;

Параметры

date

string

Дата окончания ряда повторяющихся встреч, представленная в формате даты ISO 8601 : "ГГГГ-ММ-ДД".

Возвращаемое значение

void

Комментарии

Набор API: Почтовый ящик 1.7

Минимальный уровень разрешений: элемент для чтения и записи

Применимый режим Outlook: Compose

Примеры

// This example sets the end date of a
// recurring appointment series to November 2, 2017
// using ISO 8601 date standard.
const seriesTimeObject = new SeriesTime()
seriesTimeObject.setEndDate("2017-11-02");

setStartDate(year, month, day)

Задает дату начала ряда повторяющихся встреч.

setStartDate(year:number, month:number, day:number): void;

Параметры

year

number

Значение года в дате начала.

month

number

Значение месяца в дате начала. Допустимый диапазон: 0–11, где 0 соответствует первому месяцу, а 11 — 12-му месяцу.

day

number

Значение дня в дате начала.

Возвращаемое значение

void

Комментарии

Набор API: Почтовый ящик 1.7

Минимальный уровень разрешений: элемент для чтения и записи

Применимый режим Outlook: Compose

Примеры

// This example sets the start date of a recurring
// appointment series to November 2, 2017.
const seriesTimeObject = new SeriesTime();
seriesTimeObject.setStartDate(2017, 10, 2);

setStartDate(date)

Задает дату начала ряда повторяющихся встреч.

setStartDate(date:string): void;

Параметры

date

string

Дата начала серии повторяющихся встреч, представленной в формате даты ISO 8601 : "ГГГГ-ММ-ДД".

Возвращаемое значение

void

Комментарии

Набор API: Почтовый ящик 1.7

Минимальный уровень разрешений: элемент для чтения и записи

Применимый режим Outlook: Compose

Примеры

// This example sets the start date of a recurring
// appointment series to November 2, 2017
// using ISO 8601 date standard.
const seriesTimeObject = new SeriesTime()
seriesTimeObject.setStartDate("2017-11-02");

setStartTime(hours, minutes)

Устанавливает время начала всех экземпляров ряда повторяющихся встреч в любом часовом поясе, настроенном шаблоном повторения (часовой пояс элемента используется по умолчанию).

setStartTime(hours: number, minutes: number): void;

Параметры

hours

number

Значение часа времени начала. Допустимый диапазон: 0-24.

minutes

number

Минутное значение времени начала. Допустимый диапазон: 0-59.

Возвращаемое значение

void

Комментарии

Набор API: Почтовый ящик 1.7

Минимальный уровень разрешений: элемент для чтения и записи

Применимый режим Outlook: Compose

Примеры

// This example sets the start time of each instance
// of a recurring appointment series to 1:30 PM.
const seriesTimeObject = new SeriesTime();
seriesTimeObject.setStartTime(13, 30);

// This example sets the start time of each instance
// of a recurring appointment series to 11:30 AM.
seriesTimeObject.setStartTime(11, 30);

setStartTime(time)

Устанавливает время начала всех экземпляров ряда повторяющихся встреч в любом часовом поясе, настроенном шаблоном повторения (часовой пояс элемента используется по умолчанию).

setStartTime(time: string): void;

Параметры

time

string

Время начала всех экземпляров, представленное стандартным строковым форматом datetime: "THH:mm:ss:mmm".

Возвращаемое значение

void

Комментарии

Набор API: Почтовый ящик 1.7

Минимальный уровень разрешений: элемент для чтения и записи

Применимый режим Outlook: Compose

Примеры

// This example sets the start time of each instance
// of a recurring appointment series to 11:30 PM.
const seriesTimeObject = new SeriesTime()
seriesTimeObject.setStartTime("T23:30:00");