SPUser - Classe

Représente un utilisateur dans Microsoft SharePoint Foundation.

Hiérarchie d’héritage

System.Object
  Microsoft.SharePoint.SPMember
    Microsoft.SharePoint.SPPrincipal
      Microsoft.SharePoint.SPUser

Espace de noms :  Microsoft.SharePoint
Assembly :  Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public NotInheritable Class SPUser _
    Inherits SPPrincipal
'Utilisation
Dim instance As SPUser
public sealed class SPUser : SPPrincipal

Remarques

Utilisez la propriété AllUsers de la classe SPWeb pour renvoyer tous les utilisateurs d'un site. Cela inclut les utilisateurs disposant d'autorisations directement, autorisations accordées aux utilisateurs via un groupe ayant visité le site puis et les utilisateurs qui ont été référencés dans un champ de personne, comme étant une tâche affectée. Appel denameAllUsers[] lèvera une exception si l'utilisateur n'y ne figure pas.

Utilisez la propriété SiteUsers de la classe SPWeb pour renvoyer tous les utilisateurs dans la collection de sites.

Utilisez la méthode GetAllAuthenticatedUsers de la classe SPUtility pour renvoyer tous les utilisateurs authentifiés d'un site.

Utilisez la méthode GetUniqueUsers de la classe SPAlertCollection pour retourner une liste d'utilisateurs pour une collection d'alertes.

Dans le cas contraire, utilisez la propriété Users de la classe SPGroup ou SPWeb pour renvoyer les utilisateurs dans un groupe ou un site.

Pour renvoyer un seul utilisateur à partir de la collection, utilisez un indexeur. Par exemple, si la collection est assignée à une variable nommée collUsers, utilisez collUsers[index] dans C# ou collUsers(index) dans Visual Basic, où index est le numéro d'index de l'utilisateur dans la collection ou le nom d'utilisateur de l'utilisateur.

Chaque utilisateur possède un ID de membre unique (propriétéID ) a les autorisations associées à cette appartenance et peut être représentée par un objet SPMember . L'exemple suivant assigne un utilisateur à un objet SPMember , un site SharePoint Web spécifié :

Dim oWebsite As SPWeb = SPContext.Current.Web
Dim oMember As SPMember = oWebsite.AllUsers("Domain\\User_Alias")
SPWeb oWebsite = SPContext.Current.Web;
SPMember oMember = oWebsite.AllUsers["Domain\\User_Alias"];

Pour obtenir des informations générales sur les utilisateurs et la sécurité, consultez Security, Users, and Groups in Windows SharePoint Services.

Exemples

L'exemple de code suivant modifie l'adresse de messagerie, nom d'affichage et notes pour un objet utilisateur spécifié.

Dim siteCollection As SPSite = SPControl.GetContextSite(Context)
Dim site As SPWeb = siteCollection.AllWebs("Site_Name")
Dim user As SPUser = site.AllUsers("User_Name")

user.Email = "E-mail_Address"
user.Name = "Display_Name"
user.Notes = "User_Notes"

user.Update()
SPSite oSiteCollection = SPContext.Current.Site;
using (SPWeb oWebsite = oSiteCollection.AllWebs["Website_Name"])
{
    SPUser oUser = oWebsite.AllUsers["User_Name"];

    oUser.Email = " E-mail_Address";
    oUser.Name = " Display_Name";
    oUser.Notes = " User_Notes";

    oUser.Update();
}

Notes

Certains objets implémentent l'interface IDisposable , et vous devez éviter de conserver ces objets dans la mémoire après que qu'ils ne sont plus nécessaires. Pour plus d'informations sur les bonnes pratiques de codage, consultez Disposing Objects.

Cohérence de thread

Tous les membres statique (Partagé dans Visual Basic)s publics de ce type sont thread-safe. Cela n’est pas garanti pour les membres d’instance.

Voir aussi

Référence

SPUser - Membres

Microsoft.SharePoint - Espace de noms