Office.EnhancedLocation interface
Stellt den Satz von Standorten für einen Termin dar.
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose oder Lesen
Wichtig: Um die Speicherorte eines Termins in Outlook-Clients zu verwalten, die den Postfachanforderungssatz 1.8 nicht unterstützen, verwenden Sie stattdessen die Office.Location-API. Eine Anleitung zum Auswählen der richtigen Standort-API für Ihr Szenario finden Sie unter Abrufen oder Festlegen des Speicherorts beim Verfassen eines appointmnt in Outlook.
Methoden
| add |
Fügt dem Satz von Speicherorten hinzu, die dem Termin zugeordnet sind. |
| add |
Fügt dem Satz von Speicherorten hinzu, die dem Termin zugeordnet sind. |
| get |
Ruft den Satz von Speicherorten ab, die dem Termin zugeordnet sind. |
| get |
Ruft den Satz von Speicherorten ab, die dem Termin zugeordnet sind. |
| remove |
Entfernt die dem Termin zugeordneten Standorte. Wenn mehrere Speicherorte mit demselben Namen vorhanden sind, werden alle übereinstimmenden Speicherorte auch dann entfernt, wenn nur einer in |
| remove |
Entfernt die dem Termin zugeordneten Standorte. Wenn mehrere Speicherorte mit demselben Namen vorhanden sind, werden alle übereinstimmenden Speicherorte auch dann entfernt, wenn nur einer in |
Details zur Methode
addAsync(locationIdentifiers, options, callback)
Fügt dem Satz von Speicherorten hinzu, die dem Termin zugeordnet sind.
addAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Parameter
- locationIdentifiers
Die Speicherorte, die der aktuellen Liste der Standorte hinzugefügt werden sollen.
- options
- Office.AsyncContextOptions
Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Überprüfen Sie die status -Eigenschaft von , asyncResult um festzustellen, ob der Aufruf erfolgreich war.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Compose
Fehler:
-
InvalidFormatError: Das Format des angegebenen Datenobjekts ist ungültig.
Beispiele
// 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)
Fügt dem Satz von Speicherorten hinzu, die dem Termin zugeordnet sind.
addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Parameter
- locationIdentifiers
Die Speicherorte, die der aktuellen Liste der Standorte hinzugefügt werden sollen.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Überprüfen Sie die status -Eigenschaft von , asyncResult um festzustellen, ob der Aufruf erfolgreich war.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Compose
Fehler:
-
InvalidFormatError: Das Format des angegebenen Datenobjekts ist ungültig.
getAsync(options, callback)
Ruft den Satz von Speicherorten ab, die dem Termin zugeordnet sind.
getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => void): void;
Parameter
- options
- Office.AsyncContextOptions
Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.
- callback
-
(asyncResult: Office.AsyncResult<Office.LocationDetails[]>) => void
Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Ein Array von Office.LocationDetails -Objekten, die die Positionen des Termins darstellen, wird in der asyncResult.value -Eigenschaft zurückgegeben.
Gibt zurück
void
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose oder Lesen
Wichtig:
Die
getAsyncMethode gibt keine persönlichen Kontaktgruppen zurück, die dem Feld Standort eines Termins hinzugefügt wurden.Wenn ein Speicherort mit
Office.context.mailbox.item.location.setAsynchinzugefügt wurde, istOffice.MailboxEnums.LocationType.Customsein Speicherorttyp .
Beispiele
// 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)
Ruft den Satz von Speicherorten ab, die dem Termin zugeordnet sind.
getAsync(callback?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => void): void;
Parameter
- callback
-
(asyncResult: Office.AsyncResult<Office.LocationDetails[]>) => void
Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Ein Array von Office.LocationDetails -Objekten, die die Positionen des Termins darstellen, wird in der asyncResult.value -Eigenschaft zurückgegeben.
Gibt zurück
void
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose oder Lesen
Wichtig:
Die
getAsyncMethode gibt keine persönlichen Kontaktgruppen zurück, die dem Feld Standort eines Termins hinzugefügt wurden.Wenn ein Speicherort mit
Office.context.mailbox.item.location.setAsynchinzugefügt wurde, istOffice.MailboxEnums.LocationType.Customsein Speicherorttyp .
removeAsync(locationIdentifiers, options, callback)
Entfernt die dem Termin zugeordneten Standorte.
Wenn mehrere Speicherorte mit demselben Namen vorhanden sind, werden alle übereinstimmenden Speicherorte auch dann entfernt, wenn nur einer in locationIdentifiersangegeben wurde.
removeAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Parameter
- locationIdentifiers
Die Speicherorte, die aus der aktuellen Liste der Standorte entfernt werden sollen.
- options
- Office.AsyncContextOptions
Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Überprüfen Sie die status -Eigenschaft von , asyncResult um festzustellen, ob der Aufruf erfolgreich war.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Compose
Beispiele
// 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)
Entfernt die dem Termin zugeordneten Standorte.
Wenn mehrere Speicherorte mit demselben Namen vorhanden sind, werden alle übereinstimmenden Speicherorte auch dann entfernt, wenn nur einer in locationIdentifiersangegeben wurde.
removeAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Parameter
- locationIdentifiers
Die Speicherorte, die aus der aktuellen Liste der Standorte entfernt werden sollen.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Überprüfen Sie die status -Eigenschaft von , asyncResult um festzustellen, ob der Aufruf erfolgreich war.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Compose