Office.Location interface
Bietet Methoden zum Abrufen und Festlegen des Orts einer Besprechung in einem Outlook-Add-In.
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose
Wichtig: Die Office.EnhancedLocation-API wurde im Postfachanforderungssatz 1.8 eingeführt. Verwenden Sie die EnhancedLocation-API, um Terminorte besser zu identifizieren und zu verwalten, insbesondere wenn Sie den Standorttyp bestimmen müssen. 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
| get |
Ruft den Ort eines Termins ab. Die |
| get |
Ruft den Ort eines Termins ab. Die |
| set |
Legt den Ort eines Termins fest. Die |
| set |
Legt den Ort eines Termins fest. Die |
Details zur Methode
getAsync(options, callback)
Ruft den Ort eines Termins ab.
Die getAsync-Methode startet einen asynchronen Aufruf an den Exchange-Server, um den Ort eines Termins abzurufen. Der Speicherort des Termins wird als Zeichenfolge in der asyncResult.value -Eigenschaft angegeben.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => 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<string>) => void
Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.
Gibt zurück
void
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose
Beispiele
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)
Ruft den Ort eines Termins ab.
Die getAsync-Methode startet einen asynchronen Aufruf an den Exchange-Server, um den Ort eines Termins abzurufen. Der Speicherort des Termins wird als Zeichenfolge in der asyncResult.value -Eigenschaft angegeben.
getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;Parameter
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.
Gibt zurück
void
Hinweise
Mindestberechtigungsstufe: Element lesen
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-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)
Legt den Ort eines Termins fest.
Die setAsync-Methode startet einen asynchronen Aufruf an den Exchange-Server, den Ort eines Termins festzulegen. Durch das Festlegen des Orts eines Termins wird der aktuelle Ort überschrieben.
setAsync(location: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parameter
- location
-
string
Der Ort des Termins. Die Zeichenfolge ist auf 255 Zeichen beschränkt.
- 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 vom Typ Office.AsyncResultaufgerufen. Wenn das Festlegen des Orts fehlschlägt, enthält die asyncResult.error-Eigenschaft einen Fehlercode.
Gibt zurück
void
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose
Wichtig: Um sicherzustellen, dass mehrere Speicherorte in Outlook ordnungsgemäß aufgelöst werden, trennen Sie sie durch ein Semikolon und ein Leerzeichen. Beispiel: "Konferenzraum 1; Konferenzraum 2".
Fehler:
- DataExceedsMaximumSize: Der location-Parameter ist länger als 255 Zeichen.
Beispiele
// 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)
Legt den Ort eines Termins fest.
Die setAsync-Methode startet einen asynchronen Aufruf an den Exchange-Server, den Ort eines Termins festzulegen. Durch das Festlegen des Orts eines Termins wird der aktuelle Ort überschrieben.
setAsync(location: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parameter
- location
-
string
Der Ort des Termins. Die Zeichenfolge ist auf 255 Zeichen beschränkt.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Wenn das Festlegen des Orts fehlschlägt, enthält die asyncResult.error-Eigenschaft einen Fehlercode.
Gibt zurück
void
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Compose
Wichtig: Um sicherzustellen, dass mehrere Speicherorte in Outlook ordnungsgemäß aufgelöst werden, trennen Sie sie durch ein Semikolon und ein Leerzeichen. Beispiel: "Konferenzraum 1; Konferenzraum 2".
Fehler:
- DataExceedsMaximumSize: Der location-Parameter ist länger als 255 Zeichen.