Navigator: getInstalledRelatedApps() Methode

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

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

Die getInstalledRelatedApps()-Methode gibt ein Promise zurück, das mit einem Array von Objekten aufgelöst wird, die plattformspezifische Apps oder Progressive Web Apps darstellen, die der Benutzer installiert hat. Dies könnte zur Personalisierung von Inhalten verwendet werden, z. B. um "Installieren Sie unsere App"-Banner von der Web-App zu entfernen, wenn die plattformspezifische App und/oder PWA bereits installiert ist.

Hinweis: Diese Methode muss in einem obersten sicheren Kontext aufgerufen werden, also nicht eingebettet in einem <iframe>.

Beschreibung

getInstalledRelatedApps() kann verwendet werden, um die Installation von Universal Windows Platform (UWP)-Apps, Android-Apps und PWAs zu überprüfen, die mit der Web-App, die diese Methode aufruft, in Verbindung stehen.

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 Manifest-Datei 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 auf unterschiedliche Weise:

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

Weitere Details zur Handhabung dieser Fälle finden Sie unter Is your app installed? getInstalledRelatedApps() will tell you!.

Hinweis: Die meisten unterstützenden Browser bieten ihre eigene Installations-UI an, wenn eine installierbare PWA erkannt wird, die nicht erscheint, wenn sie bereits installiert ist — siehe Making PWAs installable > Installation from the web. Dies kann mit dem beforeinstallprompt-Ereignis unterdrückt werden, das auch in Kombination mit getInstalledRelatedApps() verwendet werden könnte, um es basierend auf einer verfügbaren plattformspezifischen App zu unterdrücken. Siehe Trigger installation from your PWA für weitere nützliche Informationen.

Syntax

js
getInstalledRelatedApps()

Parameter

Keine.

Rückgabewert

Ein Promise, das mit einem Array von Objekten erfüllt wird, die installierte verwandte Apps darstellen. Jedes Objekt kann die folgenden Eigenschaften enthalten:

id Optional

Ein String, der die ID darstellt, 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) darstellt, mit der die verwandte App verknüpft ist. Dies kann sein:

url Optional

Ein String, der die URL darstellt, die mit der App verknüpft ist. Dies ist normalerweise die Stelle, an der man Informationen lesen und die App installieren kann.

version Optional

Ein String, der die Version der verwandten App darstellt.

Die Informationen zur verwandten App müssen zuvor im related_applications-Mitglied der aufrufenden Web-App Manifest-Datei angegeben worden sein.

Ausnahmen

InvalidStateError DOMException

Die Methode wurde nicht in einem obersten Browsing-Kontext aufgerufen.

Beispiele

js
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;
}

Hinweis: In diesem Beispiel ist doesVersionSendPushMessages() eine theoretische, vom Entwickler definierte Funktion; sie wird nicht vom Browser bereitgestellt.

Spezifikationen

Specification
Get Installed Related Apps API
# dom-navigator-getinstalledrelatedapps

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch