Office.EnhancedLocation interface
Représente l’ensemble d’emplacements sur un rendez-vous.
Remarques
[ Ensemble d’API : Boîte aux lettres 1.8 ]
Niveau d’autorisation minimal : élément de lecture
Mode Outlook applicable : Rédiger ou Lire
Méthodes
add |
Ajoute à l’ensemble des emplacements associés au rendez-vous. |
add |
Ajoute à l’ensemble des emplacements associés au rendez-vous. |
get |
Obtient l’ensemble des emplacements associés au rendez-vous. Remarque : les groupes de contacts personnels ajoutés comme emplacements de rendez-vous ne sont pas retournés par cette méthode. |
get |
Obtient l’ensemble des emplacements associés au rendez-vous. Remarque : les groupes de contacts personnels ajoutés comme emplacements de rendez-vous ne sont pas retournés par cette méthode. |
remove |
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 emplacement a été spécifié dans |
remove |
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 emplacement a été spécifié dans |
Détails de la méthode
addAsync(locationIdentifiers, options, callback)
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
Emplacements à ajouter à la liste actuelle des emplacements.
- options
- Office.AsyncContextOptions
Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContext
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. Une fois la méthode 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 réussi.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.8 ]
Niveau d’autorisation minimal : élément en lecture/écriture
Mode Outlook applicable : Composer
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)
Ajoute à l’ensemble des emplacements associés au rendez-vous.
addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Paramètres
- locationIdentifiers
Emplacements à ajouter à la liste actuelle des emplacements.
- 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, asyncResult
, qui est un Office.AsyncResult
objet . Vérifiez la status
propriété de asyncResult
pour déterminer si l’appel a réussi.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.8 ]
Niveau d’autorisation minimal : élément en lecture/écriture
Mode Outlook applicable : Composer
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.
Remarque : les groupes de contacts personnels ajoutés comme emplacements de rendez-vous ne sont pas retournés par cette méthode.
getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => void): void;
Paramètres
- options
- Office.AsyncContextOptions
Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContext
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. Une fois la méthode 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 .
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.8 ]
Niveau d’autorisation minimal : élément de lecture
Mode Outlook applicable : Rédiger ou Lire
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.
Remarque : les groupes de contacts personnels ajoutés comme emplacements de rendez-vous ne sont pas retournés par cette méthode.
getAsync(callback?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => void): void;
Paramètres
- callback
-
(asyncResult: Office.AsyncResult<Office.LocationDetails[]>) => 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, asyncResult
, qui est un Office.AsyncResult
objet .
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.8 ]
Niveau d’autorisation minimal : élément de lecture
Mode Outlook applicable : Rédiger ou Lire
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 emplacement a été spécifié dans locationIdentifiers
.
removeAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Paramètres
- locationIdentifiers
Emplacements à supprimer de la liste actuelle des emplacements.
- options
- Office.AsyncContextOptions
Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContext
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. Une fois la méthode 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 réussi.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.8 ]
Niveau d’autorisation minimal : élément en lecture/écriture
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-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 emplacement a été spécifié dans locationIdentifiers
.
removeAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Paramètres
- locationIdentifiers
Emplacements à supprimer de la liste actuelle des emplacements.
- 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, asyncResult
, qui est un Office.AsyncResult
objet . Vérifiez la status
propriété de asyncResult
pour déterminer si l’appel a réussi.
Retours
void
Remarques
[ Ensemble d’API : Boîte aux lettres 1.8 ]
Niveau d’autorisation minimal : élément en lecture/écriture
Mode Outlook applicable : Composer