Seguir contenido en SharePoint
Obtenga información sobre las tareas de programación comunes para seguir el contenido (documentos, sitios y etiquetas) en SharePoint.
API para seguir el contenido en SharePoint
Cuando los usuarios seguir documentos, sitios o etiquetas, las actualizaciones de estado de los documentos, las conversaciones de los sitios y las notificaciones de etiqueta de consumir mostrar en su suministro de noticias. Las funciones relacionadas con el contenido siguiente pueden verse en el suministro de noticias y las páginas de contenido siguiente.
SharePoint proporciona las siguientes API que puede usar para seguir el contenido mediante programación:
Modelos de objetos de cliente para código administrado
El modelo de objetos de cliente de .NET
Modelo de objetos de cliente de Silverlight
Modelo de objetos de cliente móvil
Modelo de objetos JavaScript
Servicio Transferencia de estado representacional (REST)
Modelo de objetos de servidor
Como práctica recomendada para el desarrollo de SharePoint, use API de cliente siempre que pueda. Las API de cliente incluyen los modelos de objetos de cliente, un modelo de objetos JavaScript y un servicio REST. Para obtener más información sobre las API en SharePoint y cuándo usarlas, vea Elegir el conjunto de API adecuado en SharePoint.
Cada API incluye un objeto de administrador que se usa para realizar las tareas básicas para el contenido siguiente.
Nota:
[!NOTA] Las mismas API se utilizan para seguir a personas. Consulte Seguimiento de personas en SharePoint para obtener información general sobre las tareas Siguientes personas.
Tabla 1 muestra el administrador y otros objetos clave (o recursos de REST) en las API y la biblioteca de clases (o punto de acceso) dónde se puede encontrar.
Nota:
[!NOTA] Los modelos de objetos de cliente de Silverlight y de cliente móvil no están incluidos en la tabla 1 ni la 2 porque ofrecen la misma funcionalidad principal que el modelo de objetos de cliente de .NET y usan las mismas firmas. El modelo de objetos de cliente de Silverlight se define en Microsoft.SharePoint.Client.UserProfiles.Silverlight.dll y el modelo de objetos de cliente móvil en Microsoft.SharePoint.Client.UserProfiles.Phone.dll.
Tabla 1. API de SharePoint usadas para seguir contenido mediante programación
API | Objetos clave |
---|---|
El modelo de objetos de cliente de .NET Vea: Procedimiento para seguir documentos y sitios mediante el modelo de objetos de cliente .NET en SharePoint |
Objeto Manager: SocialFollowingManager Espacio de nombres principal: Microsoft.SharePoint.Client.Social Otros objetos clave: SocialActor , SocialActorInfo , SocialActorType , SocialActorTypes Biblioteca de clases: Microsoft.SharePoint.Client.UserProfiles.dll |
Modelo de objetos JavaScript | Objeto Manager: SocialFollowingManager Espacio de nombres principal: SP. Social Otros objetos clave: SocialActor, SocialActorInfo, SocialActorType, SocialActorTypes Biblioteca de clases: SP.UserProfiles.js |
Servicio REST Vea How to: Follow documents, sites, and tags by using the REST service in SharePoint (Cómo: Seguir documentos, sitios y etiquetas mediante el servicio REST en SharePoint) |
Recurso del administrador: social.following Espacio de nombres principal (OData): sp.social.SocialRestFollowingManager Otros recursos clave: SocialActor, SocialActorInfo, SocialActorType, SocialActorTypes Punto de acceso: <siteUri>/_api/social.following |
Modelo de objetos de servidor | Objeto manager: SPSocialFollowingManager Espacio de nombres principal: Microsoft.Office.Server.Social Otros objetos clave: SPSocialActor , SPSocialActorInfo , SPSocialActorType , SPSocialActorTypes Biblioteca de clases: Microsoft.Office.Server.UserProfiles.dll |
Tareas de programación comunes para seguir el contenido en SharePoint
La tabla 2 muestra tareas de programación comunes en el seguimiento de contenido y los miembros que se usan para llevarlas a cabo. Los miembros pertenecen al modelo de objetos de cliente .NET (CSOM), al modelo de objetos JavaScript (JSOM), al servicio REST y al modelo de objetos de servidor (SSOM).
Nota:
[!NOTA] Las mismas API se utilizan para seguir a personas. Consulte Seguimiento de personas en SharePoint para obtener información general sobre las tareas Siguientes personas.
Tabla 2. API para tareas comunes para seguir el contenido en SharePoint
Tarea | Members |
---|---|
Crear una instancia de un objeto de administrador en el contexto del usuario actual | CSOM: SocialFollowingManager JSOM: SocialFollowingManager REPOSO: <siteUri>/_api/social.following SSOM: SPSocialFollowingManager |
Crear una instancia de un objeto de administrador en el contexto de un usuario especificado | CSOM: no implementado JSOM: no implementado REST: no implementado SSOM: SPSocialFollowingManager (sobrecargado) |
Hacer que el usuario actual empiece el seguimiento de (o deje de seguir) un elemento | CSOM: Follow ( StopFollowing ) JSOM: follow ( stopFollowing) REST: POST <siteUri>/_api/social.following/Follow ( <siteUri>/_api/social.following/StopFollowing ) y pasar el parámetro actor en el cuerpo de la solicitudSSOM: Follow ( StopFollowing ) |
Descubrir si el usuario actual está siguiendo un objeto en particular | CSOM: IsFollowed JSOM: isFollowed REST: POST <siteUri>/_api/social.following/IsFollowed y pase el parámetro actor en el cuerpo de la solicitud.SSOM: IsFollowed |
Obtener los documentos, sitios y etiquetas que está siguiendo el usuario actual | CSOM: GetFollowed JSOM: getFollowed REST: GET <siteUri>/_api/social.following/my/Followed(types=2) (documents = 2, sites = 4, tags = 8.md)SSOM: GetFollowed |
Obtener el recuento de documentos, sitios y etiquetas que está siguiendo el usuario | CSOM: GetFollowedCount JSOM: getFollowedCount REST: GET <siteUri>/_api/social.following/my/FollowedCount(types=2) (documents = 2, sites = 4, tags = 8.md)SSOM: GetFollowedCount |
Obtener el URI del sitio que enumera los documentos seguidos por el usuario actual | CSOM: FollowedDocumentsUri JSOM: followedDocumentsUri REST: GET <siteUri>/_api/social.following/my/FollowedDocumentsUri SSOM: FollowedDocumentsUri |
Obtener el URI del sitio que enumera los sitios seguidos por el usuario actual | CSOM: FollowedSitesUri JSOM: followedSitesUri REST: GET <siteUri>/_api/social.following/my/FollowedSitesUri SSOM: FollowedSitesUri |
Nota:
Para obtener ejemplos que muestran cómo usar el servicio REST para seguir el contenido, vea How to: Follow documents, sites, and tags by using the REST service in SharePoint (Cómo: Seguir documentos, sitios y etiquetas mediante el servicio REST en SharePoint).
Cómo obtener el GUID de la etiqueta basada en el nombre de la etiqueta mediante el modelo de objetos de JavaScript
Para iniciar y Detener seguimiento de una etiqueta o para averiguar si sigue el usuario actual, tiene que usar el GUID de la etiqueta. El código siguiente muestra cómo obtener el GUID que se basa en el nombre de etiqueta.
Antes de ejecutar el código, debe agregar una referencia a sp.taxonomy.js y cambie el nombre de etiqueta de marcador de posición con el nombre de una etiqueta existente.
function getTagGuid() {
var tagName = '#tally';
var clientContext = new SP.ClientContext.get_current();
var label = SP.Taxonomy.LabelMatchInformation.newObject(clientContext);
label.set_termLabel(tagName);
label.set_trimUnavailable(false);
var taxSession = SP.Taxonomy.TaxonomySession.getTaxonomySession(clientContext);
var termStore = taxSession.getDefaultKeywordsTermStore();
var termSet = termStore.get_hashTagsTermSet();
terms = termSet.getTerms(label);
clientContext.load(terms);
clientContext.executeQueryAsync(
function () {
var tag = terms.get_item(0);
if (tag !== null) {
var tagGuid = tag.get_id().toString();
if (!SP.ScriptUtility.isNullOrEmptyString(tagGuid)) {
alert(tagGuid);
}
}
},
function (sender, args) {
alert(args.get_message());
}
);
}