Office.Location interface

Пакет:: outlook

Предоставляет методы для получения и задания места собрания в надстройке Outlook.

Важно! API Office.EnhancedLocation появился в наборе обязательных почтовых ящиков 1.8. Используйте API EnhancedLocation для более эффективного определения расположений встреч и управления ими, особенно если вам нужно определить тип расположения. Рекомендации по выбору ПРАВИЛЬНОго API расположения для вашего сценария см. в статье Получение или установка расположения при создании назначенного в Outlook.

Методы

getAsync(options, callback)	Получает место встречи. Метод `getAsync` выполняет асинхронный вызов на сервер Exchange, чтобы получить сведения о месте встречи. Расположение встречи предоставляется в виде строки в свойстве `asyncResult.value` .
getAsync(callback)	Получает место встречи. Метод `getAsync` выполняет асинхронный вызов на сервер Exchange, чтобы получить сведения о месте встречи. Расположение встречи предоставляется в виде строки в свойстве `asyncResult.value` .
setAsync(location, options, callback)	Задает место встречи. Метод `setAsync` выполняет асинхронный вызов на сервер Exchange, чтобы задать место встречи. При задании места встречи перезаписывается текущее место.
setAsync(location, callback)	Задает место встречи. Метод `setAsync` выполняет асинхронный вызов на сервер Exchange, чтобы задать место встречи. При задании места встречи перезаписывается текущее место.

Сведения о методе

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

Примеры

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(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Параметры

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

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

void

Примеры

// 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

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

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

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

void

Важно! Чтобы обеспечить правильное разрешение нескольких расположений в Outlook, разделите их точкой с запятой и пробелом. Например, "Конференц-зал 1; Конференц-зал 2".

Ошибки:

DataExceedsMaximumSize: параметр location длиннее 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(location: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

location: string

Место встречи. Строка может содержать до 255 символов.

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

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

void

Обратная связь

Была ли эта страница полезна?

Поделиться через

Комментарии

Методы

getAsync(options, callback)

Параметры

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

Комментарии

Примеры

getAsync(callback)

Параметры

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

Комментарии

Примеры

setAsync(location, options, callback)

Параметры

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

Комментарии

Примеры

setAsync(location, callback)

Параметры

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

Комментарии