Classes
Methods
# async byUserId(userId) → {Promise.<Array.<ProjectRole>>}
Returns all project roles of a specific user.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
String
|
The id of the user. |
Promise.<Array.<ProjectRole>>
# async create(projectRole) → {Promise.<ProjectRole>}
Creates a new project role.
Parameters:
| Name | Type | Description |
|---|---|---|
projectRole |
ProjectRoleCreateModel
|
The model to create a project role. |
Promise.<ProjectRole>
# async delete(projectRoleId, newProjectRoleId) → {Promise.<void>}
Deletes the project role with the specified id. When you want to delete a project role which is still in use, you are required to specify which role the currently assigned members should be assigned to instead. If the default role gets deleted, the migration role becomes the new default project role.
Parameters:
| Name | Type | Description |
|---|---|---|
projectRoleId |
String
|
The id of the project role. |
newProjectRoleId |
String
|
The project role id to replace the old project role with. |
Promise.<void>
# async get(projectRoleId) → {Promise.<ProjectRole>}
Returns the project role with the specified id.
Parameters:
| Name | Type | Description |
|---|---|---|
projectRoleId |
String
|
The id of the project role. |
Promise.<ProjectRole>
# async list(optionsopt) → {Promise.<Array.<ProjectRole>>}
Returns all project roles.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
options |
ListOptions
|
<optional> |
Pagination and filtering options |
Promise.<Array.<ProjectRole>>
# async update(projectRoleId, projectRole)
Updates the project role with the specified id.
Parameters:
| Name | Type | Description |
|---|---|---|
projectRoleId |
String
|
The id of the project role. |
projectRole |
ProjectRoleUpdateModel
|
The model to update a project. |