Sway URI 方案

本文档定义了适用于 Windows 的 Sway 应用程序的统一资源标识符 (URI) 的格式。可以使用此 URI 方案通过各种命令调用 Sway 应用程序。

Sway URI 方案语法

以下是 URI 方案语法：

<ms-sway>:<command-argument>

<ms-sway>– 指示Sway是要调用的应用程序。安装适用于 Windows 的Sway后，ms-sway会向 Windows 注册为Sway处理程序。
<command-argument> – URI 可能有一个或多个命令参数，用和号 & 分隔 () 字符。当 URI 中包含多个命令参数时，与 (&) 字符必须将每个命令参数与以下命令参数分开。命令参数因方案而异。

可以将多个命令参数作为Sway URL 方案的一部分包含在内。不需要这些命令参数。如果未包含命令参数，则会调用 Sway 应用程序。

命令参数名称	说明	类型	可能的值	是否必需？
id	Sway的唯一标识符。用于指示要打开Sway。	String	Sway的有效唯一标识符。 ID 始终是Sway URL 的一部分。例如，对于以下Sway `https://sway.com/dBheQgVZ1RQBfiQU`，ID 为 `dBheQgVZ1RQBfiQU`。如果与 Sway 应用程序关联的用户帐户具有编辑权限，则应用程序将在编辑模式下打开Sway。否则，应用程序将在视图模式下打开Sway。	否
mode	打开特定Sway的模式，无论是编辑还是查看。	String	edit view 注意：如果未指定 ID ，则忽略此命令参数。	否
auth_upn	打开Sway时要使用的帐户。	String	有效的电子邮件地址。如果指定的电子邮件地址未与Sway帐户关联，Sway会要求用户以指定用户身份登录。如果多个帐户与Sway应用程序相关联，并且存在指定的电子邮件地址，则Sway应用程序在调用时将切换到使用该帐户。	否
auth_pvr	用于打开Sway的帐户类型-Microsoft 帐户或Microsoft Entra ID帐户。	String	WindowsLiveId – 指定 auth_upn 帐户是 Microsoft 帐户。 OrgId – 指定auth_upn帐户是Microsoft Entra帐户。如果未指定 auth_upn ，则忽略此命令参数。	否
invoking_app	用于调用Sway的 Windows 应用程序的名称。	String	用于通过Sway URL 方案调用Sway的 Windows 应用程序的友好名称。此命令参数的用途是遥测和跟踪。	否

方案<ms-sway>定义用于打开Sway或调用 Sway 应用程序的 URI 语法。方案定义多个命令参数，这些参数可用于执行以下操作：

打开Sway应用程序 - 无需指定命令参数。
打开在 Sway 应用程序中查看的Sway – 需要指定设置为查看的 ID 和模式。
打开Sway以在Sway应用程序中进行编辑 - 需要指定设置为编辑的 ID 和模式。建议还包含auth_upn和auth_pvr，以帮助确保在打开Sway时使用具有编辑权限的适当帐户。

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