Clase SPRole
NOTA: esta API está ahora obsoleta.
Usar las nuevas clases SPRoleDefinition y SPRoleAssignment en su lugar, para definir las funciones y asignar usuarios a ellos. Para obtener más información, vea Changes in the Authorization Object Model. (En Windows SharePoint Services 2.0, SPRole representa un grupo de sitio y se mantiene por compatibilidad con versiones anteriores.)
Jerarquía de la herencia
System.Object
Microsoft.SharePoint.SPMember
Microsoft.SharePoint.SPRole
Espacio de nombres: Microsoft.SharePoint
Ensamblado: Microsoft.SharePoint (en Microsoft.SharePoint.dll)
Sintaxis
'Declaración
<ObsoleteAttribute("Use the SPRoleDefinition class instead")> _
Public Class SPRole _
Inherits SPMember
'Uso
Dim instance As SPRole
[ObsoleteAttribute("Use the SPRoleDefinition class instead")]
public class SPRole : SPMember
Comentarios
Utilice la propiedad Roles de la clase SPUser, SPGroupo SPWeb para devolver un objeto SPRoleCollection que representa la colección de funciones o definiciones de funciones para un usuario, grupo o sitio Web. Utilice un indizador para devolver un único rol de la colección. Por ejemplo, si la colección se asigna a una variable denominada collRoles, use collRoles[index] en C# o collRoles(index) en Visual Basic, donde index es el número de índice de la función de la colección o el nombre para mostrar de la función.
Cada función o definición de rol tiene un identificador de miembro único (propiedadID ), tiene los permisos asociados con esa pertenencia y puede ser representado por un objeto SPMember .
En el siguiente ejemplo se asigna una función a un objeto SPMember .
Dim myMember As SPMember = site.Roles("Role_Name")
SPMember oMember = oWebsite.Roles["Role_Name"];
Para realizar cualquier tarea administrativa que afectan a la configuración para todas las aplicaciones Web de la granja de servidores, un usuario debe ser miembro del grupo de administradores de SharePoint.
Las funciones Administrator y Guest no se pueden modificar o eliminar.
Para obtener información general sobre seguridad y roles, consulte Security, Users, and Groups in Windows SharePoint Services.
Para obtener información acerca de las funciones predeterminadas que están disponibles en SharePoint Foundation, vea la enumeración SPRoleType .
Ejemplos
En el ejemplo de código siguiente se quita un usuario especificado de una función en todos los subsitios bajo un sitio.
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();
}
}
Nota
Determinados objetos implementan la interfaz de IDisposable y, a continuación, se debe evitar la conservación de estos objetos en la memoria que ya no se necesitan. Para obtener información acerca de buenas prácticas de codificación, vea Disposing Objects.
Seguridad para subprocesos
Los miembros static (Shared en Visual Basic) públicos de este tipo son seguros para subprocesos. No se garantiza que los miembros de instancias sean seguros para los subprocesos.