Office.Recurrence interface
Объект Recurrence
предоставляет методы для получения и задания шаблона повторения встреч, но получает только шаблон повторения запросов на собрания. Он будет иметь словарь со следующими ключами: seriesTime
, recurrenceType
, recurrenceProperties
и recurrenceTimeZone
(необязательно).
Комментарии
[ Набор API: Почтовый ящик 1.7 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose или чтение
Состояния
Состояние | Редактируемые? | Просмотра? |
---|---|---|
Организатор встреч — серия Compose | Да (setAsync) | Да (getAsync) |
Организатор встреч — экземпляр Compose | Нет (setAsync возвращает ошибку) | Да (getAsync) |
Участник встречи — чтение серии | Нет (setAsync недоступен) | Да (item.recurrence) |
Участник встречи — экземпляр чтения | Нет (setAsync недоступен) | Да (item.recurrence) |
Приглашение на собрание — серию чтения | Нет (setAsync недоступен) | Да (item.recurrence) |
Запрос на собрание — чтение экземпляра | Нет (setAsync недоступен) | Да (item.recurrence) |
Свойства
recurrence |
Возвращает или задает свойства повторяющегося ряда встреч. |
recurrence |
Возвращает или задает свойства повторяющегося ряда встреч. |
recurrence |
Возвращает или задает тип повторяющегося ряда встреч. |
series |
Объект SeriesTime позволяет управлять датами начала и окончания повторяющихся рядов встреч, а также обычным временем начала и окончания экземпляров. Этот объект не находится в формате UTC. Вместо этого он задается в часовом поясе, указанном значением |
Методы
get |
Возвращает текущий объект повторения ряда встреч. Этот метод возвращает весь |
get |
Возвращает текущий объект повторения ряда встреч. Этот метод возвращает весь |
set |
Задает шаблон повторения ряда встреч.
Примечание. |
set |
Задает шаблон повторения ряда встреч.
Примечание. |
Сведения о свойстве
recurrenceProperties
Возвращает или задает свойства повторяющегося ряда встреч.
recurrenceProperties?: RecurrenceProperties;
Значение свойства
Комментарии
[ Набор API: Почтовый ящик 1.7 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose или чтение
recurrenceTimeZone
Возвращает или задает свойства повторяющегося ряда встреч.
recurrenceTimeZone?: RecurrenceTimeZone;
Значение свойства
Комментарии
[ Набор API: Почтовый ящик 1.7 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose или чтение
recurrenceType
Возвращает или задает тип повторяющегося ряда встреч.
recurrenceType: MailboxEnums.RecurrenceType | string;
Значение свойства
Office.MailboxEnums.RecurrenceType | string
Комментарии
[ Набор API: Почтовый ящик 1.7 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose или чтение
seriesTime
Объект SeriesTime позволяет управлять датами начала и окончания повторяющихся рядов встреч, а также обычным временем начала и окончания экземпляров. Этот объект не находится в формате UTC. Вместо этого он задается в часовом поясе, указанном значением recurrenceTimeZone
или часовом поясе элемента по умолчанию.
seriesTime: SeriesTime;
Значение свойства
Комментарии
[ Набор API: Почтовый ящик 1.7 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose или чтение
Сведения о методе
getAsync(options, callback)
Возвращает текущий объект повторения ряда встреч.
Этот метод возвращает весь Recurrence
объект для ряда встреч.
getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Recurrence>) => void): void;
Параметры
- options
- Office.AsyncContextOptions
Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext
: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<Office.Recurrence>) => void
Необязательный параметр. После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром Office.AsyncResult
, asyncResult
который является объектом . Свойство value
результата — объект Recurrence
.
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.7 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose или чтение
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-set-recurrence-appointment-organizer.yaml
Office.context.mailbox.item.recurrence.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const recurrence = asyncResult.value;
if (recurrence === null) {
console.log("This is a single appointment.");
} else {
console.log(`Recurrence pattern: ${JSON.stringify(recurrence)}`);
}
} else {
console.error(asyncResult.error);
}
});
getAsync(callback)
Возвращает текущий объект повторения ряда встреч.
Этот метод возвращает весь Recurrence
объект для ряда встреч.
getAsync(callback?: (asyncResult: Office.AsyncResult<Recurrence>) => void): void;
Параметры
- callback
-
(asyncResult: Office.AsyncResult<Office.Recurrence>) => void
Необязательный параметр. После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром Office.AsyncResult
, asyncResult
который является объектом . Свойство value
результата — объект Recurrence
.
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.7 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose или чтение
setAsync(recurrencePattern, options, callback)
Задает шаблон повторения ряда встреч.
Примечание. setAsync
Должен быть доступен только для элементов ряда, но не для элементов экземпляров.
setAsync(recurrencePattern: Recurrence, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Параметры
- recurrencePattern
- Office.Recurrence
Объект повторения.
- options
- Office.AsyncContextOptions
Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext
: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Необязательный параметр. После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром Office.AsyncResult
, asyncResult
который является объектом .
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.7 ]
Минимальный уровень разрешений: чтение и запись элемента
Применимый режим Outlook: Compose
Ошибки:
-
InvalidEndTime
: время окончания встречи до времени начала.
Примеры
// 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: Office.Recurrence = {
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, (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)}`);
});
setAsync(recurrencePattern, callback)
Задает шаблон повторения ряда встреч.
Примечание. setAsync
Должен быть доступен только для элементов ряда, но не для элементов экземпляров.
setAsync(recurrencePattern: Recurrence, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Параметры
- recurrencePattern
- Office.Recurrence
Объект повторения.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Необязательный параметр. После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром Office.AsyncResult
, asyncResult
который является объектом .
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.7 ]
Минимальный уровень разрешений: чтение и запись элемента
Применимый режим Outlook: Compose
Ошибки:
-
InvalidEndTime
: время окончания встречи до времени начала.
Office Add-ins