Suivre du contenu dans SharePoint
Découvrez les tâches de programmation courantes pour le contenu suivant (documents, sites et balises) dans SharePoint.
API pour le contenu suivant dans SharePoint
Lorsque les utilisateurs suivent des documents, des sites ou des balises, mises à jour d'état à partir de documents conversations sur les sites et les notifications de balise utilisent show dans leur échange de News. Les fonctionnalités liées au contenu suivant peuvent être affichées dans l' échange de News et les pages de contenu suivant.
SharePoint fournit les API suivantes que vous pouvez utiliser pour suivre le contenu par programme :
Modèles objet client pour le code managé
Modèle objet client .NET
Modèle objet client Silverlight
Modèle objet client mobile
Modèle objet JavaScript
Service REST (Representational State Transfer)
Modèle objet serveur
Il est vivement recommandé d'utiliser des API client quand vous le pouvez pour le développement SharePoint. API clientes incluent les modèles objet client, un modèle d'objet JavaScript et un service REST. Pour plus d'informations sur les API proposées dans SharePoint et pour savoir quand les utiliser, voir Choisir l'ensemble d'API approprié dans SharePoint.
Chaque API comprend un objet gestionnaire que vous utilisez pour effectuer des tâches principales pour le contenu suivant.
Notes
[!REMARQUE] The same APIs are used to follow people. Pour obtenir une vue d SharePoint des tâches de suivi des personnes, voir Personnes suivantes dans le site.
Le tableau 1 répertorie les objets gestionnaire et autres objets clés (ou ressources REST) inclus dans les API, ainsi que la bibliothèque de classes (ou point d’accès) où vous pouvez les trouver.
Notes
Les modèles objet client Silverlight et mobile ne sont pas inclus dans les tableaux 1 et 2, car ils fournissent les mêmes fonctionnalités de base que le modèle objet client .NET et utilisent les mêmes signatures. Le modèle objet client Silverlight est défini dans Microsoft.SharePoint.Client.UserProfiles.Silverlight.dll et le modèle objet client mobile est défini dans Microsoft.SharePoint.Client.UserProfiles.Phone.dll.
Tableau 1. SharePoint API utilisées pour le suivi de contenu par programme
| API | Objets clés |
|---|---|
| Modèle objet client .NET Voir : Comment : suivre des documents et des sites à l’aide du modèle objet client .NET dans SharePoint |
Objet gestionnaire : SocialFollowingManager Espace de noms principal : Microsoft.SharePoint.Client.Social Autres objets clés : SocialActor , SocialActorInfo , SocialActorType , SocialActorTypes Bibliothèque de classes : Microsoft.SharePoint.Client.UserProfiles.dll |
| Modèle objet JavaScript | Objet gestionnaire : SocialFollowingManager Espace de noms principal : SP. Mise en réseau Autres objets clés : SocialActor, SocialActorInfo, SocialActorType, SocialActorTypes Bibliothèque de classes : SP.UserProfiles.js |
| Service REST Voir comment : suivre des documents, des sites et des balises à l’aide du service REST dans SharePoint |
Gestionnaire des ressources : social.following Espace de noms principal (OData): sp.social.SocialRestFollowingManager Autres ressources clés : SocialActor, SocialActorInfo, SocialActorType, SocialActorTypes Point d'accès : <siteUri>/_api/social.following |
| Modèle objet serveur | Objet gestionnaire : SPSocialFollowingManager Espace de noms principal : Microsoft.Office.Server.Social Autres objets clés : SPSocialActor , SPSocialActorInfo , SPSocialActorType , SPSocialActorTypes Bibliothèque de classes : Microsoft.Office.Server.UserProfiles.dll |
Tâches de programmation courantes pour le contenu suivant dans SharePoint
Le tableau 2 montre les tâches de programmation courantes pour le contenu suivant ainsi que les membres que vous utilisez pour les exécuter. Les membres sont à partir du modèle d'objet client .NET (CSOM), le modèle d'objet JavaScript (JSOM), service REST et le modèle d'objet serveur (SSOM).
Notes
[!REMARQUE] The same APIs are used to follow people. Pour obtenir une vue d SharePoint des tâches de suivi des personnes, voir Personnes suivantes dans le site.
Tableau 2. API pour les tâches courantes pour le contenu suivant dans SharePoint
| Tâche | Membres |
|---|---|
| Créer une instance d’un objet gestionnaire dans le contexte de l’utilisateur actuel | CSOM : SocialFollowingManager JSOM : SocialFollowingManager REST : <siteUri>/_api/social.following SSOM : SPSocialFollowingManager |
| Créer une instance d'un objet gestionnaire dans le contexte d'un utilisateur spécifié | CSOM : non implémenté JSOM : non implémenté REST : non implémenté SSOM : SPSocialFollowingManager (surchargé) |
| Ont l'utilisateur actuel commencez à suivre (stop ci-dessous) un élément | CSOM : Follow ( StopFollowing ) JSOM : Suivez ( stopFollowing) REST: POST <siteUri>/_api/social.following/Follow ( ) and <siteUri>/_api/social.following/StopFollowing pass the actor parameter in the request body SSOM : Follow ( StopFollowing ) |
| Savoir si l'utilisateur actuel est suite à un élément particulier | CSOM : IsFollowed JSOM : isFollowed REST : POST <siteUri>/_api/social.following/IsFollowed et transmettre le paramètre actor dans le corps de la requête SSOM : IsFollowed |
| Obtenir les documents, les sites et/ou les balises que l'utilisateur actuel est suivi | CSOM : GetFollowed JSOM : getFollowed REST : GET <siteUri>/_api/social.following/my/Followed(types=2) (documents = 2, sites = 4, balises = 8.md) SSOM : GetFollowed |
| Obtenir le nombre de documents, sites et/ou des balises que l'utilisateur suit | CSOM : GetFollowedCount JSOM : getFollowedCount REST : GET <siteUri>/_api/social.following/my/FollowedCount(types=2) (documents = 2, sites = 4, balises = 8.md) SSOM : GetFollowedCount |
| Obtenir l'URI du site qui répertorie les documents suivis de l'utilisateur actuel | CSOM : FollowedDocumentsUri JSOM : followedDocumentsUri REST : GET <siteUri>/_api/social.following/my/FollowedDocumentsUri SSOM : FollowedDocumentsUri |
| Obtenir l'URI du site qui répertorie les sites suivis de l'utilisateur actuel | CSOM : FollowedSitesUri JSOM : followedSitesUri REST : GET <siteUri>/_api/social.following/my/FollowedSitesUri SSOM : FollowedSitesUri |
Notes
Pour obtenir des exemples qui montrent comment utiliser le service REST pour suivre du contenu, voir Comment : suivre des documents, des siteset des balises à l’aide du service REST dans SharePoint .
Comment obtenir le GUID d'une balise basée sur le nom de la balise à l'aide du modèle d'objet JavaScript
Pour démarrer et arrêter suivi d'une balise ou permettant de savoir si l'utilisateur actuel est la suite, vous devez utiliser les GUID de la balise. Le code suivant montre comment obtenir le GUID basé sur le nom de la balise.
Avant d'exécuter le code, vous devez ajouter une référence à sp.taxonomy.js et modifiez le nom de balise d'espace réservé avec le nom d'une balise existante.
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());
}
);
}
Voir aussi
Procédure : suivre des documents et des sites à l’aide du modèle d’objet client .NET dans SharePoint
Procédure : suivre les documents, des sites et des balises à l'aide du service REST en SharePoint
Référence de l’API REST de suivi de personnes et de contenu pour SharePoint
Mise en route du développement avec les fonctions sociales dans SharePoint