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

Show file Open project: JordanRift/Grassroots Class Usage Examples

Public Methods

Method 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 method

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).
return void

CreateRole() public method

public CreateRole ( string roleName ) : void
roleName string
return void

DeleteRole() public method

public DeleteRole ( string roleName, bool throwOnPopulatedRole ) : bool
roleName string
throwOnPopulatedRole bool
return bool

FindUsersInRole() public method

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
return string[]

GetAllRoles() public method

public GetAllRoles ( ) : string[]
return string[]

GetRolesForUser() public method

public GetRolesForUser ( string username ) : string[]
username string
return string[]

GetUsersInRole() public method

public GetUsersInRole ( string roleName ) : string[]
roleName string
return string[]

GrassrootsRoleService() public method

public GrassrootsRoleService ( ) : System
return System

IsUserInRole() public method

public IsUserInRole ( string username, string roleName ) : bool
username string
roleName string
return bool

RemoveUsersFromRoles() public method

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).
return void

RoleExists() public method

public RoleExists ( string roleName ) : bool
roleName string
return bool