Classes
Methods
# async create(projectType) → {Promise.<ProjectType>}
Creates a new project type.
Parameters:
| Name | Type | Description |
|---|---|---|
projectType |
ProjectTypeCreateModel
|
The model to create a project type. |
Promise.<ProjectType>
# async delete(projectTypeId)
Deletes the project type with the specified id. If an id of a new type is provided, projects will be updated to reference the new type If no id of type is provided, the type if removed from the projects.
Parameters:
| Name | Type | Description |
|---|---|---|
projectTypeId |
String
|
The id of the project type. |
# async get(projectTypeId) → {Promise.<ProjectType>}
Returns the project type with the specified id.
Parameters:
| Name | Type | Description |
|---|---|---|
projectTypeId |
String
|
The id of the project type. |
Promise.<ProjectType>
# async icons() → {Promise.<Array.<String>>}
Get all possible icons for project types.
Promise.<Array.<String>>
# async list(options) → {Promise.<Array.<ProjectType>>}
Returns all existing project types.
Parameters:
| Name | Type | Description |
|---|---|---|
options |
Promise.<Array.<ProjectType>>
# async setArchived(projectTypeId, archivedopt) → {Promise.<ProjectType>}
Archives or unarchives the project type with the specified id. Archived objects can not be used any longer but still exist for being referenced by other entities.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
projectTypeId |
String
|
The id of the project type. | ||
archived |
Boolean
|
<optional> |
true | Whether the project type should be archived. |
Promise.<ProjectType>
# async update(projectTypeId, projectType) → {Promise.<ProjectType>}
Updates the project type with the specified id.
Parameters:
| Name | Type | Description |
|---|---|---|
projectTypeId |
String
|
The id of the project type. |
projectType |
ProjectTypeUpdateModel
|
The model to update the project type. |
Promise.<ProjectType>