C# Class JordanRift.Grassroots.Framework.Services.GrassrootsRoleService

Afficher le fichier Open project: JordanRift/Grassroots Class Usage Examples

Méthodes publiques

Méthode Description
AddUsersToRoles ( string usernames, string roleNames ) : void

Adds the given users to a given role. A user can have only one role so if you call this method with more than one role an exception will be thrown.
CreateRole ( string roleName ) : void
DeleteRole ( string roleName, bool throwOnPopulatedRole ) : bool
FindUsersInRole ( string roleName, string usernameToMatch ) : string[]

Gets an array of user names in a role where the user name contains the specified user name to match.
GetAllRoles ( ) : string[]
GetRolesForUser ( string username ) : string[]
GetUsersInRole ( string roleName ) : string[]
GrassrootsRoleService ( ) : System
IsUserInRole ( string username, string roleName ) : bool
RemoveUsersFromRoles ( string usernames, string roleNames ) : void

Removes the given users from a given role. A user can have only one role so if you call this method with more than one role an exception will be thrown.
RoleExists ( string roleName ) : bool

Method Details

AddUsersToRoles() public méthode

Adds the given users to a given role. A user can have only one role so if you call this method with more than one role an exception will be thrown.
Thrown if you call this method with more than one role.
public AddUsersToRoles ( string usernames, string roleNames ) : void
usernames string an array of userNames
roleNames string an array of roleNames (only 1 role is supported).
Résultat void

CreateRole() public méthode

public CreateRole ( string roleName ) : void
roleName string
Résultat void

DeleteRole() public méthode

public DeleteRole ( string roleName, bool throwOnPopulatedRole ) : bool
roleName string
throwOnPopulatedRole bool
Résultat bool

FindUsersInRole() public méthode

Gets an array of user names in a role where the user name contains the specified user name to match.
public FindUsersInRole ( string roleName, string usernameToMatch ) : string[]
roleName string
usernameToMatch string
Résultat string[]

GetAllRoles() public méthode

public GetAllRoles ( ) : string[]
Résultat string[]

GetRolesForUser() public méthode

public GetRolesForUser ( string username ) : string[]
username string
Résultat string[]

GetUsersInRole() public méthode

public GetUsersInRole ( string roleName ) : string[]
roleName string
Résultat string[]

GrassrootsRoleService() public méthode

public GrassrootsRoleService ( ) : System
Résultat System

IsUserInRole() public méthode

public IsUserInRole ( string username, string roleName ) : bool
username string
roleName string
Résultat bool

RemoveUsersFromRoles() public méthode

Removes the given users from a given role. A user can have only one role so if you call this method with more than one role an exception will be thrown.
Thrown if you call this method with more than one role.
public RemoveUsersFromRoles ( string usernames, string roleNames ) : void
usernames string an array of userNames
roleNames string an array of roleNames (only 1 role is supported).
Résultat void

RoleExists() public méthode

public RoleExists ( string roleName ) : bool
roleName string
Résultat bool