item (набор обязательных для почтового ящика 1.8)
Office.context.mailbox.item
item используется для доступа к выбранному сообщению, приглашения на собрание или встречи. Тип элемента можно определить с помощью itemType свойства .
Требования
| Требование | Значение |
|---|---|
| Версия минимального набора требований к почтовому ящику | 1.1 |
| Минимальный уровень разрешений | ограниченный |
| Применимый режим Outlook | Организатор встречи, участник встречи, Compose сообщения или Чтение сообщений |
Важно!
Android и iOS. Существуют ограничения на то, когда надстройки активируются и какие API доступны. Дополнительные сведения см. в статье Добавление поддержки мобильных устройств в надстройку Outlook.
Свойства
Методы
| Метод | Minimum уровень разрешения |
Сведения по режиму | Minimum набор обязательных требований |
|---|---|---|---|
| addFileAttachmentAsync(uri, attachmentName, [options], [callback]) | чтение и запись элемента | Организатор встреч |
1.1 (классическая версия Windows, Mac) 1.8 (Интернет, новая Windows) |
| Создание сообщения |
1.1 (классическая версия Windows, Mac) 1.8 (Интернет, новая Windows) |
||
| addFileAttachmentFromBase64Async(base64File, attachmentName, [options], [callback]) | чтение и запись элемента | Организатор встреч | 1.8 |
| Создание сообщения | 1.8 | ||
| addHandlerAsync(eventType, handler, [options], [callback]) | чтение элемента | Организатор встреч | 1.7 |
| Участник встречи | 1.7 | ||
| Создание сообщения | 1.7 | ||
| Чтение сообщения | 1.7 | ||
| addItemAttachmentAsync(itemId, attachmentName, [options], [callback]) | чтение и запись элемента | Организатор встреч | 1.1 |
| Создание сообщения | 1.1 | ||
| close() | ограниченный | Организатор встреч | 1.3 |
| Создание сообщения | 1.3 | ||
| displayReplyAllForm(formData) | чтение элемента | Участник встречи | 1.1 |
| Чтение сообщения | 1.1 | ||
| displayReplyForm(formData) | чтение элемента | Участник встречи | 1.1 |
| Чтение сообщения | 1.1 | ||
| getAllInternetHeadersAsync([options], [callback]) | чтение элемента | Чтение сообщения | 1.8 |
| getAttachmentContentAsync(attachmentId, [options], [callback]) | чтение элемента | Организатор встреч | 1.8 |
| Участник встречи | 1.8 | ||
| Создание сообщения | 1.8 | ||
| Чтение сообщения | 1.8 | ||
| getAttachmentsAsync([options], [callback]) | чтение элемента | Организатор встреч | 1.8 |
| Создание сообщения | 1.8 | ||
| getEntities() (не рекомендуется) | чтение элемента | Участник встречи | 1.1 |
| Чтение сообщения | 1.1 | ||
| getEntitiesByType(entityType) (не рекомендуется) | ограниченный | Участник встречи | 1.1 |
| Чтение сообщения | 1.1 | ||
| getFilteredEntitiesByName(name) (не рекомендуется) | чтение элемента | Участник встречи | 1.1 |
| Чтение сообщения | 1.1 | ||
| getInitializationContextAsync([options], [callback]) | чтение элемента | Организатор встреч | 1.8 |
| Участник встречи | 1.8 | ||
| Создание сообщения | 1.8 | ||
| Чтение сообщения | 1.8 | ||
| getItemIdAsync([options], обратный вызов) | чтение элемента | Организатор встреч | 1.8 |
| Создание сообщения | 1.8 | ||
| getRegExMatches() | чтение элемента | Участник встречи | 1.1 |
| Чтение сообщения | 1.1 | ||
| getRegExMatchesByName(name) | чтение элемента | Участник встречи | 1.1 |
| Чтение сообщения | 1.1 | ||
| getSelectedDataAsync(coercionType, [options], обратный вызов) | чтение элемента | Организатор встреч | 1.2 |
| Создание сообщения | 1.2 | ||
| getSelectedEntities() (не рекомендуется) | чтение элемента | Участник встречи | 1.6 |
| Чтение сообщения | 1.6 | ||
| getSelectedRegExMatches() | чтение элемента | Участник встречи | 1.6 |
| Чтение сообщения | 1.6 | ||
| getSharedPropertiesAsync([options], обратный вызов) | чтение элемента | Организатор встреч | 1.8 |
| Участник встречи | 1.8 | ||
| Создание сообщения | 1.8 | ||
| Чтение сообщения | 1.8 | ||
| loadCustomPropertiesAsync(callback, [userContext]) | чтение элемента | Организатор встреч | 1.1 |
| Участник встречи | 1.1 | ||
| Создание сообщения | 1.1 | ||
| Чтение сообщения | 1.1 | ||
| removeAttachmentAsync(attachmentId, [options], [callback]) | чтение и запись элемента | Организатор встреч | 1.1 |
| Создание сообщения | 1.1 | ||
| removeHandlerAsync(eventType, [options], [callback]) | чтение элемента | Организатор встреч | 1.7 |
| Участник встречи | 1.7 | ||
| Создание сообщения | 1.7 | ||
| Чтение сообщения | 1.7 | ||
| saveAsync([options], callback) | чтение и запись элемента | Организатор встреч | 1.3 |
| Создание сообщения | 1.3 | ||
| setSelectedDataAsync(data, [options], callback) | чтение и запись элемента | Организатор встреч | 1.2 |
| Создание сообщения | 1.2 |
События
Вы можете подписаться на следующие события и отменить подписку с помощью addHandlerAsync и removeHandlerAsync соответственно.
Важно!
События доступны только в реализации области задач.
| Событие | Описание | Minimum набор обязательных требований |
|---|---|---|
AppointmentTimeChanged |
Дата или время выбранной встречи или ряда изменились. | 1.7 |
AttachmentsChanged |
Вложение добавлено в элемент или удалено из него. | 1.8 |
EnhancedLocationsChanged |
Расположение выбранной встречи изменилось. | 1.8 |
RecipientsChanged |
Список получателей выбранного элемента или расположения встречи изменился. | 1.7 |
RecurrenceChanged |
Шаблон повторения выбранного ряда изменился. | 1.7 |
Пример
В примере кода JavaScript, приведенном ниже, показано, как получить доступ к свойству subject текущего элемента в Outlook.
// The initialize function is required for all apps.
Office.initialize = function () {
// Checks for the DOM to load using the jQuery ready method.
$(document).ready(function () {
// After the DOM is loaded, app-specific code can run.
const item = Office.context.mailbox.item;
const subject = item.subject;
// Continue with processing the subject of the current item,
// which can be a message or appointment.
});
};
Совместная работа с нами на GitHub
Источник этого содержимого можно найти на GitHub, где также можно создавать и просматривать проблемы и запросы на вытягивание. Дополнительные сведения см. в нашем руководстве для участников.
Office Add-ins