Seguir conteúdo no SharePoint

Saiba mais sobre tarefas comuns de programação para acompanhar o conteúdo (documentos, sites e marcas) no SharePoint.

APIs para acompanhar o conteúdo no SharePoint

Quando os usuários seguem documentos, sites ou marcas, atualizações de status de documentos, conversas em sites e notificações da marca usam Mostrar em seu newsfeed. Os recursos relacionados ao conteúdo a seguir podem ser vistos no news feed e as páginas de conteúdo a seguir.

O SharePoint fornece as seguintes APIs que você pode usar para acompanhar programaticamente o conteúdo:

  • Modelos de objeto do cliente para código gerenciado

    • Modelo de objeto do cliente .NET

    • Modelo de objeto do cliente Silverlight

    • Modelo de objeto do cliente móvel

  • Modelo de objeto do JavaScript

  • Serviço de Representational State Transfer (REST)

  • Modelo de objeto de servidor

Como prática recomendada no desenvolvimento do SharePoint, use APIs do cliente, sempre que possível. APIs do cliente incluem modelos de objeto do cliente, um modelo de objeto JavaScript e um serviço REST. Para obter mais informações sobre as APIs no SharePoint e quando usá-las, consulte Escolher o conjunto de API certo no SharePoint.

Cada API inclui um objeto Gerenciador de que você usa para executar tarefas de núcleo de conteúdo a seguir.

Observação

[!OBSERVAçãO] As APIs do mesmas são usadas para seguir pessoas. Consulte Seguir pessoas no SharePoint para obter uma visão geral das tarefas de Following People.

A tabela 1 mostra o gerente e outros objetos de chave (ou recursos REST) nas APIs e a biblioteca de classes (ou ponto de acesso) onde você pode encontrá-los.

Observação

[!OBSERVAçãO] Modelos de objeto do cliente móvel e do Silverlight não são incluídos na tabela 1 ou tabela 2 porque eles fornecem a mesma funcionalidade de núcleo como o modelo de objeto do cliente .NET e usam as mesmas assinaturas. Modelo de objeto do cliente do Silverlight é definido em Microsoft.SharePoint.Client.UserProfiles.Silverlight.dll e o modelo de objeto do cliente móvel é definido em Microsoft.SharePoint.Client.UserProfiles.Phone.dll.

Tabela 1. APIs do SharePoint usadas para acompanhar o conteúdo programaticamente

API Objetos-chave
Modelo de objeto do cliente .NET
Confira: Como acompanhar documentos e sites usando o modelo de objeto cliente .NET no SharePoint
Objeto Manager: SocialFollowingManager
Namespace primário: Microsoft.SharePoint.Client.Social
Outros objetos principais: SocialActor , SocialActorInfo , SocialActorType , SocialActorTypes
Biblioteca de classes: Microsoft.SharePoint.Client.UserProfiles.dll
Modelo de objeto do JavaScript Objeto Manager: SocialFollowingManager
Namespace principal: SP. Redes sociais
Outros objetos principais: SocialActor, SocialActorInfo, SocialActorType, SocialActorTypes
Biblioteca de classes: SP.UserProfiles.js
Serviço REST
Veja Como seguir documentos, sites e marcas usando o serviço REST no SharePoint
Recurso do gerente: social.following
OData (Namespace primário): sp.social.SocialRestFollowingManager
Outros recursos importantes: SocialActor, SocialActorInfo, SocialActorType, SocialActorTypes
Ponto de acesso: <siteUri>/_api/social.following
Modelo de objeto do servidor Objeto Manager: SPSocialFollowingManager
Namespace primário: Microsoft.Office.Server.Social
Outros objetos chave: SPSocialActor , SPSocialActorInfo , SPSocialActorType , SPSocialActorTypes
Biblioteca de classes: Microsoft.Office.Server.UserProfiles.dll

Tarefas de programação comuns para acompanhar o conteúdo no SharePoint

A Tabela 2 mostra tarefas de programação comuns para o conteúdo a seguir e os membros que você usa para executá-los. Membros são provenientes do modelo de objeto do cliente .NET (CSOM), o modelo de objeto de JavaScript (JSOM), serviço REST e modelo de objeto do servidor (SSOM).

Observação

[!OBSERVAçãO] As APIs do mesmas são usadas para seguir pessoas. Consulte Seguir pessoas no SharePoint para obter uma visão geral das tarefas de Following People.

Tabela 2. API para tarefas comuns para seguir o conteúdo no SharePoint

Tarefa Members
Criar uma instância de um objeto do Gerenciador no contexto do usuário atual CSOM: SocialFollowingManager
JSOM: SocialFollowingManager
DESCANSO: <siteUri>/_api/social.following
SSOM: SPSocialFollowingManager
Criar uma instância de um objeto de gerente no contexto de um usuário especificado CSOM: não implementado
JSOM: não foi implementado
REST: não implementado
SSOM: SPSocialFollowingManager (sobrecarregado)
Fazer com que o usuário atual comece a seguir (pare de seguir) um item CSOM: Siga ( StopFollowing )
JSOM: follow ( stopFollowing)
REST: POST<siteUri>/_api/social.following/Follow ( <siteUri>/_api/social.following/StopFollowing) e passa o parâmetro ator no corpo da solicitação
SSOM: Siga ( StopFollowing )
Descobrir se o usuário atual está seguindo um item específico CSOM: IsFollowed
JSOM: isFollowed
REST: POST<siteUri>/_api/social.following/IsFollowed e passe o parâmetro ator no corpo da solicitação
SSOM: IsFollowed
Obter os documentos, sites e/ou marcas que o usuário atual está seguindo CSOM: GetFollowed
JSOM: getFollowed
REST: GET<siteUri>/_api/social.following/my/Followed(types=2) (documentos = 2, sites = 4, marcas = 8.md)
SSOM: GetFollowed
Obtenha a contagem de documentos, sites e/ou marcas que o usuário está seguindo CSOM: GetFollowedCount
JSOM: getFollowedCount
REST: GET<siteUri>/_api/social.following/my/FollowedCount(types=2) (documentos = 2, sites = 4, marcas = 8.md)
SSOM: GetFollowedCount
Obter o URI do site que lista os documentos seguidos pelo usuário atual CSOM: FollowedDocumentsUri
JSOM: followedDocumentsUri
REST: OBTER<siteUri>/_api/social.following/my/FollowedDocumentsUri
SSOM: FollowedDocumentsUri
Obtenha o URI do site que lista os sites seguidos pelo usuário atual CSOM: FollowedSitesUri
JSOM: followedSitesUri
REST: OBTER<siteUri>/_api/social.following/my/FollowedSitesUri
SSOM: FollowedSitesUri

Observação

Para obter exemplos que mostram como usar o serviço REST para seguir o conteúdo, consulte Como seguir documentos, sites e marcas usando o serviço REST no SharePoint.

Como obter o GUID de uma marca com base no nome da marca usando o modelo de objeto JavaScript

Para começar e parar de seguir uma tag ou para descobrir se o usuário atual a está seguindo, você precisa usar o GUID da tag. O código a seguir mostra como obter o GUID com base no nome da marca.

Antes de executar o código, você precisa adicionar uma referência a sp.taxonomy.js e alterar o nome da marca de espaço reservado com o nome de uma marca 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());
        }
    );
}

Confira também