Office.Location interface

  • Referência
Pacote:
outlook

Fornece métodos para obter e definir o local de uma reunião em um suplemento do Outlook.

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compose

Métodos

getAsync(options, callback)

Obtém o local de um compromisso.

O método getAsync inicia uma chamada assíncrona para o Exchange Server para obter o local de um compromisso. O local do compromisso é fornecido como uma cadeia de caracteres na asyncResult.value propriedade.
getAsync(callback)

Obtém o local de um compromisso.

O método getAsync inicia uma chamada assíncrona para o Exchange Server para obter o local de um compromisso. O local do compromisso é fornecido como uma cadeia de caracteres na asyncResult.value propriedade.
setAsync(location, options, callback)

Define o local de um compromisso.

O método setAsync inicia uma chamada assíncrona para o Exchange Server para definir o local de um compromisso. Definir o local de um compromisso substitui o local atual.
setAsync(location, callback)

Define o local de um compromisso.

O método setAsync inicia uma chamada assíncrona para o Exchange Server para definir o local de um compromisso. Definir o local de um compromisso substitui o local atual.

Detalhes do método

getAsync(options, callback)

Obtém o local de um compromisso.

O método getAsync inicia uma chamada assíncrona para o Exchange Server para obter o local de um compromisso. O local do compromisso é fornecido como uma cadeia de caracteres na asyncResult.value propriedade.

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => 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<string>) => void

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

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compose

Exemplos

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)

Obtém o local de um compromisso.

O método getAsync inicia uma chamada assíncrona para o Exchange Server para obter o local de um compromisso. O local do compromisso é fornecido como uma cadeia de caracteres na asyncResult.value propriedade.

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

Parâmetros

callback

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

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

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

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

Define o local de um compromisso.

O método setAsync inicia uma chamada assíncrona para o Exchange Server para definir o local de um compromisso. Definir o local de um compromisso substitui o local atual.

setAsync(location: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

location

string

O local do compromisso. A cadeia de caracteres está limitada a 255 caracteres.

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 do tipo Office.AsyncResult. Se a configuração do local falhar, a propriedade asyncResult.error conterá um código de erro.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compose

Erros:

  • DataExceedsMaximumSize: o parâmetro de localização é maior que 255 caracteres.

Exemplos

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

Define o local de um compromisso.

O método setAsync inicia uma chamada assíncrona para o Exchange Server para definir o local de um compromisso. Definir o local de um compromisso substitui o local atual.

setAsync(location: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

location

string

O local do compromisso. A cadeia de caracteres está limitada a 255 caracteres.

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 do tipo Office.AsyncResult. Se a configuração do local falhar, a propriedade asyncResult.error conterá um código de erro.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compose

Erros:

  • DataExceedsMaximumSize: o parâmetro de localização é maior que 255 caracteres.