SPRole - Classe

Remarque : cette API est désormais obsolète.

Utilisez à la place, les nouvelles classes SPRoleDefinition et SPRoleAssignment pour définir des rôles et de leur affecter des utilisateurs. Pour plus d'informations, consultez Changes in the Authorization Object Model. (Dans Windows SharePoint Services 2.0, SPRole représenté un groupe de sites et est conservé pour la compatibilité descendante).

Hiérarchie d’héritage

System.Object
  Microsoft.SharePoint.SPMember
    Microsoft.SharePoint.SPRole

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

Syntaxe

'Déclaration
<ObsoleteAttribute("Use the SPRoleDefinition class instead")> _
Public Class SPRole _
    Inherits SPMember
'Utilisation
Dim instance As SPRole

[ObsoleteAttribute("Use the SPRoleDefinition class instead")]
public class SPRole : SPMember

Remarques

Utilisez la propriété Roles de la classe SPUser, SPGroupou SPWeb pour renvoyer un objet SPRoleCollection qui représente la collection des rôles ou des définitions de rôles pour un utilisateur, un groupe ou un site Web. Pour renvoyer un seul rôle à partir de la collection, utilisez un indexeur. Par exemple, si la collection est assignée à une variable nommée collRoles, utilisez collRoles[index] dans C# ou collRoles(index) dans Visual Basic, où index est le numéro d'index du rôle dans la collection ou le nom complet du rôle.

Chaque rôle ou la définition de rôle 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 rôle à un objet SPMember .

Dim myMember As SPMember = site.Roles("Role_Name")

SPMember oMember = oWebsite.Roles["Role_Name"];

Pour effectuer des tâches administratives qui affectent les paramètres de toutes les applications Web de la batterie de serveurs, un utilisateur doit être membre du groupe administrateur SharePoint.

Les rôles de Administrator et Guest ne peuvent pas être modifiés ou supprimés.

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

Pour plus d'informations sur les rôles par défaut disponibles dans SharePoint Foundation, consultez l'énumération SPRoleType .

Exemples

L'exemple de code suivant supprime un utilisateur d'un rôle dans tous les sous-sites d'un site.

Dim site As SPWeb = 
    SPContext.Current.Site.AllWebs("Site_Name")
Dim subSites As SPWebCollection = site.Webs
Dim user As SPUser = site.Users("User_Name")
Dim subSite As SPWeb

For Each subSite In  subSites

    Dim role As SPRole = subSite.Roles("Role_Name")

    role.RemoveUser(user)

Next subSite

using(SPWeb oParentWebsite = SPContext.Current.Site.AllWebs["Site_Name"])
{
    SPWebCollection collWebsites = oParentWebsite.Webs;
    SPUser oUser = oParentWebsite.Users["User_Name"];

    foreach (SPWeb oWebsite in collWebsites)
    {
        SPRole oRole = oWebsite.Roles["Role_Name"];
        oRole.RemoveUser(oUser);

        oWebsite.Dispose();
    }
}

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

SPRole - Membres

Microsoft.SharePoint - Espace de noms