Cadenas de URL y tokens en complementos de SharePoint
Importante
Para obtener información general sobre la construcción de direcciones URL en SharePoint y el uso de tokens en estas direcciones, vea Direcciones URL y tokens en SharePoint. En este tema se describen los tokens que se encuentran disponibles en complementos de SharePoint.
SharePoint admite el uso de los tokens que se indican en las tablas siguientes en complementos de SharePoint.
Los tokens de las tablas de esta sección pueden usarse en las direcciones URL en situaciones de desarrollo de complementos de SharePoint muy diversas, tales como las acciones personalizadas y los vínculos de páginas personalizadas.
En algunos contextos, algunos de estos tokens no se pueden usar. Tres de los lugares más importantes en los que solo puede usarse una lista restringida de tokens son la página de inicio de un complemento, una acción personalizada en la web de host y la propiedad Src de un elemento de complemento. Se denominan en columnas independientes, pero no se trata de una lista exhaustiva de lugares donde se pueden usar tokens.
En cada tabla:
- En la columna StartPage se especifica si el token puede usarse en el elemento StartPage de un manifiesto de complemento.
- En la columna Acción personalizada se especifica si el token puede usarse en la dirección URL de una acción personalizada en una web de host.
- En la columna Elemento de complemento se especifica si el token puede usarse en la propiedad Src del elemento de complemento.
Tokens que se pueden usar al principio de una dirección URL
| Token | Da como resultado | StartPage | Acción personalizada | Elemento de complemento | Comentarios |
|---|---|---|---|---|---|
| ~appWebUrl | Dirección URL del sitio web de complemento de un complemento de SharePoint. | Sí | Sí | Sí | Este token se debe usar únicamente fuera de los sitios web de complemento. Use ~site dentro del sitio web de complemento para la dirección URL del sitio web de complemento. |
| ~controlTemplates | Dirección URL de la carpeta virtual ControlTemplates para el sitio web actual. | No | No | No | |
| ~hostUrl | Dirección URL de la web de host. | No | No | Sí | |
| ~hostLogoUrl | Dirección URL del logotipo de la web de host. | No | No | No | |
| ~layouts | Dirección URL de la carpeta virtual Layouts para el sitio web actual. | No | No | No | |
| ~remoteAppUrl | Dirección URL de una aplicación web remota en un complemento de SharePoint. | Sí | Sí, en la web de host, pero no en la web de complemento. | Sí | Si no está usando Microsoft Office Developer Tools para Visual Studio para desarrollar el complemento de SharePoint, no puede usar ~remoteAppUrl en la dirección URL StartPage. Sin embargo, cuando use Visual Studio y las herramientas, podrá usar este token para cualquier complemento que se hospede en un proveedor y se resuelve cuando Visual Studio empaqueta el complemento. En este uso, se trata más de un token de Visual Studio que de un token de SharePoint. Se puede usar fuera del manifiesto del complemento aunque no use Microsoft Office Developer Tools para Visual Studio. |
| ~site | Dirección URL del sitio web actual. | No | No | Sí | |
| ~sitecollection | Dirección URL de la colección del sitio primario del sitio web actual. | No | No | Sí |
Excepto cuando se indique lo contrario, ninguno de los tokens de la tabla siguiente se puede usar en la parte de ruta de acceso del valor de propiedad Src del elemento del complemento. La columna Elemento de complemento hace referencia al uso en la porción cadena de consulta del valor.
Tokens que se pueden usar en una dirección URL
| Token | Da como resultado | StartPage | Acción personalizada | Elemento de complemento | Comentarios |
|---|---|---|---|---|---|
| {AppContextToken} | Token de contexto OAuth para el complemento. | No | No | No | |
| {AppWebUrl} | Dirección URL del sitio web de complemento de un complemento de SharePoint. | Sí | Sí | Sí | Este token solo debe usarse fuera de una web de complemento. En la propia web de complemento, use {Site} como dirección URL de la web de complemento. |
| {ClientTag} | Número de control de la caché de cliente (etiqueta del cliente) para el sitio web actual. | Sí | Sí | Sí | |
| {HostLogoUrl} | Logotipo para el sitio web host de un complemento de SharePoint. | Sí | Sí | Sí | |
| {HostTitle} | Título del sitio web host de un complemento de SharePoint. | Sí | Sí | Sí | |
| {HostUrl} | Dirección URL del sitio web host de un complemento de SharePoint. | Sí | Sí | Sí | |
| {ItemId} | Identificador de un elemento en una lista o biblioteca (entero). | No | Sí | No | |
| {ItemUrl} | Dirección URL de un elemento sobre el que se realiza una acción. | No | Sí | No | |
| {Language} | Idioma o referencia cultural actual de un sitio web host de un complemento de SharePoint. | Sí | Sí | Sí | |
| {ListId} | Identificador de la lista actual (un GUID). | No | Sí | No | |
| {ProductNumber} | Número completo de la versión de compilación de la granja de SharePoint. | Sí | Sí | Sí | Un valor de ejemplo es "15.0.4433.1011". |
| {RecurrenceId} | Índice de recurrencia de un evento recurrente. | No | Sí | No | Este token no se admite para usarlo en los menús contextuales de los elementos de lista. |
| {RemoteAppUrl} | Dirección URL de una aplicación web remota en un complemento de SharePoint. | Sí | Sí | Sí | |
| {Site} | Dirección URL del sitio web actual. | No | Sí | Sí | |
| {SiteCollection} | Dirección URL del sitio primario del sitio web actual. | No | Sí | Sí | |
| {SiteUrl} | Dirección URL del sitio web actual. | No | Sí | No | |
| {Source} | Dirección URL de la solicitud HTTP. | No | Sí | No | |
| {StandardTokens} | Consulte Comentarios. | Sí | Sí | Sí | Combina otros cinco tokens. Inicialmente, da como resultado... SPHostUrl={HostUrl}&SPAppWebUrl={AppWebUrl}&SPLanguage={Language}&SPClientTag={ClientTag}&SPProductNumber={ProductNumber} ...y luego se resuelve cada uno de estos tokens. Si no hay ninguna web de complemento, la parte &SPAppWebUrl={AppWebUrl} no está presente. |