Office.IsAllDayEvent interface
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Предоставляет методы для получения и задания состояния события в течение всего дня собрания в надстройке Outlook.
Комментарии
[ Набор API: предварительная версия почтового ящика ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose
Методы
| get |
Возвращает логическое значение, указывающее, является ли событие целым днем. |
| get |
Возвращает логическое значение, указывающее, является ли событие целым днем. |
| set |
Задает состояние события в течение всего дня встречи. |
| set |
Задает состояние события в течение всего дня встречи. |
Сведения о методе
getAsync(options, callback)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает логическое значение, указывающее, является ли событие целым днем.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;Параметры
- options
- Office.AsyncContextOptions
Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<boolean>) => void
После завершения метода функция, переданная в callback параметре, вызывается с одним параметром типа Office.AsyncResult.
Возвращаемое значение
void
Комментарии
[ Набор API: предварительная версия почтового ящика ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose
getAsync(callback)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает логическое значение, указывающее, является ли событие целым днем.
getAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;Параметры
- callback
-
(asyncResult: Office.AsyncResult<boolean>) => void
После завершения метода функция, переданная в callback параметре, вызывается с одним параметром типа Office.AsyncResult.
Возвращаемое значение
void
Комментарии
[ Набор API: предварительная версия почтового ящика ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-set-isalldayevent.yaml
Office.context.mailbox.item.isAllDayEvent.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log("Is this an all-day event? " + asyncResult.value);
} else {
console.log("Failed to get if this is an all-day event. Error: " + JSON.stringify(asyncResult.error));
}
});
setAsync(isAllDayEvent, options, callback)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Задает состояние события в течение всего дня встречи.
setAsync(isAllDayEvent: boolean, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Параметры
- isAllDayEvent
-
boolean
логическое значение для задания состояния события в течение всего дня.
- options
- Office.AsyncContextOptions
Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Необязательный параметр. После завершения метода функция, переданная в callback параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом .
Возвращаемое значение
void
Комментарии
[ Набор API: предварительная версия почтового ящика ]
Если встреча помечается как событие на весь день: время начала и окончания будет помечено как 12:00 (как в пользовательском интерфейсе Outlook). Время начала вернется в 12:00, а время окончания будет 12:00 на следующий день.
Минимальный уровень разрешений: чтение и запись элемента
Применимый режим Outlook: Compose
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-set-isalldayevent.yaml
Office.context.mailbox.item.isAllDayEvent.setAsync(true, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Failed) {
console.log("Failed to set all-day event: " + JSON.stringify(asyncResult.error));
} else {
console.log("Appointment set to all-day event.");
}
});
setAsync(isAllDayEvent, callback)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Задает состояние события в течение всего дня встречи.
setAsync(isAllDayEvent: boolean, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Параметры
- isAllDayEvent
-
boolean
логическое значение для задания состояния события в течение всего дня.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Необязательный параметр. После завершения метода функция, переданная в callback параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом .
Возвращаемое значение
void
Комментарии
[ Набор API: предварительная версия почтового ящика ]
Если встреча помечается как событие на весь день: время начала и окончания будет помечено как 12:00 (как в пользовательском интерфейсе Outlook). Время начала вернется в 12:00, а время окончания будет 12:00 на следующий день.
Минимальный уровень разрешений: чтение и запись элемента
Применимый режим Outlook: Compose
Office Add-ins