Class UserService

Contents

Class UserService#

Defined in File UserService.cs

Inheritance Relationships#

Base Type#

public xbe.sdk.ServiceBase (Class ServiceBase)

Class Documentation#

class xbe.sdk.Services.UserService : xbe.sdk.ServiceBase #

Public Functions

UserService ()#

Task<List<User>> FindAll (Dictionary<string, string> query = null)#: Returns all users from the system that the user has access to based upon the given criteria.

Task<NewUser> Create (User obj)#: Registers a new user to the service.

Task Truncate ()#: Deletes all users from the service.

async Task<bool> Exists (string id)#: Determines if a user with the given unique identifier already exists.

async Task Verify (string id, string code, string type = "email")#

Confirms that the user account’s contact information is valid.

Param id:: The unique identifier of the user to verify.
Param code:: The verification code provided to the contact.
Param type:: The contact type being verified. Default is ‘email’.

async Task SendVerify (string id, string type = "email")#

Sends a request to verify a user account’s contact information.

Param id:: id The unique identifier of the user to verify.
Param type:: The contact type to verify. Default is ‘email’.

Task<User> FindById (string id)#: Returns a single user from the system that the user has access to.

Task<User> Update (string id, User obj)#: Updates a single user.

Task Recover (string id)#: Sends a temporary JWT token to the user's registered e-mail address allowing the password to be reset.

Task<long?> Count (Dictionary<string, string> query = null)#

Retrieves the Entities Count based on the given criteria.

Return:: Entity Count

Task Delete (string id)#

Deletes an instance of T with the specified unique identifier.

Return:: Task