Classes
Methods
# async getProjectById(project_id, cb, query)
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
project_id |
*
|
||
cb |
*
|
||
query |
*
|
null |
# getProjectByShortId(project_sid, cb, query)
Parameters:
| Name | Type | Description |
|---|---|---|
project_sid |
*
|
|
cb |
*
|
|
query |
*
|
# async getProjectList(cb, query)
Get list of projects.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
cb |
*
|
callback |
|
query |
*
|
null | optional query filter |
# async getUsersOfProject(project_sid, membersOnly) → {Promise.<ApiResponse>}
Get users in all groups of a given project. Returns a list of users with their email and the groups they belong to.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
project_sid |
string
|
The project short ID. |
|
membersOnly |
boolean
|
false | Whether to include only the members the project or all contacts, notice: members of the projet are temporarly the users of the project admin group. |
- Since:
- 1.0
ApiResponse with:
status200 anddataas an array of user objects, each containing:user{string} - The user's email address.usergroups{Array
Promise.<ApiResponse>
Example
[
{
user: "amr.abdou@colneo.email",
usergroups: [{
info: { id: "...", name: "Projektleitung", description: "..." },
permissions: { ... },
},
{
info: { id: "...", name: "ddd", description: "..." }
permissions: { ... },
}
]