Stssync, protocole

  • Article

Dernière modification : mercredi 20 octobre 2010

S’applique à : SharePoint Foundation 2010

Le protocole stssync vous permet d’ajouter une liste d’événements ou de contacts qui existe sur un site Microsoft SharePoint Foundation à Microsoft Outlook ou à une application tierce qui prend en charge le protocole.

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

Obligatoire. Version de l’application au format x.y. Par exemple, pour Outlook, la valeur de ce paramètre doit être 1.0. Les valeurs x et y doivent être composées de chiffres uniquement. x ne doit pas commencer par un zéro, et y doit être zéro ou une autre séquence de chiffres qui ne commence pas par un zéro.

RemarqueRemarque
x et y ne peuvent pas contenir plus de deux chiffres ; sinon, Outlook considère que l’URL est mal formée. Une application cliente tierce peut utiliser ce paramètre. Cependant, lorsque l’URL est construite, le paramètre doit avoir une valeur, sinon l’URL est considérée comme étant mal formée.

folder-type

Obligatoire. Peut être calendar ou contacts, selon le type de liste SharePoint ajoutée à Outlook ou à une application tierce. Ce paramètre ne respecte pas la casse.

command-name

Obligatoire. Le nom de la commande comprise par Outlook ou l’application tierce. Spécifiez add-folder pour ajouter un dossier à Outlook. Plusieurs commandes peuvent être ajoutées à Outlook ultérieurement.

sts-url

Obligatoire. L’URL du site SharePoint qui est ajouté. Elle ne doit pas se terminer par une barre oblique (/).

the-guid

Obligatoire. Le GUID qui, lorsqu’il est associé au paramètre sts-url, identifie de façon unique une liste SharePoint. Outlook attend ce paramètre au format suivant : "{"+ 8 caractères hexadécimaux + "-" + 4 caractères hexadécimaux + "-" + 4 caractères hexadécimaux + "-" + 12 caractères hexadécimaux + "}". Si ce paramètre a un autre format, Outlook considère que l’URL est incorrecte et retourne une erreur.

site-friendly-name

Obligatoire. Nom complet du site qui contient la liste qui est ajoutée. Outlook utilise ce paramètre pour créer le nom du dossier.

list-friendly-name

Obligatoire. Nom complet de la liste qui est ajoutée. Outlook utilise ce paramètre pour créer le nom du dossier.

list-url

Obligatoire. Chaîne qui est ajoutée au paramètre sts-url pour créer l’URL complète de la liste. Elle doit commencer par une barre oblique (/).

uid

Facultatif. Un nombre supérieur à zéro, composé de moins de huit chiffres. Représente de manière unique un utilisateur sur le site SharePoint.

Remarques

  • Échappement de caractère spécial : si un des caractères « & », « \ », « [ », « ] » ou « | » fait partie de la valeur des paramètres sts-url, site-friendly-name, list-friendly-name ou list-url, le caractère doit être précédé par une barre verticale (« | »). Par exemple, la valeur list-friendly-name Dan [Wilson] - Business\Personal Contacts devient Dan |[Wilson|] - Business|\Personal Contacts.

  • Les paramètres sts-url, site-friendly-name, list-friendly-name et list-url peuvent contenir des caractères Unicode. Toutefois, ces caractères doivent être placés entre crochets (« [ ] ») et doivent être des représentations de caractères hexadécimaux à 4 chiffres des caractères Unicode.

  • Pour implémenter un client tiers qui utilise le protocole stssync afin d’ajouter et de synchroniser des listes d’événements et de contacts qui existent sur un site SharePoint, vous devez implémenter un contrôle ActiveX nommé StssyncHandler et fournir la prise en charge du protocole stssync. En général, le client tiers doit être en mesure de décoder l’URL et synchroniser la liste d’événements ou de contacts sur le site SharePoint. Vous pouvez utiliser l’espace de noms Microsoft.SharePoint ou les services Web exposés par SharePoint Foundation pour effectuer cette tâche. Vous devez aussi enregistrer le protocole stssync dans le Registre avec le nom du fichier exécutable de votre application. Si vous exécutez le système d’exploitation Windows avec Windows Internet Explorer version 5.0 ou ultérieure, vous pouvez utiliser l’exemple de code suivant. Copiez le code dans un fichier .reg et remplacez <Path to exe> par le chemin d’accès au fichier exécutable de l’application qui souhaite synchroniser les événements et les contacts avec SharePoint Foundation. Ensuite, double-cliquez sur le fichier .reg pour enregistrer le protocole stssync sur votre ordinateur.

    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\""

    Pour plus d’informations sur le contrôle StssyncHandler qui est installé sur l’ordinateur client lors de l’installation de Microsoft Office, voir StssyncHandler, contrôle.

Exemple

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

Cette URL permet d'obtenir la liste nommée « Evéñts » sur un site nommé « Share|Point [site] » avec l'URL de site http://spserver1 et l'URL de liste http://spserver1/Lists/Evts/AllItems.aspx. Notez l'utilisation de la barre verticale pour l'échappement des caractères « | », « [ » et « ] » et la représentation hexadécimale des deux caractères Unicode dans le nom de la liste.