Office.Subject interface
Предоставляет методы для получения и задания темы для встречи или сообщения в надстройке Outlook.
Комментарии
[ Набор API: Почтовый ящик 1.1 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose
Методы
get |
Получает тему встречи или сообщения. Метод |
get |
Получает тему встречи или сообщения. Метод |
set |
Задает тему встречи или сообщения. Метод |
set |
Задает тему встречи или сообщения. Метод |
Сведения о методе
getAsync(options, callback)
Получает тему встречи или сообщения.
Метод getAsync
выполняет асинхронный вызов на сервер Exchange Server, чтобы получить тему встречи или сообщения.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Параметры
- options
- Office.AsyncContextOptions
Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext
: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром типа Office.AsyncResult
. Свойство value
результата является субъектом элемента.
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.1 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose
getAsync(callback)
Получает тему встречи или сообщения.
Метод getAsync
выполняет асинхронный вызов на сервер Exchange Server, чтобы получить тему встречи или сообщения.
getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Параметры
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром типа Office.AsyncResult
. Свойство value
результата является субъектом элемента.
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.1 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose
Примеры
Office.context.mailbox.item.subject.getAsync(callback);
function callback(asyncResult) {
const subject = asyncResult.value;
}
setAsync(subject, options, callback)
Задает тему встречи или сообщения.
Метод setAsync
запускает асинхронный запрос на сервере Exchange Server, чтобы задать тему встречи или сообщения. При задании темы перезаписывается текущая тема, но сохраняются все префиксы, такие как "Fwd:" или "Re:".
setAsync(subject: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Параметры
- subject
-
string
Тема встречи или сообщения. Строка может содержать до 255 символов.
- options
- Office.AsyncContextOptions
Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext
: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Необязательный параметр. После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром типа Office.AsyncResult
. Если не удастся задать тему, свойство asyncResult.error
будет содержать код ошибки.
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.1 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose
Важно! В Outlook для Android и в iOS этот метод не поддерживается в режиме Compose сообщений. Поддерживается только режим организатора встреч. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Для Outlook, поддерживаемые в Outlook на мобильных устройствах.
Ошибки:
-
DataExceedsMaximumSize
: параметр subject имеет длину более 255 символов.
Примеры
Office.context.mailbox.item.subject.setAsync("New subject!", function (asyncResult) {
if (asyncResult.status === "failed") {
console.log("Action failed with error: " + asyncResult.error.message);
}
});
setAsync(subject, callback)
Задает тему встречи или сообщения.
Метод setAsync
запускает асинхронный запрос на сервере Exchange Server, чтобы задать тему встречи или сообщения. При задании темы перезаписывается текущая тема, но сохраняются все префиксы, такие как "Fwd:" или "Re:".
setAsync(subject: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Параметры
- subject
-
string
Тема встречи или сообщения. Строка может содержать до 255 символов.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Необязательный параметр. После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром типа Office.AsyncResult
. Если не удастся задать тему, свойство asyncResult.error
будет содержать код ошибки.
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.1 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose
Важно! В Outlook для Android и в iOS этот метод не поддерживается в режиме Compose сообщений. Поддерживается только режим организатора встреч. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Для Outlook, поддерживаемые в Outlook на мобильных устройствах.
Ошибки:
-
DataExceedsMaximumSize
: параметр subject имеет длину более 255 символов.
Office Add-ins