Navigator: getInstalledRelatedApps() Methode

Beschreibung

getInstalledRelatedApps() kann verwendet werden, um die Installation von Universal Windows Platform (UWP) Apps, Android-Apps und PWAs zu überprüfen, die mit der die Methode aufrufenden Web-App zusammenhängen.

Um die aufrufende Web-App mit einer plattformspezifischen App oder PWA zu verknüpfen, müssen zwei Dinge getan werden:

1. Die aufrufende Web-App muss im related_applications Mitglied ihrer Manifestdatei angegeben werden.
2. Die plattformspezifische App oder PWA muss ihre Beziehung zur aufrufenden App definiert haben.

Die Definition der Beziehung erfolgt je nach App-Typ unterschiedlich:

• Eine Android-App macht dies über das Digital Asset Links System.
• Eine Windows UWP-App macht dies über URI-Handler.
• Eine PWA macht dies über:
  • Einen selbstdefinierenden Eintrag in ihrem eigenen related_applications Manifest-Mitglied, im Falle einer PWA, die überprüft, ob sie auf der zugrunde liegenden Plattform installiert ist.
  • Eine assetlinks.json Datei in ihrem /.well-known/ Verzeichnis, im Falle einer App außerhalb des PWA-Bereichs, die überprüft, ob sie installiert ist.

Siehe Ist Ihre App installiert? getInstalledRelatedApps() sagt es Ihnen! für weitere Details, wie Sie mit jedem dieser Fälle umgehen können.

Syntax

getInstalledRelatedApps()

Parameter

Keine.

Rückgabewert

Ein Promise, das mit einem Array von Objekten aufgelöst wird, die alle installierten verwandten Apps darstellen. Jedes Objekt kann die folgenden Eigenschaften enthalten:

id Optional

Ein String, der die ID repräsentiert, die verwendet wird, um die Anwendung auf der angegebenen Plattform zu repräsentieren. Die genaue Form des Strings variiert je nach Plattform.

platform

Ein String, der die Plattform (Ökosystem oder Betriebssystem) repräsentiert, mit der die verwandte App assoziiert ist. Dies kann sein:

• "chrome_web_store": Eine Google Chrome Web Store App.
• "play": Eine Google Play Store App.
• "chromeos_play": Eine ChromeOS Play App.
• "webapp": Eine Progressive Web App.
• "windows": Eine Windows Store App.
• "f-droid": Eine F-Droid App.
• "amazon": Eine Amazon App Store App.

url Optional

Ein String, der die URL repräsentiert, die mit der App assoziiert ist. Dies ist normalerweise, wo Sie Informationen darüber lesen und es installieren können.

version Optional

Ein String, der die Version der verwandten App repräsentiert.

Die Informationen zu den verwandten Apps müssen zuvor im related_applications Mitglied der Manifestdatei der aufrufenden Web-App angegeben worden sein.

Ausnahmen

InvalidStateError DOMException

Die Methode wurde nicht in einem Top-Level-Browsing-Kontext aufgerufen.

Beispiele

const relatedApps = await navigator.getInstalledRelatedApps();

// Dump all the returned related apps into a table in the console
console.table(relatedApps);

// Search for a specific installed platform-specific app
const psApp = relatedApps.find((app) => app.id === "com.example.myapp");

if (psApp && doesVersionSendPushMessages(psApp.version)) {
  // There's an installed platform-specific app that handles sending push messages
  // No need to handle this via the web app
  return;
}

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Ist Ihre App installiert? getInstalledRelatedApps() sagt es Ihnen!