Protocolo Stssync
Última modificación: miércoles, 20 de octubre de 2010
Hace referencia a: SharePoint Foundation 2010
El protocolo stssync permite agregar una lista de eventos o una lista de contactos de un sitio de Microsoft SharePoint Foundation a Microsoft Outlook o a una aplicación de terceros compatible con el protocolo.
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 |
Obligatorio. Es la versión de la aplicación con el formato x.y. Por ejemplo, para Outlook, el valor de este parámetro debe ser 1.0. Los valores x e y deben estar compuestos solo por números. x no puede empezar por cero e y debe ser cero o cualquier otra secuencia de dígitos que no empiece por cero. .gif "Nota") Nota
x e y no pueden tener más de dos dígitos respectivamente; en caso contrario, Outlook considera que la dirección URL no está formada correctamente. Una aplicación cliente de terceros puede usar este parámetro, pero al construir la dirección URL, el parámetro debe tener un valor (si no es así, se considera que la dirección URL no está formada correctamente).
|
folder-type |
Obligatorio. Puede ser calendar o contacts en función del tipo de lista de SharePoint que se agregue a Outlook o a una aplicación de terceros. Este parámetro no distingue mayúsculas de minúsculas. |
command-name |
Obligatorio. Es el nombre de comando que Outlook o la aplicación de terceros entiende. Especifique add-folder para agregar una carpeta a Outlook. Se pueden agregar más comandos a Outlook posteriormente. |
sts-url |
Obligatorio. Es la dirección URL al sitio de SharePoint que se va a agregar. No puede terminar con el carácter de barra diagonal (/). |
the-guid |
Obligatorio. Es el GUID que, emparejado con el parámetro sts-url, identifica de forma única una lista de SharePoint. Outlook espera que este parámetro tenga el siguiente formato: "{"+ 8 caracteres hexadecimales + "-" + 4 caracteres hexadecimales + "-" + 4 caracteres hexadecimales + "-" + 12 caracteres hexadecimales + "}". Si este parámetro tiene otro formato, Outlook considera que la dirección URL no está formada correctamente y devuelve un error. |
site-friendly-name |
Obligatorio. Es el nombre para mostrar del sitio que contiene la lista que se va a agregar. Outlook usa este parámetro para crear el nombre de la carpeta. |
list-friendly-name |
Obligatorio. Es el nombre para mostrar de la lista que se va a agregar. Outlook usa este parámetro para crear el nombre de la carpeta. |
list-url |
Obligatorio. Es una cadena que se agrega al parámetro sts-url para crear la dirección URL completa para la lista. Debe empezar con un carácter de barra diagonal (/). |
uid |
Opcional. Es un número mayor que cero, con menos de ocho dígitos. Representa de forma única a un usuario del sitio de SharePoint. |
Notas
Escape de caracteres especiales: si alguno de los caracteres "&", "\", "[", "]" o "|" forma parte del valor de los parámetros sts-url, site-friendly-name, list-friendly-name o list-url, dicho carácter debe ir precedido por un carácter de barra vertical "|". Por ejemplo, el nombre descriptivo de lista de Dan [Wilson] - Business\Personal Contacts debe ser Dan |[Wilson|] - Business|\Personal Contacts.
Los parámetros sts-url, site-friendly-name, list-friendly-name y list-url pueden contener caracteres Unicode. No obstante, los caracteres Unicode deben ir entre corchetes "[ ]" y ser representaciones de caracteres hexadecimales de 4 dígitos de los caracteres Unicode.
Para implementar un cliente de terceros que pueda usar el protocolo stssync para agregar y sincronizar las listas de eventos y contactos de un sitio de SharePoint, normalmente es necesario implementar un control ActiveX llamado StssyncHandler y admitir el protocolo stssync. Por lo general, el cliente de terceros debe poder descodificar la dirección URL y sincronizar la lista de contactos o eventos del sitio de SharePoint. Puede usar el espacio de nombres Microsoft.SharePoint o los servicios web expuestos por SharePoint Foundation para realizar esta tarea. Además, debe registrar el protocolo stssync en el Registro con el nombre del archivo ejecutable de la aplicación. Si ejecuta el sistema operativo de Windows con la versión 5.0 o posterior de Windows Internet Explorer, puede usar el ejemplo de código que se incluye a continuación. Copie el código en un archivo .reg y reemplace <Path to exe> por la ruta de acceso al archivo ejecutable de la aplicación que va a sincronizar los eventos y contactos con SharePoint Foundation. A continuación, haga doble clic en el archivo .reg para registrar el protocolo stssync en el equipo.
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\""Para obtener información acerca del control StssyncHandler que se instala en el equipo cliente durante la instalación de Microsoft Office, vea Control StssyncHandler.
Ejemplo
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
Esta dirección URL es para una lista con el nombre "Evéñts" de un sitio con el nombre "Share|Point [Site]" con la dirección URL de sitio http://spserver1 y la dirección URL de lista http://spserver1/Lists/Evts/AllItems.aspx. Observe el uso de la barra vertical para especificar el escape de los caracteres "|", "[" y "]", y la representación hexadecimal de los dos caracteres Unicode del nombre de la lista.