Office.Location interface
Предоставляет методы для получения и задания места собрания в надстройке Outlook.
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose
Важно! API Office.EnhancedLocation появился в наборе требований для почтовых ящиков 1.8. Используйте API EnhancedLocation для более точного определения расположений встреч и управления ими, особенно если необходимо определить тип расположения. Рекомендации по выбору правильного API расположения для вашего сценария см. в статье Получение или настройка расположения при создании назначения.
Используется
Методы
| get |
Получает место встречи. Метод |
| get |
Получает место встречи. Метод |
| set |
Задает место встречи. Метод |
| set |
Задает место встречи. Метод |
Сведения о методе
getAsync(options, callback)
Получает место встречи.
Метод getAsync выполняет асинхронный вызов на сервер Exchange, чтобы получить сведения о месте встречи. Место назначения указывается в виде строки в свойстве asyncResult.value .
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;Параметры
- options
- Office.AsyncContextOptions
Объектный литерал, содержащий одно или несколько из следующих свойств:- asyncContext: Разработчики могут предоставить любой объект, к которому они хотят получить доступ, в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
После завершения метода вызывается функция, переданная в параметре callback , с одним параметром типа Office.AsyncResult.
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose
Примеры
const userContext = { value : 1 };
Office.context.mailbox.item.location.getAsync( { context: userContext}, callback);
function callback(asyncResult) {
const context = asyncResult.context;
const location = asyncResult.value;
}
getAsync(callback)
Получает место встречи.
Метод getAsync выполняет асинхронный вызов на сервер Exchange, чтобы получить сведения о месте встречи. Место назначения указывается в виде строки в свойстве asyncResult.value .
getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;Параметры
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
После завершения метода вызывается функция, переданная в параметре callback , с одним параметром типа Office.AsyncResult.
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-location-appointment-organizer.yaml
Office.context.mailbox.item.location.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Appointment location: ${result.value}`);
});
setAsync(location, options, callback)
Задает место встречи.
Метод setAsync выполняет асинхронный вызов на сервер Exchange, чтобы задать место встречи. При задании места встречи перезаписывается текущее место.
setAsync(location: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Параметры
- location
-
string
Место встречи. Строка может содержать до 255 символов.
- options
- Office.AsyncContextOptions
Объектный литерал, содержащий одно или несколько из следующих свойств:- asyncContext: Разработчики могут предоставить любой объект, к которому они хотят получить доступ, в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Необязательный параметр. После завершения метода вызывается функция, переданная в параметре callback , с одним параметром типа Office.AsyncResult. Если не удастся задать место, свойство asyncResult.error будет содержать код ошибки.
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose
Важно! Чтобы в Outlook было правильно разрешается несколько расположений, разделяйте их точкой с запятой и пробелом. Например, "Конференц-зал 1; Конференц-зал 2".
Ошибки:
- DataExceedsMaximumSize: параметр местоположения длиннее 255 символов.
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-location-appointment-organizer.yaml
const location = "my office";
Office.context.mailbox.item.location.setAsync(location, (result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Successfully set location to ${location}`);
});
setAsync(location, callback)
Задает место встречи.
Метод setAsync выполняет асинхронный вызов на сервер Exchange, чтобы задать место встречи. При задании места встречи перезаписывается текущее место.
setAsync(location: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Параметры
- location
-
string
Место встречи. Строка может содержать до 255 символов.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Необязательный параметр. После завершения метода вызывается функция, переданная в параметре callback , с одним параметром типа Office.AsyncResult. Если не удастся задать место, свойство asyncResult.error будет содержать код ошибки.
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose
Важно! Чтобы в Outlook было правильно разрешается несколько расположений, разделяйте их точкой с запятой и пробелом. Например, "Конференц-зал 1; Конференц-зал 2".
Ошибки:
- DataExceedsMaximumSize: параметр местоположения длиннее 255 символов.