Office.Recurrence interface

Пакет:

outlook

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

Комментарии

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

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

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

Состояния

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

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

• Office.AppointmentCompose: повторение
• Office.AppointmentRead: повторение
• Office.LoadedMessageRead: повторение
• Office.MessageRead: повторение
• Office.RecurrenceChangedEventArgs: повторение

Свойства

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

Комментарии

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

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

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

recurrenceTimeZone

Получает или задает свойства ряда повторяющихся встреч.

recurrenceTimeZone?: RecurrenceTimeZone;

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

Office.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;

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

Office.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 , вызывается с единственным параметром, asyncResultкоторый является объектом Office.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 , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult . Свойством value результата является объект.Recurrence

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

void

Комментарии

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

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

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

setAsync(recurrencePattern, options, callback)

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

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 , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult .

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

void

Комментарии

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

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

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

Важно!

• 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 = {
  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)}`);
});

setAsync(recurrencePattern, callback)

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

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

Параметры

recurrencePattern

Office.Recurrence

Повторяющийся объект.

callback

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

Необязательный параметр. Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult .

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

void

Комментарии

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

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

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

Важно!

• setAsync доступно только для элементов рядов, но не для экземпляров.

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

Ошибки:

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