Office.SeriesTime interface

Пакет:

outlook

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

Комментарии

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

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

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

Методы

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 представляет 1-й месяц, а 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 представляет 1-й месяц, а 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

Время начала всех экземпляров, представленных в стандартном строковом формате даты и времени: "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");