Office.EnhancedLocation interface

Représente l’ensemble des emplacements d’un rendez-vous.

Remarques

Niveau d’autorisation minimal : lire l’élément

Mode Outlook applicable : Rédiger ou Lire

Important : Pour gérer les emplacements d’un rendez-vous dans les clients Outlook qui ne prennent pas en charge le jeu d’exigences de boîte aux lettres 1.8, utilisez plutôt l’API Office.Location. Pour obtenir des instructions sur la sélection de l’API d’emplacement appropriée pour votre scénario, voir Obtenir ou définir l’emplacement lorsque vous composez un rendez-vous dans Outlook.

Utilisateur

Méthodes

addAsync(locationIdentifiers, options, callback)	S’ajoute à l’ensemble des emplacements associés au rendez-vous.
addAsync(locationIdentifiers, callback)	S’ajoute à l’ensemble des emplacements associés au rendez-vous.
getAsync(options, callback)	Obtient l’ensemble des emplacements associés au rendez-vous.
getAsync(callback)	Obtient l’ensemble des emplacements associés au rendez-vous.
removeAsync(locationIdentifiers, options, callback)	Supprime l’ensemble des emplacements associés au rendez-vous. S’il existe plusieurs emplacements portant le même nom, tous les emplacements correspondants sont supprimés, même si un seul a été spécifié dans `locationIdentifiers`.
removeAsync(locationIdentifiers, callback)	Supprime l’ensemble des emplacements associés au rendez-vous. S’il existe plusieurs emplacements portant le même nom, tous les emplacements correspondants sont supprimés, même si un seul a été spécifié dans `locationIdentifiers`.

addAsync(locationIdentifiers, options, callback)

S’ajoute à l’ensemble des emplacements associés au rendez-vous.

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

Paramètres

locationIdentifiers: Office.LocationIdentifier[]

Emplacements à ajouter à la liste actuelle des emplacements.

options: Office.AsyncContextOptions

Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

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

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet. Vérifiez la status propriété de asyncResult pour déterminer si l’appel a abouti.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Compose

Erreurs :

InvalidFormatError : le format de l’objet de données spécifié n’est pas valide.

Exemples

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

S’ajoute à l’ensemble des emplacements associés au rendez-vous.

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

Paramètres

locationIdentifiers: Office.LocationIdentifier[]

Emplacements à ajouter à la liste actuelle des emplacements.

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

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet. Vérifiez la status propriété de asyncResult pour déterminer si l’appel a abouti.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Compose

Erreurs :

InvalidFormatError : le format de l’objet de données spécifié n’est pas valide.

getAsync(options, callback)

Obtient l’ensemble des emplacements associés au rendez-vous.

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

Paramètres

options: Office.AsyncContextOptions

Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

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

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet. Un tableau d’objets Office.LocationDetails représentant les emplacements du rendez-vous est renvoyé dans la asyncResult.value propriété.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lire l’élément

Mode Outlook applicable : Rédiger ou Lire

Important:

La getAsync méthode ne renvoie pas les groupes de contacts personnels qui ont été ajoutés au champ emplacement d’un rendez-vous.
Si un emplacement a été ajouté à l’aide Office.context.mailbox.item.location.setAsyncde , son type d’emplacement est Office.MailboxEnums.LocationType.Custom.

Exemples

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

Obtient l’ensemble des emplacements associés au rendez-vous.

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

Paramètres

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

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet. Un tableau d’objets Office.LocationDetails représentant les emplacements du rendez-vous est renvoyé dans la asyncResult.value propriété.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lire l’élément

Mode Outlook applicable : Rédiger ou Lire

Important:

La getAsync méthode ne renvoie pas les groupes de contacts personnels qui ont été ajoutés au champ emplacement d’un rendez-vous.
Si un emplacement a été ajouté à l’aide Office.context.mailbox.item.location.setAsyncde , son type d’emplacement est Office.MailboxEnums.LocationType.Custom.

removeAsync(locationIdentifiers, options, callback)

Supprime l’ensemble des emplacements associés au rendez-vous.

S’il existe plusieurs emplacements portant le même nom, tous les emplacements correspondants sont supprimés, même si un seul a été spécifié dans locationIdentifiers.

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

Paramètres

locationIdentifiers: Office.LocationIdentifier[]

Emplacements à supprimer de la liste actuelle des emplacements.

options: Office.AsyncContextOptions

Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

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

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet. Vérifiez la status propriété de asyncResult pour déterminer si l’appel a abouti.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Compose

Exemples

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

Supprime l’ensemble des emplacements associés au rendez-vous.

S’il existe plusieurs emplacements portant le même nom, tous les emplacements correspondants sont supprimés, même si un seul a été spécifié dans locationIdentifiers.

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

Paramètres

locationIdentifiers: Office.LocationIdentifier[]

Emplacements à supprimer de la liste actuelle des emplacements.

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

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet. Vérifiez la status propriété de asyncResult pour déterminer si l’appel a abouti.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Compose

Remarques

Utilisateur

Méthodes

Détails de la méthode

addAsync(locationIdentifiers, options, callback)

Paramètres

Retours

Remarques

Exemples

addAsync(locationIdentifiers, callback)

Paramètres

Retours

Remarques

getAsync(options, callback)

Paramètres

Retours

Remarques

Exemples

getAsync(callback)

Paramètres

Retours

Remarques

removeAsync(locationIdentifiers, options, callback)

Paramètres

Retours

Remarques

Exemples

removeAsync(locationIdentifiers, callback)

Paramètres

Retours

Remarques

Commentaires