Stssync プロトコル
最終更新日: 2015年3月9日
適用対象: SharePoint Foundation 2010
stssync プロトコルを使用すると、Microsoft SharePoint Foundation サイト上にあるイベント リストまたは連絡先リストを、Microsoft Outlook またはこのプロトコルをサポートしているサードパーティ製のアプリケーションに追加することができます。
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 を 0 で始めることはできません。y は 0 であるか、0 で始まらない一連の数字であることが必要です。 注意 x と y は、それぞれ 3 桁以上にできません。3 桁以上にすると、Outlook で URL の形式が正しくないと見なされます。サードパーティ製のクライアント アプリケーションによってこのパラメーターが使用されている場合がありますが、URL を作成する場合は、このパラメーターには必ず値が必要です。値がないと、その URL は形式が正しくないと見なされます。 |
folder-type |
必須。Outlook またはサードパーティ製のアプリケーションに追加する SharePoint リストの種類に応じて、calendar または contacts を指定できます。このパラメーターは、大文字と小文字が区別されます。 |
command-name |
必須。Outlook またはサードパーティ製のアプリケーションが理解できるコマンド名。Outlook にフォルダーを追加するには、add-folder を指定します。Outlook には、今後、さらにコマンドが追加される可能性があります。 |
sts-url |
必須。追加される SharePoint サイトの URL。末尾がスラッシュ (/) 文字になることはできません。 |
the-guid |
必須。sts-url パラメーターと組み合わせた場合に SharePoint リストを一意に識別する GUID。Outlook は、このパラメーターが "{"+ 8 つの 16 進数文字 + "-" + 4 つの 16 進数文字 + "-" + 4 つの 16 進数文字 + "-" + 12 個の 16 進数文字 + "}" という形式になっているものとして処理を行います。このパラメーターが異なる形式になっている場合、Outlook は、URL の形式が正しくないと判断し、エラーを返します。 |
site-friendly-name |
必須。追加されるリストを含むサイトの表示名。Outlook は、このパラメーターを使用してフォルダー名を作成します。 |
list-friendly-name |
必須。追加されるリストの表示名。Outlook は、このパラメーターを使用してフォルダー名を作成します。 |
list-url |
必須。リストの完全な URL を作成するために sts-url パラメーターに追加される文字列。スラッシュ (/) 文字で始まる必要があります。 |
uid |
オプション。0 より大きく 7 桁以下の数字。SharePoint サイト上のユーザーを一意に表します。 |
メモ
特殊文字のエスケープ: sts-url パラメーター、site-friendly-name パラメーター、list-friendly-name パラメーター、または list-url パラメーターの値に "&"、"\"、"[", "]"、"|" のいずれかの文字を含める場合、その前に "|" (パイプ) 文字を置く必要があります。たとえば、list-friendly-name に Dan [Wilson] - Business\Personal Contacts を使用する場合、Dan |[Wilson|] - Business|\Personal Contacts と指定します。
sts-url パラメーター、site-friendly-name パラメーター、list-friendly-name パラメーター、および list-url パラメーターには、Unicode 文字を含めることができます。ただし、Unicode 文字は角かっこ "[ ]" で囲み、Unicode 文字を表す 4 桁の 16 進数にする必要があります。
stssync プロトコルを使用して、Share Point サイト上にあるイベント リストおよび連絡先リストを追加し、それを同期させるサードパーティ製クライアントを実装するには、通常、StssyncHandler という ActiveX コントロールを実装して、stssync プロトコルのサポートを提供する必要があります。サードパーティ製クライアントは、一般に、URL をデコードすることができ、SharePoint サイト上の連絡先リストまたはイベント リストと同期できる必要があります。これを行うには、Microsoft.SharePoint 名前空間または SharePoint Foundation により公開されている Web サービスを使用します。また、stssync プロトコルをアプリケーションの実行可能ファイルの名前でレジストリに登録する必要もあります。Windows Internet Explorer 5.0 以降が搭載されている Windows オペレーティング システムを実行している場合は、以下のコード例を使用できます。以下のコードを .reg ファイルにコピーし、<Path to exe> を、SharePoint Foundation との間でイベントと連絡先を同期したいアプリケーションの実行可能ファイルのパスに置き換えます。次に, .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]" という名前のサイト上にある、http://spserver1 および http://spserver1/Lists/Evts/AllItems.aspx というリスト URL を持つ "Evéñts" という名前のリスト用のものです。"|"、"["、および "]" の文字をエスケープするために縦線を使用しており、リスト名に含まれる 2 つの Unicode 文字を表すために 16 進数を使用しています。