Compartilhar via

Office.EnhancedLocation interface

  • Referência
Pacote:
outlook

Representa o conjunto de locais em um compromisso.

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

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

Modo outlook aplicável: compor ou ler

Métodos

addAsync(locationIdentifiers, options, callback)

Adiciona ao conjunto de locais associados ao compromisso.
addAsync(locationIdentifiers, callback)

Adiciona ao conjunto de locais associados ao compromisso.
getAsync(options, callback)

Obtém o conjunto de locais associados ao compromisso.

Observação: grupos de contatos pessoais adicionados à medida que os locais de compromisso não são retornados por esse método.
getAsync(callback)

Obtém o conjunto de locais associados ao compromisso.

Observação: grupos de contatos pessoais adicionados à medida que os locais de compromisso não são retornados por esse método.
removeAsync(locationIdentifiers, options, callback)

Remove o conjunto de locais associados ao compromisso.

Se houver vários locais com o mesmo nome, todos os locais correspondentes serão removidos mesmo que apenas um tenha sido especificado em locationIdentifiers.
removeAsync(locationIdentifiers, callback)

Remove o conjunto de locais associados ao compromisso.

Se houver vários locais com o mesmo nome, todos os locais correspondentes serão removidos mesmo que apenas um tenha sido especificado em locationIdentifiers.

Detalhes do método

addAsync(locationIdentifiers, options, callback)

Adiciona ao conjunto de locais associados ao compromisso.

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

Parâmetros

locationIdentifiers

Office.LocationIdentifier[]

Os locais a serem adicionados à lista atual de locais.

options
Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto. Verifique a status propriedade de asyncResult para determinar se a chamada foi bem-sucedida.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

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

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 locais associados ao compromisso.

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

Parâmetros

locationIdentifiers

Office.LocationIdentifier[]

Os locais a serem adicionados à lista atual de locais.

callback

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto. Verifique a status propriedade de asyncResult para determinar se a chamada foi bem-sucedida.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

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

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 locais associados ao compromisso.

Observação: grupos de contatos pessoais adicionados à medida que os locais de compromisso não são retornados por esse método.

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 desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

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

Modo outlook aplicável: compor ou ler

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 locais associados ao compromisso.

Observação: grupos de contatos pessoais adicionados à medida que os locais de compromisso não são retornados por esse método.

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

Parâmetros

callback

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

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

Modo outlook aplicável: compor ou ler

removeAsync(locationIdentifiers, options, callback)

Remove o conjunto de locais associados ao compromisso.

Se houver vários locais com o mesmo nome, todos os locais correspondentes serão removidos mesmo que apenas um tenha sido especificado em locationIdentifiers.

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

Parâmetros

locationIdentifiers

Office.LocationIdentifier[]

Os locais a serem removidos da lista atual de locais.

options
Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto. Verifique a status propriedade de asyncResult para determinar se a chamada foi bem-sucedida.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

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

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 locais associados ao compromisso.

Se houver vários locais com o mesmo nome, todos os locais correspondentes serão removidos mesmo que apenas um tenha sido especificado em locationIdentifiers.

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

Parâmetros

locationIdentifiers

Office.LocationIdentifier[]

Os locais a serem removidos da lista atual de locais.

callback

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto. Verifique a status propriedade de asyncResult para determinar se a chamada foi bem-sucedida.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.8 ]

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

Modo outlook aplicável: compose