Office.EnhancedLocation interface

Представляет набор расположений на встрече.

Важно! Для управления расположениями встреч в клиентах Outlook, которые не поддерживают набор требований к почтовому ящику 1.8, используйте API Office.Location. Рекомендации по выбору правильного API расположения для вашего сценария см. в статье Получение или настройка расположения при создании назначения.

Используется

Методы

addAsync(locationIdentifiers, options, callback)	Добавляет к набору расположений, связанных со встречей.
addAsync(locationIdentifiers, callback)	Добавляет к набору расположений, связанных со встречей.
getAsync(options, callback)	Получает набор расположений, связанных со встречей.
getAsync(callback)	Получает набор расположений, связанных со встречей.
removeAsync(locationIdentifiers, options, callback)	Удаляет набор расположений, связанных со встречей. Если существует несколько местоположений с одинаковыми именами, все совпадающие расположения будут удалены, даже если только одно из них было указано в `locationIdentifiers`.
removeAsync(locationIdentifiers, callback)	Удаляет набор расположений, связанных со встречей. Если существует несколько местоположений с одинаковыми именами, все совпадающие расположения будут удалены, даже если только одно из них было указано в `locationIdentifiers`.

addAsync(locationIdentifiers, options, callback)

Добавляет к набору расположений, связанных со встречей.

addAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

locationIdentifiers: Office.LocationIdentifier[]

Местоположения, добавляемые в текущий список местоположений.

options: Office.AsyncContextOptions

Объектный литерал, содержащий одно или несколько из следующих свойств:- asyncContext: Разработчики могут предоставить любой объект, к которому они хотят получить доступ, в функции обратного вызова.

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

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

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

void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-add-remove-enhancedlocation-appointment.yaml

const locations = [
  {
    id: "Contoso",
    type: Office.MailboxEnums.LocationType.Custom
  },
  {
    id: "room500@test.com",
    type: Office.MailboxEnums.LocationType.Room
  }
];
Office.context.mailbox.item.enhancedLocation.addAsync(locations, (result) => {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log(`Successfully added locations ${JSON.stringify(locations)}`);
  } else {
    console.error(`Failed to add locations. Error message: ${result.error.message}`);
  }
});

addAsync(locationIdentifiers, callback)

Добавляет к набору расположений, связанных со встречей.

addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

locationIdentifiers: Office.LocationIdentifier[]

Местоположения, добавляемые в текущий список местоположений.

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

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

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

void

getAsync(options, callback)

Получает набор расположений, связанных со встречей.

getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => void): void;

Параметры

options: Office.AsyncContextOptions

Объектный литерал, содержащий одно или несколько из следующих свойств:- asyncContext: Разработчики могут предоставить любой объект, к которому они хотят получить доступ, в функции обратного вызова.

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

Необязательный параметр. Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult . Массив Office.LocationDetails объектов, представляющих местоположения встречи, возвращается в свойстве.asyncResult.value

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

void

Метод getAsync не возвращает личные группы контактов , добавленные в поле "Место" встречи.
Если расположение было добавлено с помощью Office.context.mailbox.item.location.setAsync, его тип расположения — Office.MailboxEnums.LocationType.Custom.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-add-remove-enhancedlocation-appointment.yaml

Office.context.mailbox.item.enhancedLocation.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Failed to get locations. Error message: ${result.error.message}`);
    return;
  }
  const places = result.value;
  if (places && places.length > 0) {
    result.value.forEach(function(place) {
      console.log(`Location: ${place.displayName} (type: ${place.locationIdentifier.type})`);
      if (place.locationIdentifier.type === Office.MailboxEnums.LocationType.Room) {
        console.log("Email address: " + place.emailAddress);
      }
    });
  } else {
    console.log("There are no locations.");
  }
});

getAsync(callback)

Получает набор расположений, связанных со встречей.

getAsync(callback?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => void): void;

Параметры

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

Необязательный параметр. Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult . Массив Office.LocationDetails объектов, представляющих местоположения встречи, возвращается в свойстве.asyncResult.value

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

void

Метод getAsync не возвращает личные группы контактов , добавленные в поле "Место" встречи.
Если расположение было добавлено с помощью Office.context.mailbox.item.location.setAsync, его тип расположения — Office.MailboxEnums.LocationType.Custom.

removeAsync(locationIdentifiers, options, callback)

Удаляет набор расположений, связанных со встречей.

Если существует несколько местоположений с одинаковыми именами, все совпадающие расположения будут удалены, даже если только одно из них было указано в locationIdentifiers.

removeAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

locationIdentifiers: Office.LocationIdentifier[]

Расположения, которые нужно удалить из текущего списка расположений.

options: Office.AsyncContextOptions

Объектный литерал, содержащий одно или несколько из следующих свойств:- asyncContext: Разработчики могут предоставить любой объект, к которому они хотят получить доступ, в функции обратного вызова.

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

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

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

void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-add-remove-enhancedlocation-appointment.yaml

const locations = [
  {
    id: "Contoso",
    type: Office.MailboxEnums.LocationType.Custom
  },
  {
    id: "room500@test.com",
    type: Office.MailboxEnums.LocationType.Room
  }
];
Office.context.mailbox.item.enhancedLocation.removeAsync(locations, (result) => {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log(`Successfully removed locations ${JSON.stringify(locations)}`);
  } else {
    console.error(`Failed to remove locations. Error message: ${result.error.message}`);
  }
});

removeAsync(locationIdentifiers, callback)

Удаляет набор расположений, связанных со встречей.

Если существует несколько местоположений с одинаковыми именами, все совпадающие расположения будут удалены, даже если только одно из них было указано в locationIdentifiers.

removeAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

locationIdentifiers: Office.LocationIdentifier[]

Расположения, которые нужно удалить из текущего списка расположений.

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

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

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

void

Комментарии

Используется

Методы

addAsync(locationIdentifiers, options, callback)

Параметры

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

Комментарии

Примеры

addAsync(locationIdentifiers, callback)

Параметры

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

Комментарии

getAsync(options, callback)

Параметры

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

Комментарии

Примеры

getAsync(callback)

Параметры

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

Комментарии

removeAsync(locationIdentifiers, options, callback)

Параметры

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

Комментарии

Примеры

removeAsync(locationIdentifiers, callback)

Параметры

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

Комментарии

Комментарии

Используется

Методы

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

addAsync(locationIdentifiers, options, callback)

Параметры

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

Комментарии

Примеры

addAsync(locationIdentifiers, callback)

Параметры

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

Комментарии

getAsync(options, callback)

Параметры

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

Комментарии

Примеры

getAsync(callback)

Параметры

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

Комментарии

removeAsync(locationIdentifiers, options, callback)

Параметры

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

Комментарии

Примеры

removeAsync(locationIdentifiers, callback)

Параметры

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

Комментарии

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