Volt User Library
Provides functions for user management.
- Source:
Namespaces
Methods
(static) delete(callbackopt)
Delete a user (or your own account)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
callback |
voltCallback |
<optional> |
no data is returned on success - if not passed, a promise is returned |
- Source:
(static) get(callbackopt)
Get user details
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
callback |
voltCallback |
<optional> |
upon success the data param will contain an API user object (see the response section of the API spec) - if not passed, a promise is returned |
- Source:
(static) update(data, callbackopt)
Update user details
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
data |
object | the properties to be updated (see the API Spec for details) |
|
callback |
voltCallback |
<optional> |
upon success the data param will contain an API user object (see the response section of the API spec) - if not passed, a promise is returned |
- Source: