Auf Englisch lesen

Freigeben über


Sway-URI-Schema

In diesem Dokument wird das Format von URIs (Uniform Resource Identifiers) für die Sway Anwendung für Windows definiert. Sie können dieses URI-Schema verwenden, um die Sway-Anwendung mit verschiedenen Befehlen aufzurufen.

Sway URI-Schemasyntax

Es folgt die URI-Schemasyntax:

<ms-sway>:<command-argument>

  • <ms-sway>– Gibt an, dass Sway die aufzurufende Anwendung ist. Wenn Sway für Windows installiert ist, ms-sway wird bei Windows als Sway-Handler registriert.
  • <command-argument> – Ein URI kann ein oder mehrere Befehlsargumente aufweisen, die durch das kaufmännische und -Zeichen (&) getrennt sind. Wenn mehr als ein Befehlsargument in einem URI enthalten ist, muss jedes Befehlsargument durch ein kaufmännisches und -Zeichen (&) vom folgenden Befehlsargument getrennt werden. Befehlsargumente variieren je nach Szenario.

Befehlsargumente

Mehrere Befehlsargumente können als Teil des Sway URL-Schemas eingeschlossen werden. Diese Befehlsargumente sind nicht erforderlich. Wenn Sie die Befehlsargumente nicht einschließen, wird die Sway Anwendung aufgerufen.

Name des Befehlsarguments Beschreibung Typ Mögliche Werte Pflichtfeld?
id Der eindeutige Bezeichner eines Sway. Wird verwendet, um die Sway anzugeben, die geöffnet werden soll. Zeichenfolge Ein gültiger eindeutiger Bezeichner für eine Sway. Die ID ist immer Teil der URL zu einem Sway.

Für die folgende Sway https://sway.com/dBheQgVZ1RQBfiQUist dBheQgVZ1RQBfiQUdie ID beispielsweise .

Wenn das der Sway Anwendung zugeordnete Benutzerkonto über Bearbeitungsberechtigungen verfügt, öffnet die Anwendung die Sway im Bearbeitungsmodus. Andernfalls öffnet die Anwendung die Sway im Ansichtsmodus.
Nein
mode Der Modus, in dem ein bestimmter Sway geöffnet werden soll, unabhängig davon, ob sie bearbeitet oder angezeigt werden. Zeichenfolge Bearbeiten
Ansicht

HINWEIS: Wenn keine ID angegeben ist, wird dieses Befehlsargument ignoriert.
Nein
auth_upn Das Konto, das beim Öffnen Sway verwendet werden soll. Zeichenfolge Eine gültige E-Mail-Adresse.

Wenn die angegebene E-Mail-Adresse keinem Sway-Konto zugeordnet ist, fordert Sway den Benutzer auf, sich als der angegebene Benutzer anzumelden.

Wenn der Sway-Anwendung mehr als ein Konto zugeordnet ist und die angegebene E-Mail-Adresse vorhanden ist, wechselt die Sway Anwendung beim Aufruf zur Verwendung dieses Kontos.
Nein
auth_pvr Der Typ des Kontos, das zum Öffnen des Sway verwendet werden soll – entweder ein Microsoft-Konto oder ein Microsoft Entra ID-Konto. Zeichenfolge WindowsLiveId: Gibt an, dass das auth_upn Konto ein Microsoft-Konto ist.

OrgId: Gibt an, dass das auth_upn-Konto ein Microsoft Entra-Konto ist.

Wenn kein auth_upn angegeben ist, wird dieses Befehlsargument ignoriert.
Nein
invoking_app Der Name der Windows-Anwendung, die zum Aufrufen von Sway verwendet wird. Zeichenfolge Der Anzeigename der Windows-Anwendung, die zum Aufrufen von Sway über das Sway URL-Schema verwendet wird.

Der Zweck dieses Befehlsarguments ist für Telemetrie und Nachverfolgung.
Nein

URI-Schemasemantik

Das <ms-sway> Schema definiert eine URI-Syntax zum Öffnen einer Sway oder zum Aufrufen der Sway Anwendung. Das Schema definiert mehrere Befehlsargumente, die für die folgenden Aktionen verwendet werden können:

  • Öffnen Sie die Sway Anwendung: Es müssen keine Befehlsargumente angegeben werden.

  • Öffnen eines Sway zum Anzeigen in der Sway-Anwendung: Die ID und der Modus, der für die Ansicht festgelegt ist, müssen angegeben werden.

  • Öffnen Sie eine Sway für die Bearbeitung in der Sway-Anwendung: Die id und der Modus, der für die Bearbeitung festgelegt ist, müssen angegeben werden. Es wird empfohlen, dass Sie auch auth_upn und auth_pvr einschließen, um sicherzustellen, dass beim Öffnen von Sway das richtige Konto mit Bearbeitungsberechtigungen verwendet wird.

Beispiel

ms-sway:id=CyrvEYLmFKi1B2_I&auth_upn=account@email.com&auth_pvr=WindowsLiveId&invoking_app=MyApp