Compartir a través de

Office.EnhancedLocation interface

  • Referencia
Paquete:
outlook

Representa el conjunto de ubicaciones de una cita.

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

Métodos

addAsync(locationIdentifiers, options, callback)

Se agrega al conjunto de ubicaciones asociadas a la cita.
addAsync(locationIdentifiers, callback)

Se agrega al conjunto de ubicaciones asociadas a la cita.
getAsync(options, callback)

Obtiene el conjunto de ubicaciones asociadas a la cita.

Nota: Este método no devuelve los grupos de contactos personales agregados como ubicaciones de citas.
getAsync(callback)

Obtiene el conjunto de ubicaciones asociadas a la cita.

Nota: Este método no devuelve los grupos de contactos personales agregados como ubicaciones de citas.
removeAsync(locationIdentifiers, options, callback)

Quita el conjunto de ubicaciones asociadas a la cita.

Si hay varias ubicaciones con el mismo nombre, todas las ubicaciones coincidentes se quitarán incluso si solo se especificó una en locationIdentifiers.
removeAsync(locationIdentifiers, callback)

Quita el conjunto de ubicaciones asociadas a la cita.

Si hay varias ubicaciones con el mismo nombre, todas las ubicaciones coincidentes se quitarán incluso si solo se especificó una en locationIdentifiers.

Detalles del método

addAsync(locationIdentifiers, options, callback)

Se agrega al conjunto de ubicaciones asociadas a la cita.

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

Parámetros

locationIdentifiers

Office.LocationIdentifier[]

Ubicaciones que se van a agregar a la lista actual de ubicaciones.

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, asyncResult, que es un Office.AsyncResult objeto . Compruebe la status propiedad de asyncResult para determinar si la llamada se realizó correctamente.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Compose

Errores:

  • InvalidFormatError : el formato del objeto de datos especificado no es válido.

Ejemplos

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

Se agrega al conjunto de ubicaciones asociadas a la cita.

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

Parámetros

locationIdentifiers

Office.LocationIdentifier[]

Ubicaciones que se van a agregar a la lista actual de ubicaciones.

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, asyncResult, que es un Office.AsyncResult objeto . Compruebe la status propiedad de asyncResult para determinar si la llamada se realizó correctamente.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Compose

Errores:

  • InvalidFormatError : el formato del objeto de datos especificado no es válido.

getAsync(options, callback)

Obtiene el conjunto de ubicaciones asociadas a la cita.

Nota: Este método no devuelve los grupos de contactos personales agregados como ubicaciones de citas.

getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => 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<Office.LocationDetails[]>) => 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, asyncResult, que es un Office.AsyncResult objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

Ejemplos

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

Obtiene el conjunto de ubicaciones asociadas a la cita.

Nota: Este método no devuelve los grupos de contactos personales agregados como ubicaciones de citas.

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

Parámetros

callback

(asyncResult: Office.AsyncResult<Office.LocationDetails[]>) => 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, asyncResult, que es un Office.AsyncResult objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

removeAsync(locationIdentifiers, options, callback)

Quita el conjunto de ubicaciones asociadas a la cita.

Si hay varias ubicaciones con el mismo nombre, todas las ubicaciones coincidentes se quitarán incluso si solo se especificó una en locationIdentifiers.

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

Parámetros

locationIdentifiers

Office.LocationIdentifier[]

Ubicaciones que se van a quitar de la lista actual de ubicaciones.

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, asyncResult, que es un Office.AsyncResult objeto . Compruebe la status propiedad de asyncResult para determinar si la llamada se realizó correctamente.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Compose

Ejemplos

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

Quita el conjunto de ubicaciones asociadas a la cita.

Si hay varias ubicaciones con el mismo nombre, todas las ubicaciones coincidentes se quitarán incluso si solo se especificó una en locationIdentifiers.

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

Parámetros

locationIdentifiers

Office.LocationIdentifier[]

Ubicaciones que se van a quitar de la lista actual de ubicaciones.

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, asyncResult, que es un Office.AsyncResult objeto . Compruebe la status propiedad de asyncResult para determinar si la llamada se realizó correctamente.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Compose