Office.Location interface
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: ler item
Modo Outlook aplicável: Compor
Métodos
| get |
Obtém o local de um compromisso. O método |
| get |
Obtém o local de um compromisso. O método |
| set |
Define o local de um compromisso. O método |
| set |
Define o local de um compromisso. O método |
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. A localização do compromisso é fornecida como uma cadeia 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 programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Quando o método for concluído, a função transmitida 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: ler item
Modo Outlook aplicável: Compor
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. A localização do compromisso é fornecida como uma cadeia na asyncResult.value propriedade .
getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;Parâmetros
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Quando o método for concluído, a função transmitida 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: ler item
Modo Outlook aplicável: Compor
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 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 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: ler item
Modo Outlook aplicável: Compor
Erros:
- DataExceedsMaximumSize: o parâmetro de localização tem mais de 255 carateres.
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 for concluído, a função transmitida 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: ler item
Modo Outlook aplicável: Compor
Erros:
- DataExceedsMaximumSize: o parâmetro de localização tem mais de 255 carateres.