SprintApi class - jira_software library

Constructors

SprintApi(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

createSprint({required Map<String, dynamic> body}) → Future: Creates a future sprint. Sprint name and origin board id are required. Start date, end date, and goal are optional.
deleteProperty({required String sprintId, required String propertyKey}) → Future<void>: Removes the property from the sprint identified by the id. Ths user removing the property is required to have permissions to modify the sprint.
deleteSprint(int sprintId) → Future<void>: Deletes a sprint. Once a sprint is deleted, all open issues in the sprint will be moved to the backlog.
getIssuesForSprint({required int sprintId, int? startAt, int? maxResults, String? jql, bool? validateQuery, List<Map<String, dynamic>>? fields, String? expand}) → Future: Returns all issues in a sprint, for a given sprint ID. This only includes issues that the user has permission to view. By default, the returned issues are ordered by rank.
getPropertiesKeys(String sprintId) → Future<void>: Returns the keys of all properties for the sprint identified by the id. The user who retrieves the property keys is required to have permissions to view the sprint.
getProperty({required String sprintId, required String propertyKey}) → Future<void>: Returns the value of the property with a given key from the sprint identified by the provided id. The user who retrieves the property is required to have permissions to view the sprint.
getSprint(int sprintId) → Future: Returns the sprint for a given sprint ID. The sprint will only be returned if the user can view the board that the sprint was created on, or view at least one of the issues in the sprint.
moveIssuesToSprintAndRank({required int sprintId, required Map<String, dynamic> body}) → Future<void>: Moves issues to a sprint, for a given sprint ID. Issues can only be moved to open or active sprints. The maximum number of issues that can be moved in one operation is 50.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
partiallyUpdateSprint({required int sprintId, required Map<String, dynamic> body}) → Future: Performs a partial update of a sprint. A partial update means that fields not present in the request JSON will not be updated.
setProperty({required String sprintId, required String propertyKey}) → Future<void>: Sets the value of the specified sprint's property.
swapSprint({required int sprintId, required Map<String, dynamic> body}) → Future<void>: Swap the position of the sprint with the second sprint.
toString() → String: A string representation of this object.
inherited
updateSprint({required int sprintId, required Map<String, dynamic> body}) → Future: Performs a full update of a sprint. A full update means that the result will be exactly the same as the request body. Any fields not present in the request JSON will be set to null.

Operators

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