new User(options)
Create a User
Parameters:
| Name |
Type |
Description |
options |
Object
|
Various configuration parameters for this user
Properties
| Name |
Type |
Attributes |
Default |
Description |
apiClient |
apiClient
|
|
|
the API client object to use for server API calls |
deviceId |
String
|
|
|
this value distinguishes a particular user, who may be anonymous, to the server; by default we will fingerprint the browser to get this value, but you can supply your own value (useful if your app has a preexisting authorization scheme) |
clientType |
String
|
<optional>
|
"web"
|
|
|
- Source:
Methods
connect() → {Promise}
Make an API call to associate the (possibly anonymous) application user with a Roundware user account.
Upon success, this function receives an auth token, which is passed onto the apiClient object.
- Source:
Returns:
represents the pending API call
-
Type
-
Promise
toString() → {String}
- Source:
Returns:
human-readable representation of this user
-
Type
-
String