Class User
- Defined in: user.js
Constructor Attributes | Constructor Name and Description |
---|---|
User(masterApiKey)
Create an instance of User
|
Method Summary
Method Attributes | Method Name and Description |
---|---|
create(dataSource, callback, optionalDataFormat)
Create user: POST /v2/users
|
|
delete(userID, callback)
Delete user: DELETE /v2/users/
|
|
list(The, Optional)
List all users: GET /v2/users
|
|
read(userID, callback, optionalDataFormat)
Read user: GET /v2/users/
|
|
update(userID, dataSource, callback, optionalDataFormat)
Update user: PUT /v2/users/
|
Class Detail
User(masterApiKey)
Create an instance of User
- Parameters:
- {string} masterApiKey
- Your pachube makster api key.
Method Detail
-
create(dataSource, callback, optionalDataFormat)Create user: POST /v2/users
- Parameters:
- {string} dataSource
- The data source, a path, a string or an object.
- {function} callback
- The callback function.
- {string} optionalDataFormat
- Optional data format parameter, json or xml, default to json.
-
delete(userID, callback)Delete user: DELETE /v2/users/
- Parameters:
- {string} userID
- The login name for user (i.e. the Pachube ID).
- {function} callback
- The callback function.
-
list(The, Optional)List all users: GET /v2/users
- Parameters:
- {function} The
- callback function.
- {string} Optional
- data format parameter, json or xml, default to json.
-
read(userID, callback, optionalDataFormat)Read user: GET /v2/users/
- Parameters:
- {string} userID
- The login name for the user (i.e. their Pachube ID).
- {function} callback
- The callback function.
- {string} optionalDataFormat
- Optional data format parameter, json or xml, default to json.
-
update(userID, dataSource, callback, optionalDataFormat)Update user: PUT /v2/users/
- Parameters:
- {string} userID
- The login name for user (i.e. the Pachube ID).
- {string} dataSource
- The data source, a path, a string or an object.
- {function} callback
- The callback function.
- {string} optionalDataFormat
- Optional data format parameter, json or xml, default to json.