@acceleratxr/core_sdk / UserService
Class: UserService#
Hierarchy#
-
↳ UserService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new UserService(apiClient: ApiClient, config: Configuration): UserService
Overrides ServiceBase.constructor
Defined in src/services/UserService.ts:11
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: UserService
Properties#
apiClient#
• Protected apiClient: ApiClient
Inherited from ServiceBase.apiClient
Defined in src/ServiceBase.ts:14
The API Client used when making requests to the API backend server.
config#
• Protected config: Configuration
Inherited from ServiceBase.config
Defined in src/ServiceBase.ts:19
The SDK configuration to use.
uuid#
▪ Static uuid: string = “1139fb8b-907a-4b0b-8d57-1c77e9eb4653”
Defined in src/services/UserService.ts:17
Methods#
count#
▸ count(query?: any): Promise<number>
Defined in src/services/UserService.ts:58
Returns the count of users based on the given criteria.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<number>
create#
▸ create(obj: User): Promise<NewUser | undefined>
Defined in src/services/UserService.ts:34
Registers a new user to the service.
Parameters:#
Name |
Type |
|---|---|
|
Returns: Promise<NewUser | undefined>
delete#
▸ delete(id: string): Promise<void>
Defined in src/services/UserService.ts:103
Deletes the user from the service.
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>
exists#
▸ exists(id: string): Promise<boolean>
Defined in src/services/UserService.ts:161
Returns true if an user exists with the given unique identifier, otherwise false.
Parameters:#
Name |
Type |
Description |
|---|---|---|
|
string |
Returns: Promise<boolean>
findAll#
▸ findAll(query?: any): Promise<User[] | undefined>
Defined in src/services/UserService.ts:22
Returns all users from the system that the user has access to based upon the given criteria.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<User[] | undefined>
findById#
▸ findById(id: string): Promise<User | undefined>
Defined in src/services/UserService.ts:77
Returns a single user from the system that the user has access to.
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<User | undefined>
recover#
▸ recover(id: string): Promise<void>
Defined in src/services/UserService.ts:116
Sends a temporary JWT token to the user’s registered e-mail address allowing the password to be reset.
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>
sendVerify#
▸ sendVerify(id: string, type: string): Promise<void>
Defined in src/services/UserService.ts:148
Sends a request to verify a user account’s contact information.
Parameters:#
Name |
Type |
Default value |
Description |
|---|---|---|---|
|
string |
- |
The unique identifier of the user to verify. |
|
string |
“email” |
The contact type to verify. Default is ‘email’. |
Returns: Promise<void>
truncate#
▸ truncate(query?: any): Promise<void>
Defined in src/services/UserService.ts:46
Deletes all users from the service.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<void>
update#
▸ update(id: string, obj: User): Promise<User | undefined>
Defined in src/services/UserService.ts:90
Updates a single user.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
Returns: Promise<User | undefined>
verify#
▸ verify(id: string, code: string, type: string): Promise<void>
Defined in src/services/UserService.ts:133
Confirms that the user account’s contact information is valid.
Parameters:#
Name |
Type |
Default value |
Description |
|---|---|---|---|
|
string |
- |
The unique identifier of the user to verify. |
|
string |
- |
The verification code provided to the contact. |
|
string |
“email” |
The contact type being verified. Default is ‘email’. |
Returns: Promise<void>
welcome#
▸ welcome(id: string): Promise<void>
Defined in src/services/UserService.ts:179
Sends the user with the given id a welcome e-mail.
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>