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


Office.EnhancedLocation interface

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

Комментарии

[ Набор API: Почтовый ящик 1.8 ]

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose или чтение

Методы

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 параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом . status Проверьте свойство , asyncResult чтобы определить, выполнен ли вызов успешно.

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

void

Комментарии

[ Набор API: Почтовый ящик 1.8 ]

Минимальный уровень разрешений: чтение и запись элемента

Применимый режим Outlook: Compose

Ошибки:

  • InvalidFormatError : недопустимый формат указанного объекта данных.

Примеры

// 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 параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом . status Проверьте свойство , asyncResult чтобы определить, выполнен ли вызов успешно.

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

void

Комментарии

[ Набор API: Почтовый ящик 1.8 ]

Минимальный уровень разрешений: чтение и запись элемента

Применимый режим Outlook: Compose

Ошибки:

  • InvalidFormatError : недопустимый формат указанного объекта данных.

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 параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом .

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

void

Комментарии

[ Набор API: Почтовый ящик 1.8 ]

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose или чтение

Примеры

// 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 параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом .

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

void

Комментарии

[ Набор API: Почтовый ящик 1.8 ]

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose или чтение

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 параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом . status Проверьте свойство , asyncResult чтобы определить, выполнен ли вызов успешно.

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

void

Комментарии

[ Набор API: Почтовый ящик 1.8 ]

Минимальный уровень разрешений: чтение и запись элемента

Применимый режим Outlook: Compose

Примеры

// 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 параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом . status Проверьте свойство , asyncResult чтобы определить, выполнен ли вызов успешно.

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

void

Комментарии

[ Набор API: Почтовый ящик 1.8 ]

Минимальный уровень разрешений: чтение и запись элемента

Применимый режим Outlook: Compose