Compartilhar via

Office.EnhancedLocation interface

Pacote:
outlook

Representa o conjunto de localizações num compromisso.

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Compose ou Leitura

Importante: para gerir as localizações de um compromisso em clientes do Outlook que não suportam o requisito da Caixa de Correio definido como 1.8, utilize a API Office.Location. Para obter orientações sobre como selecionar a API de localização certa para o seu cenário, consulte Obter ou definir a localização ao compor um nome no Outlook.

Métodos

addAsync(locationIdentifiers, options, callback)

Adiciona ao conjunto de localizações associadas ao compromisso.
addAsync(locationIdentifiers, callback)

Adiciona ao conjunto de localizações associadas ao compromisso.
getAsync(options, callback)

Obtém o conjunto de localizações associadas ao compromisso.
getAsync(callback)

Obtém o conjunto de localizações associadas ao compromisso.
removeAsync(locationIdentifiers, options, callback)

Remove o conjunto de localizações associadas ao compromisso.

Se existirem várias localizações com o mesmo nome, todas as localizações correspondentes serão removidas mesmo que apenas uma tenha sido especificada em locationIdentifiers.
removeAsync(locationIdentifiers, callback)

Remove o conjunto de localizações associadas ao compromisso.

Se existirem várias localizações com o mesmo nome, todas as localizações correspondentes serão removidas mesmo que apenas uma tenha sido especificada em locationIdentifiers.

Detalhes do método

addAsync(locationIdentifiers, options, callback)

Adiciona ao conjunto de localizações associadas ao compromisso.

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

Parâmetros

locationIdentifiers

Office.LocationIdentifier[]

As localizações a adicionar à lista atual de localizações.

options
Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

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

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto. Verifique a status propriedade de asyncResult para determinar se a chamada foi efetuada com êxito.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Compose

Erros:

  • InvalidFormatError : o formato do objeto de dados especificado não é válido.

Exemplos

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

Adiciona ao conjunto de localizações associadas ao compromisso.

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

Parâmetros

locationIdentifiers

Office.LocationIdentifier[]

As localizações a adicionar à lista atual de localizações.

callback

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

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto. Verifique a status propriedade de asyncResult para determinar se a chamada foi efetuada com êxito.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Compose

Erros:

  • InvalidFormatError : o formato do objeto de dados especificado não é válido.

getAsync(options, callback)

Obtém o conjunto de localizações associadas ao compromisso.

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

Parâmetros

options
Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

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

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto. É devolvida uma matriz de Office.LocationDetails objetos que representam as localizações do compromisso na asyncResult.value propriedade .

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Compose ou Leitura

Importante:

  • O getAsync método não devolve grupos de contactos pessoais que foram adicionados ao campo Localização de um compromisso.

  • Se uma localização tiver sido adicionada com Office.context.mailbox.item.location.setAsync, o tipo de localização é Office.MailboxEnums.LocationType.Custom.

Exemplos

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

Obtém o conjunto de localizações associadas ao compromisso.

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

Parâmetros

callback

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

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto. É devolvida uma matriz de Office.LocationDetails objetos que representam as localizações do compromisso na asyncResult.value propriedade .

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Compose ou Leitura

Importante:

  • O getAsync método não devolve grupos de contactos pessoais que foram adicionados ao campo Localização de um compromisso.

  • Se uma localização tiver sido adicionada com Office.context.mailbox.item.location.setAsync, o tipo de localização é Office.MailboxEnums.LocationType.Custom.

removeAsync(locationIdentifiers, options, callback)

Remove o conjunto de localizações associadas ao compromisso.

Se existirem várias localizações com o mesmo nome, todas as localizações correspondentes serão removidas mesmo que apenas uma tenha sido especificada em locationIdentifiers.

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

Parâmetros

locationIdentifiers

Office.LocationIdentifier[]

As localizações a serem removidas da lista atual de localizações.

options
Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

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

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto. Verifique a status propriedade de asyncResult para determinar se a chamada foi efetuada com êxito.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Compose

Exemplos

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

Remove o conjunto de localizações associadas ao compromisso.

Se existirem várias localizações com o mesmo nome, todas as localizações correspondentes serão removidas mesmo que apenas uma tenha sido especificada em locationIdentifiers.

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

Parâmetros

locationIdentifiers

Office.LocationIdentifier[]

As localizações a serem removidas da lista atual de localizações.

callback

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

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto. Verifique a status propriedade de asyncResult para determinar se a chamada foi efetuada com êxito.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Compose