Office.Recurrence interface

Пакет:: outlook

Объект Recurrence предоставляет методы для получения и задания шаблона повторения встреч, но получает только шаблон повторения запросов на собрания. Он будет иметь словарь со следующими ключами: seriesTime, recurrenceType, recurrencePropertiesи recurrenceTimeZone (необязательно).

Состояние	Редактируемые?	Просмотра?
Организатор встреч — серия Compose	Да (setAsync)	Да (getAsync)
Организатор встреч — экземпляр Compose	Нет (setAsync возвращает ошибку)	Да (getAsync)
Участник встречи — чтение серии	Нет (setAsync недоступен)	Да (item.recurrence)
Участник встречи — экземпляр чтения	Нет (setAsync недоступен)	Да (item.recurrence)
Приглашение на собрание — серию чтения	Нет (setAsync недоступен)	Да (item.recurrence)
Запрос на собрание — чтение экземпляра	Нет (setAsync недоступен)	Да (item.recurrence)

Свойства

recurrenceProperties	Возвращает или задает свойства повторяющегося ряда встреч.
recurrenceTimeZone	Возвращает или задает свойства повторяющегося ряда встреч.
recurrenceType	Возвращает или задает тип повторяющегося ряда встреч.
seriesTime	Объект SeriesTime позволяет управлять датами начала и окончания повторяющихся рядов встреч, а также обычным временем начала и окончания экземпляров. Этот объект не находится в формате UTC. Вместо этого он задается в часовом поясе, указанном значением `recurrenceTimeZone` или часовом поясе элемента по умолчанию.

Методы

getAsync(options, callback)	Возвращает текущий объект повторения ряда встреч. Этот метод возвращает весь `Recurrence` объект для ряда встреч.
getAsync(callback)	Возвращает текущий объект повторения ряда встреч. Этот метод возвращает весь `Recurrence` объект для ряда встреч.
setAsync(recurrencePattern, options, callback)	Задает шаблон повторения ряда встреч.
setAsync(recurrencePattern, callback)	Задает шаблон повторения ряда встреч.

Сведения о свойстве

recurrenceProperties

Возвращает или задает свойства повторяющегося ряда встреч.

recurrenceProperties?: RecurrenceProperties;

Значение свойства

Office.RecurrenceProperties

recurrenceTimeZone

Возвращает или задает свойства повторяющегося ряда встреч.

recurrenceTimeZone?: RecurrenceTimeZone;

Значение свойства

Office.RecurrenceTimeZone

recurrenceType

Возвращает или задает тип повторяющегося ряда встреч.

recurrenceType: MailboxEnums.RecurrenceType | string;

Значение свойства

Office.MailboxEnums.RecurrenceType | string

seriesTime

Объект SeriesTime позволяет управлять датами начала и окончания повторяющихся рядов встреч, а также обычным временем начала и окончания экземпляров. Этот объект не находится в формате UTC. Вместо этого он задается в часовом поясе, указанном значением recurrenceTimeZone или часовом поясе элемента по умолчанию.

seriesTime: SeriesTime;

Значение свойства

Office.SeriesTime

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

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

Примеры

// 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

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

void

setAsync(recurrencePattern, options, callback)

Задает шаблон повторения ряда встреч.

setAsync(recurrencePattern: Recurrence, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

recurrencePattern: Office.Recurrence

Объект повторения.

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<void>) => void

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

void

setAsync доступно только для элементов ряда, но не для элементов экземпляров.
Метод setAsync не поддерживается в сообщении, загруженном с помощью loadItemByIdAsync метода . Дополнительные сведения см. в разделе Активация надстройки Outlook для нескольких сообщений.

Ошибки:

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(recurrencePattern: Recurrence, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

recurrencePattern: Office.Recurrence

Объект повторения.

callback: (asyncResult: Office.AsyncResult<void>) => void

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

void

setAsync доступно только для элементов ряда, но не для элементов экземпляров.
Метод setAsync не поддерживается в сообщении, загруженном с помощью loadItemByIdAsync метода . Дополнительные сведения см. в разделе Активация надстройки Outlook для нескольких сообщений.

Ошибки:

InvalidEndTime : время окончания встречи до времени начала.

Обратная связь

Были ли сведения на этой странице полезными?

Поделиться через

Комментарии

Свойства

Методы

recurrenceProperties

Значение свойства

Комментарии

recurrenceTimeZone

Значение свойства

Комментарии

recurrenceType

Значение свойства

Комментарии

seriesTime

Значение свойства

Комментарии

getAsync(options, callback)

Параметры

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

Комментарии

Примеры

getAsync(callback)

Параметры

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

Комментарии

setAsync(recurrencePattern, options, callback)

Параметры

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

Комментарии

Примеры

setAsync(recurrencePattern, callback)

Параметры

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

Комментарии