Partager via


Office.Location interface

Fournit des méthodes pour obtenir et définir le lieu d’une réunion dans un complément Outlook.

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Composer

Méthodes

getAsync(options, callback)

Obtient l’emplacement d’un rendez-vous.

La méthode getAsync lance un appel asynchrone vers le serveur Exchange pour obtenir le lieu d’un rendez-vous. L’emplacement du rendez-vous est fourni sous forme de chaîne dans la asyncResult.value propriété .

getAsync(callback)

Obtient l’emplacement d’un rendez-vous.

La méthode getAsync lance un appel asynchrone vers le serveur Exchange pour obtenir le lieu d’un rendez-vous. L’emplacement du rendez-vous est fourni sous forme de chaîne dans la asyncResult.value propriété .

setAsync(location, options, callback)

Définit l’emplacement d’un rendez-vous.

La méthode setAsync lance un appel asynchrone vers le serveur Exchange pour définir le lieu d’un rendez-vous. La définition du lieu d’un rendez-vous remplace le lieu existant.

setAsync(location, callback)

Définit l’emplacement d’un rendez-vous.

La méthode setAsync lance un appel asynchrone vers le serveur Exchange pour définir le lieu d’un rendez-vous. La définition du lieu d’un rendez-vous remplace le lieu existant.

Détails de la méthode

getAsync(options, callback)

Obtient l’emplacement d’un rendez-vous.

La méthode getAsync lance un appel asynchrone vers le serveur Exchange pour obtenir le lieu d’un rendez-vous. L’emplacement du rendez-vous est fourni sous forme de chaîne dans la asyncResult.value propriété .

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

Paramètres

options
Office.AsyncContextOptions

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

callback

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

Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult.

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Composer

Exemples

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)

Obtient l’emplacement d’un rendez-vous.

La méthode getAsync lance un appel asynchrone vers le serveur Exchange pour obtenir le lieu d’un rendez-vous. L’emplacement du rendez-vous est fourni sous forme de chaîne dans la asyncResult.value propriété .

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

Paramètres

callback

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

Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult.

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Composer

Exemples

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

Définit l’emplacement d’un rendez-vous.

La méthode setAsync lance un appel asynchrone vers le serveur Exchange pour définir le lieu d’un rendez-vous. La définition du lieu d’un rendez-vous remplace le lieu existant.

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

Paramètres

location

string

Emplacement du rendez-vous. La chaîne est limitée à 255 caractères.

options
Office.AsyncContextOptions

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

callback

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

Facultatif. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. Si la définition du lieu échoue, la propriété asyncResult.error contient un code d’erreur.

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Composer

Erreurs :

  • DataExceedsMaximumSize : le paramètre location comporte plus de 255 caractères.

Exemples

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

Définit l’emplacement d’un rendez-vous.

La méthode setAsync lance un appel asynchrone vers le serveur Exchange pour définir le lieu d’un rendez-vous. La définition du lieu d’un rendez-vous remplace le lieu existant.

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

Paramètres

location

string

Emplacement du rendez-vous. La chaîne est limitée à 255 caractères.

callback

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

Facultatif. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. Si la définition du lieu échoue, la propriété asyncResult.error contient un code d’erreur.

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Composer

Erreurs :

  • DataExceedsMaximumSize : le paramètre location comporte plus de 255 caractères.