Office.Location interface

  • Referencia
Paquete:
outlook

Proporciona métodos para obtener y establecer la ubicación de una cita en un complemento de Outlook.

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción

Métodos

getAsync(options, callback)

Obtiene la ubicación de una cita.

El método getAsync inicia una llamada asincrónica al servidor de Exchange para obtener la ubicación de una cita. La ubicación de la cita se proporciona como una cadena en la asyncResult.value propiedad .
getAsync(callback)

Obtiene la ubicación de una cita.

El método getAsync inicia una llamada asincrónica al servidor de Exchange para obtener la ubicación de una cita. La ubicación de la cita se proporciona como una cadena en la asyncResult.value propiedad .
setAsync(location, options, callback)

Establece la ubicación de una cita.

El método setAsync inicia una llamada asincrónica al servidor de Exchange para establecer la ubicación de una cita. Cuando se establezca, se sobrescribirá la ubicación actual.
setAsync(location, callback)

Establece la ubicación de una cita.

El método setAsync inicia una llamada asincrónica al servidor de Exchange para establecer la ubicación de una cita. Cuando se establezca, se sobrescribirá la ubicación actual.

Detalles del método

getAsync(options, callback)

Obtiene la ubicación de una cita.

El método getAsync inicia una llamada asincrónica al servidor de Exchange para obtener la ubicación de una cita. La ubicación de la cita se proporciona como una cadena en la asyncResult.value propiedad .

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

Parámetros

options
Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

callback

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

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción

Ejemplos

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)

Obtiene la ubicación de una cita.

El método getAsync inicia una llamada asincrónica al servidor de Exchange para obtener la ubicación de una cita. La ubicación de la cita se proporciona como una cadena en la asyncResult.value propiedad .

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

Parámetros

callback

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

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción

Ejemplos

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

Establece la ubicación de una cita.

El método setAsync inicia una llamada asincrónica al servidor de Exchange para establecer la ubicación de una cita. Cuando se establezca, se sobrescribirá la ubicación actual.

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

Parámetros

location

string

La ubicación de la cita. La cadena está limitada a 255 caracteres.

options
Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

callback

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

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. Si se produce un error en el establecimiento de la ubicación, la propiedad asyncResult.error contendrá un código de error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción

Errores:

  • DataExceedsMaximumSize: el parámetro location tiene más de 255 caracteres.

Ejemplos

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

Establece la ubicación de una cita.

El método setAsync inicia una llamada asincrónica al servidor de Exchange para establecer la ubicación de una cita. Cuando se establezca, se sobrescribirá la ubicación actual.

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

Parámetros

location

string

La ubicación de la cita. La cadena está limitada a 255 caracteres.

callback

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

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. Si se produce un error en el establecimiento de la ubicación, la propiedad asyncResult.error contendrá un código de error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción

Errores:

  • DataExceedsMaximumSize: el parámetro location tiene más de 255 caracteres.