Office.EnhancedLocation interface

Stellt die Gruppe von Orten für einen Termin dar.

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig: Um die Standorte eines Termins in Outlook-Clients zu verwalten, die den Postfach-Anforderungssatz 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 Standorts beim Verfassen eines Termins in Outlook.

Verwendet von

Methoden

addAsync(locationIdentifiers, options, callback)	Fügt der Gruppe von Orten, die dem Termin zugeordnet sind, hinzu.
addAsync(locationIdentifiers, callback)	Fügt der Gruppe von Orten, die dem Termin zugeordnet sind, hinzu.
getAsync(options, callback)	Ruft die mit dem Termin verknüpften Speicherorte ab.
getAsync(callback)	Ruft die mit dem Termin verknüpften Speicherorte ab.
removeAsync(locationIdentifiers, options, callback)	Entfernt die Gruppe von Orten, die dem Termin zugeordnet sind. Wenn mehrere Speicherorte mit demselben Namen vorhanden sind, werden alle übereinstimmenden Speicherorte entfernt, auch wenn nur einer in `locationIdentifiers`angegeben wurde.
removeAsync(locationIdentifiers, callback)	Entfernt die Gruppe von Orten, die dem Termin zugeordnet sind. Wenn mehrere Speicherorte mit demselben Namen vorhanden sind, werden alle übereinstimmenden Speicherorte entfernt, auch wenn nur einer in `locationIdentifiers`angegeben wurde.

addAsync(locationIdentifiers, options, callback)

Fügt der Gruppe von Orten, die dem Termin zugeordnet sind, hinzu.

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

Parameter

locationIdentifiers: Office.LocationIdentifier[]

Die Standorte, die der aktuellen Liste der Standorte hinzugefügt werden sollen.

options: Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContext: Entwickler können jedes Objekt, auf das sie zugreifen möchten, in der Rückruffunktion bereitstellen.

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

Optional. Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter, , aufgerufen, asyncResultder ein Office.AsyncResult Objekt ist. Überprüfen Sie die status Eigenschaft von asyncResult , um zu ermitteln, ob der Aufruf erfolgreich war.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: 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 der Gruppe von Orten, die dem Termin zugeordnet sind, hinzu.

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

Parameter

locationIdentifiers: Office.LocationIdentifier[]

Die Standorte, 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, asyncResultder ein Office.AsyncResult Objekt ist. Überprüfen Sie die status Eigenschaft von asyncResult , um zu ermitteln, ob der Aufruf erfolgreich war.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Fehler:

InvalidFormatError : Das Format des angegebenen Datenobjekts ist ungültig.

getAsync(options, callback)

Ruft die mit dem Termin verknüpften Speicherorte ab.

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: asyncContext: Entwickler können jedes Objekt, auf das sie zugreifen möchten, in der Rückruffunktion bereitstellen.

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, asyncResultder ein Office.AsyncResult Objekt ist. Ein Array von Office.LocationDetails Objekten, die die Standorte des Termins darstellen, wird in der asyncResult.value Eigenschaft zurückgegeben.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig:

Die getAsync Methode gibt keine persönlichen Kontaktgruppen zurück, die dem Feld "Ort " eines Termins hinzugefügt wurden.
Wenn ein Standort mit Office.context.mailbox.item.location.setAsynchinzugefügt wurde, ist Office.MailboxEnums.LocationType.Customsein Standorttyp .

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 die mit dem Termin verknüpften Speicherorte ab.

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, asyncResultder ein Office.AsyncResult Objekt ist. Ein Array von Office.LocationDetails Objekten, die die Standorte des Termins darstellen, wird in der asyncResult.value Eigenschaft zurückgegeben.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig:

Die getAsync Methode gibt keine persönlichen Kontaktgruppen zurück, die dem Feld "Ort " eines Termins hinzugefügt wurden.
Wenn ein Standort mit Office.context.mailbox.item.location.setAsynchinzugefügt wurde, ist Office.MailboxEnums.LocationType.Customsein Standorttyp .

removeAsync(locationIdentifiers, options, callback)

Entfernt die Gruppe von Orten, die dem Termin zugeordnet sind.

Wenn mehrere Speicherorte mit demselben Namen vorhanden sind, werden alle übereinstimmenden Speicherorte entfernt, auch wenn nur einer in locationIdentifiersangegeben wurde.

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

Parameter

locationIdentifiers: Office.LocationIdentifier[]

Die Standorte, die aus der aktuellen Liste der Standorte entfernt werden sollen.

options: Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContext: Entwickler können jedes Objekt, auf das sie zugreifen möchten, in der Rückruffunktion bereitstellen.

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

Optional. Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter, , aufgerufen, asyncResultder ein Office.AsyncResult Objekt ist. Überprüfen Sie die status Eigenschaft von asyncResult , um zu ermitteln, ob der Aufruf erfolgreich war.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: 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 Gruppe von Orten, die dem Termin zugeordnet sind.

Wenn mehrere Speicherorte mit demselben Namen vorhanden sind, werden alle übereinstimmenden Speicherorte entfernt, auch wenn nur einer in locationIdentifiersangegeben wurde.

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

Parameter

locationIdentifiers: Office.LocationIdentifier[]

Die Standorte, 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, asyncResultder ein Office.AsyncResult Objekt ist. Überprüfen Sie die status Eigenschaft von asyncResult , um zu ermitteln, ob der Aufruf erfolgreich war.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Hinweise

Verwendet von

Methoden

Details zur Methode

addAsync(locationIdentifiers, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

addAsync(locationIdentifiers, callback)

Parameter

Gibt zurück

Hinweise

getAsync(options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

getAsync(callback)

Parameter

Gibt zurück

Hinweise

removeAsync(locationIdentifiers, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

removeAsync(locationIdentifiers, callback)

Parameter

Gibt zurück

Hinweise

Feedback