Stssync 协议

  • 项目

上次修改时间： 2015年3月9日

适用范围： SharePoint Foundation 2010

通过使用 stssync 协议，您可以向 Microsoft Outlook 或支持该协议的第三方应用程序添加位于 Microsoft SharePoint Foundation 网站上的事件列表或联系人列表。

stssync://sts/?ver=version&type=folder-type&cmd=command-name&base-url=sts-url&guid=the-guid&site-name=site-friendly-name&list-name=list-friendly-name&list-url=list-url&user-id=uid

version

必需。应用程序的版本，格式为 x.y。例如，对于 Outlook，此参数的值应为 1.0。x 和 y 值只能包含数字。x 不能以零开头，并且 y 必须为零或其他一些不以零开头的数字序列。

备注

x 和 y 均不能多于两个数字；否则，Outlook 会认为 URL 的格式不正确。第三方客户端应用程序可以使用此参数，但在构建 URL 时，此参数必须具有一个值，否则会认为该 URL 的格式不正确。

folder-type

必需。可以是 calendar 或 contacts，具体取决于要添加到 Outlook 或第三方应用程序中的 SharePoint 列表的类型。此参数不区分大小写。

command-name

必需。Outlook 或第三方应用程序可理解的命令名称。指定 add-folder 可向 Outlook 中添加文件夹。稍后可以向 Outlook 中添加更多命令。

sts-url

必需。指向要添加的 SharePoint 网站的 URL。该 URL 不应以斜线 (/) 字符结束。

the-guid

必需。在与 sts-url 参数配对时，唯一标识 SharePoint 列表的 GUID。Outlook 希望此参数的格式为："{"+ 8 个十六进制字符 +"-"+ 4 个十六进制字符 +"-"+ 4 个十六进制字符 +"-"+ 12 个十六进制字符 +"}"。如果此参数采用其他格式，则 Outlook 会认为此 URL 的格式不正确并返回一个错误。

site-friendly-name

必需。包含要添加的列表的网站的显示名称。Outlook 使用此参数来创建文件夹名称。

list-friendly-name

必需。要添加的列表的显示名称。Outlook 使用此参数来创建文件夹名称。

list-url

必需。一个字符串，将该字符串添加到 sts-url 参数中可为列表创建完整 URL。该 URL 应以斜线 (/) 字符开头。

uid

可选。一个大于零的数字，其位数少于八位。只表示 SharePoint 网站上的用户。

注释

  • 特殊字符转义：如果"&"、"\"、"["、"]"或"|"字符中的任一字符是 sts-url、site-friendly-name、list-friendly-name 或 list-url 参数的值的一部分，则该字符必须位于"|"（竖线）之后。例如，Dan [Wilson] - Business\Personal Contacts 的列表友好名称将变为 Dan |[Wilson|] - Business|\Personal Contacts。

  • sts-url、site-friendly-name、list-friendly-name 和 list-url 参数可以包含 Unicode 字符。但是，Unicode 字符必须用中括号"[ ]"括起，并且必须是 Unicode 字符的 4 位十六进制字符表示形式。

  • 若要实现可使用 stssync 协议来添加和同步 SharePoint 网站上的事件和联系人列表的第三方客户端，通常必须实现名为 StssyncHandler 的 ActiveX 控件并提供对 stssync 协议的支持。第三方客户端通常必须能够对 URL 进行解码并同步 SharePoint 网站上的联系人或事件列表。可以使用 Microsoft.SharePoint 命名空间或 SharePoint Foundation 公开的 Web 服务来执行此任务。还必须使用应用程序的可执行文件的名称在注册表中对 stssync 协议进行注册。如果您运行的是装有 Windows Internet Explorer 5.0 或更高版本的 Windows 操作系统，则可以使用下面的代码示例。将该代码复制到 .reg 文件中，并用希望将事件和联系人与 SharePoint Foundation 同步的应用程序的可执行文件的路径替换 <Path to exe>。然后双击该 .reg 文件以便在计算机上注册 stssync 协议。

    Windows Registry Editor Version 5.00

[HKEY_CLASSES_ROOT\stssync]
@="URL:Add SharePoint Folder"
"URL Protocol"=""

[HKEY_CLASSES_ROOT\stssync\shell]
@="open"

[HKEY_CLASSES_ROOT\stssync\shell\open]
@=""

[HKEY_CLASSES_ROOT\stssync\shell\open\command]
@="<Path to exe> \"%1\""

    有关安装 Microsoft Office 期间安装在客户端计算机上的 StssyncHandler 控件的信息，请参阅 StssyncHandler 控件。

示例

stssync://sts/?ver=1.0&type=calendar&cmd=
add-folder&base-url=http%3A%2F%2Fspserver1&list-url=
%2FLists%2FEvts%2FAllItems%2Easpx&guid=
%7BAA7D945C%2DE5C3%2D4854%2DB631%2D10A98E711E2B%7D&site-
name=Share|%7CPoint%20|%5BSite|%5D&list-name=Ev[00E900F1]ts

此 URL 针对的是名为"Share|Point [Site]"的网站上的名为"Evéñts"的列表，其中网站 URL 为 http://spserver1，而列表 URL 为 http://spserver1/Lists/Evts/AllItems.aspx。请注意，使用垂直栏对"|"、"["和"]"字符进行转义，并对列表名称中的两个 Unicode 字符使用十六进制表示形式。