ContactsManager: getProperties()-Methode

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig, bevor Sie diese produktiv verwenden.

Die getProperties() Methode der ContactsManager-Schnittstelle gibt ein Promise zurück, das mit einem Array von strings aufgelöst wird. Diese Zeichenfolgen geben an, welche Kontakteigenschaften verfügbar sind.

Syntax

js
getProperties()

Parameter

Keine.

Rückgabewert

Gibt ein Promise zurück, das mit einem Array von strings aufgelöst wird, die die Kontakteigenschaften benennen, die vom aktuellen System zurückgegeben werden können.

Eigenschaften können Folgendes umfassen:

  • 'name': Der Name des Kontakts.
  • 'tel': Die Telefonnummer(n) des Kontakts.
  • 'email': Die E-Mail-Adresse des Kontakts.
  • 'address': Die Postanschrift des Kontakts.
  • 'icon': Das Avatarbild des Kontakts.

Ausnahmen

Es werden keine Ausnahmen ausgelöst.

Beispiele

Unterstützung von Eigenschaften überprüfen

Die folgende asynchrone Funktion verwendet die getProperties()-Methode, um zu überprüfen, ob das aktuelle System die icon-Eigenschaft unterstützt.

js
async function checkProperties() {
  const supportedProperties = await navigator.contacts.getProperties();
  if (!supportedProperties.includes("icon")) {
    console.log("Your system does not support getting icons.");
  }
}

Auswahl nur mit unterstützten Eigenschaften

Das folgende Beispiel ist ähnlich einem für die select()-Methode. Anstatt die an select() übergebenen Eigenschaften fest zu codieren, nutzt es getProperties(), um sicherzustellen, dass nur unterstützte Eigenschaften übergeben werden. Andernfalls könnte select() einen TypeError auslösen. handleResults() ist eine entwicklerdefinierte Funktion.

js
const supportedProperties = await navigator.contacts.getProperties();

async function getContacts() {
  try {
    const contacts = await navigator.contacts.select(supportedProperties);
    handleResults(contacts);
  } catch (ex) {
    // Handle any errors here.
  }
}

Spezifikationen

Specification
Contact Picker API
# contacts-manager-getproperties

Browser-Kompatibilität

BCD tables only load in the browser