RollPass JS › ClientController
Class: ClientController
ClientController
Hierarchy
-
ApiController
↳ ClientController
Index
Constructors
Methods
- deleteKeyValue
- deleteSession
- getKeyValue
- getSession
- getUser
- putKeyValue
- sendChallenge
- verifyChallenge
Constructors
constructor
+ new ClientController(clientOptions: ClientOptions, apiOptions?: Partial‹ApiOptions›): ClientController
Defined in src/public/controllers/ClientController.ts:22
Parameters:
| Name | Type |
|---|---|
clientOptions |
ClientOptions |
apiOptions? |
Partial‹ApiOptions› |
Returns: ClientController
Methods
deleteKeyValue
▸ deleteKeyValue(key: string, value: any): Promise‹any›
Defined in src/public/controllers/ClientController.ts:78
Parameters:
| Name | Type |
|---|---|
key |
string |
value |
any |
Returns: Promise‹any›
deleteSession
▸ deleteSession(sessionCode: string): Promise‹any›
Defined in src/public/controllers/ClientController.ts:36
Parameters:
| Name | Type |
|---|---|
sessionCode |
string |
Returns: Promise‹any›
getKeyValue
▸ getKeyValue(key: string): Promise‹any›
Defined in src/public/controllers/ClientController.ts:64
Parameters:
| Name | Type |
|---|---|
key |
string |
Returns: Promise‹any›
getSession
▸ getSession(sessionCode: string): Promise‹any›
Defined in src/public/controllers/ClientController.ts:29
Parameters:
| Name | Type |
|---|---|
sessionCode |
string |
Returns: Promise‹any›
getUser
▸ getUser(sessionCode: string): Promise‹User›
Defined in src/public/controllers/ClientController.ts:57
Parameters:
| Name | Type |
|---|---|
sessionCode |
string |
Returns: Promise‹User›
putKeyValue
▸ putKeyValue(key: string, value: any): Promise‹any›
Defined in src/public/controllers/ClientController.ts:71
Parameters:
| Name | Type |
|---|---|
key |
string |
value |
any |
Returns: Promise‹any›
sendChallenge
▸ sendChallenge(emailAddress: string): Promise‹any›
Defined in src/public/controllers/ClientController.ts:43
Parameters:
| Name | Type |
|---|---|
emailAddress |
string |
Returns: Promise‹any›
verifyChallenge
▸ verifyChallenge(challengeCode: string): Promise‹any›
Defined in src/public/controllers/ClientController.ts:50
Parameters:
| Name | Type |
|---|---|
challengeCode |
string |
Returns: Promise‹any›