FiltersApi class

Jira Cloud platform REST API documentation

Constructors

FiltersApi(ApiClient _client)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

changeFilterOwner({required int id, required ChangeFilterOwner body}) → Future

Changes the owner of the filter.

createFilter({String? expand, bool? overrideSharePermissions, required Filter body}) → Future<Filter>

Creates a filter. The filter is shared according to the default share scope. The filter is not selected as a favorite.

deleteFavouriteForFilter({required int id, String? expand}) → Future<Filter>

Removes a filter as a favorite for the user. Note that this operation only removes filters visible to the user from the user's favorites list. For example, if the user favorites a public filter that is subsequently made private (and is therefore no longer visible on their favorites list) they cannot remove it from their favorites list.

deleteFilter(int id) → Future<void>

Delete a filter.

getColumns(int id) → Future<List<ColumnItem>>

Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in List View with the Columns set to Filter.

getFavouriteFilters({String? expand}) → Future<List<Filter>>

Returns the visible favorite filters of the user.

getFilter({required int id, String? expand, bool? overrideSharePermissions}) → Future<Filter>

Returns a filter.

getFiltersPaginated({String? filterName, String? accountId, String? owner, String? groupname, String? groupId, int? projectId, List<int>? id, String? orderBy, int? startAt, int? maxResults, String? expand, bool? overrideSharePermissions}) → Future<PageBeanFilterDetails>

Returns a paginated list of filters. Use this operation to get:

getMyFilters({String? expand, bool? includeFavourites}) → Future<List<Filter>>

Returns the filters owned by the user. If includeFavourites is true, the user's visible favorite filters are also returned.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

resetColumns(int id) → Future<void>

Reset the user's column configuration for the filter to the default.

setColumns({required int id, required List<String> body}) → Future

Sets the columns for a filter. Only navigable fields can be set as columns. Use Get fields to get the list fields in Jira. A navigable field has navigable set to true.

setFavouriteForFilter({required int id, String? expand}) → Future<Filter>

Add a filter as a favorite for the user.

toString() → String

A string representation of this object.

inherited

updateFilter({required int id, String? expand, bool? overrideSharePermissions, required Filter body}) → Future<Filter>

Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.

Operators

operator ==(Object other) → bool

The equality operator.

inherited