ProjectRolesApi class

Jira Cloud platform REST API documentation

Constructors

ProjectRolesApi(ApiClient _client)

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

createProjectRole({required CreateUpdateRoleRequestBean body}) Future<ProjectRole>
Creates a new project role with no default actors. You can use the Add default actors to project role operation to add default actors to the project role after creating it.
deleteProjectRole({required int id, int? swap}) Future<void>
Deletes a project role. You must specify a replacement project role if you wish to delete a project role that is in use.
fullyUpdateProjectRole({required int id, required CreateUpdateRoleRequestBean body}) Future<ProjectRole>
Updates the project role's name and description. You must include both a name and a description in the request.
getAllProjectRoles() Future<List<ProjectRole>>
Gets a list of all project roles, complete with project role details and default actors.
getProjectRole({required String projectIdOrKey, required int id, bool? excludeInactiveUsers}) Future<ProjectRole>
Returns a project role's details and actors associated with the project. The list of actors is sorted by display name.
getProjectRoleById(int id) Future<ProjectRole>
Gets the project role details and the default actors associated with the role. The list of default actors is sorted by display name.
getProjectRoleDetails({required String projectIdOrKey, bool? currentMember, bool? excludeConnectAddons}) Future<List<ProjectRoleDetails>>
Returns all project roles and the details for each role. Note that the list of project roles is common to all projects.
getProjectRoles(String projectIdOrKey) Future<Map<String, dynamic>>
Returns a list of project roles for the project returning the name and self URL for each role.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
partialUpdateProjectRole({required int id, required CreateUpdateRoleRequestBean body}) Future<ProjectRole>
Updates either the project role's name or its description.
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited