KlusterKite  0.0.0
A framework to create scalable and redundant services based on awesome Akka.Net project.
KlusterKite.NodeManager.WebApi.UsersConnection Class Reference

The User management More...

Inheritance diagram for KlusterKite.NodeManager.WebApi.UsersConnection:
KlusterKite.Data.CRUD.Connection< User, Guid >

Public Member Functions

 UsersConnection (ActorSystem actorSystem, string dataActorPath, TimeSpan? timeout, RequestContext context)
 Initializes a new instance of the UsersConnection class. More...
 
async Task< MutationResult< User > > ResetPassword (Guid id, string password)
 Resets the user password More...
 
async Task< MutationResult< User > > GrantRole (Guid userUid, Guid roleUid)
 Grants a new role to the user More...
 
async Task< MutationResult< User > > WithdrawRole (Guid userUid, Guid roleUid)
 Withdraws the role from the user More...
 
- Public Member Functions inherited from KlusterKite.Data.CRUD.Connection< User, Guid >
 Connection (ActorSystem actorSystem, string dataActorPath, TimeSpan? timeout, RequestContext context)
 
async Task< MutationResult< TObject > > Create (TObject newNode)
 
async Task< MutationResult< TObject > > Delete (TId id)
 
async Task< QueryResult< TObject > > Query (Expression< Func< TObject, bool >> filter, IEnumerable< SortingCondition > sort, int? limit, int? offset, ApiRequest apiRequest)
 
async Task< MutationResult< TObject > > Update (TId id, TObject newNode, ApiRequest apiRequest)
 

Additional Inherited Members

- Static Protected Member Functions inherited from KlusterKite.Data.CRUD.Connection< User, Guid >
static MutationResult< TObject > CreateResponse (CrudActionResponse< TObject > response)
 Creates mutation response from actor response More...
 
- Properties inherited from KlusterKite.Data.CRUD.Connection< User, Guid >
RequestContext Context [get]
 Gets the request context More...
 
string DataActorPath [get]
 Gets the path to the data actor More...
 
ActorSystem System [get]
 Gets the actor system More...
 
TimeSpan Timeout [get]
 Gets the request timeout More...
 

Detailed Description

The User management

Definition at line 32 of file UsersConnection.cs.

Constructor & Destructor Documentation

◆ UsersConnection()

KlusterKite.NodeManager.WebApi.UsersConnection.UsersConnection ( ActorSystem  actorSystem,
string  dataActorPath,
TimeSpan?  timeout,
RequestContext  context 
)

Initializes a new instance of the UsersConnection class.

Parameters
actorSystemThe actor system.
dataActorPathThe data actor path.
timeoutThe timeout.
contextThe context.

Definition at line 49 of file UsersConnection.cs.

Member Function Documentation

◆ GrantRole()

async Task<MutationResult<User> > KlusterKite.NodeManager.WebApi.UsersConnection.GrantRole ( Guid  userUid,
Guid  roleUid 
)

Grants a new role to the user

Parameters
userUidThe user Uid.
roleUidThe role Uid.
Returns
The mutation result

Definition at line 93 of file UsersConnection.cs.

◆ ResetPassword()

async Task<MutationResult<User> > KlusterKite.NodeManager.WebApi.UsersConnection.ResetPassword ( Guid  id,
string  password 
)

Resets the user password

Parameters
idThe user uid
passwordThe new user password
Returns
The mutation result

Definition at line 65 of file UsersConnection.cs.

◆ WithdrawRole()

async Task<MutationResult<User> > KlusterKite.NodeManager.WebApi.UsersConnection.WithdrawRole ( Guid  userUid,
Guid  roleUid 
)

Withdraws the role from the user

Parameters
userUidThe user Uid.
roleUidThe role Uid.
Returns
The mutation result

Definition at line 121 of file UsersConnection.cs.


The documentation for this class was generated from the following file: