Filter class

Details about a filter.

Constructors

Filter({String? description, List<SharePermission>? editPermissions, bool? favourite, int? favouritedCount, String? id, String? jql, required String name, User? owner, String? searchUrl, String? self, List<SharePermission>? sharePermissions, UserList? sharedUsers, FilterSubscriptionsList? subscriptions, String? viewUrl})

Filter.fromJson(Map<String, Object?> json)

factory

Properties

description → String?

A description of the filter.

final

editPermissions → List<SharePermission>

The groups and projects that can edit the filter.

final

favourite → bool

Whether the filter is selected as a favorite.

final

favouritedCount → int?

The count of how many users have selected this filter as a favorite, including the filter owner.

final

hashCode → int

The hash code for this object.

no setter, inherited

id → String?

The unique identifier for the filter.

final

jql → String?

The JQL query for the filter. For example, project = SSP AND issuetype = Bug.

final

name → String

The name of the filter. Must be unique.

final

owner → User?

The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

searchUrl → String?

A URL to view the filter results in Jira, using the Search for issues using JQL operation with the filter's JQL string to return the filter results. For example, https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug.

final

self → String?

The URL of the filter.

final

sharedUsers → UserList?

A paginated list of the users that the filter is shared with. This includes users that are members of the groups or can browse the projects that the filter is shared with.

final

sharePermissions → List<SharePermission>

The groups and projects that the filter is shared with.

final

subscriptions → FilterSubscriptionsList?

A paginated list of the users that are subscribed to the filter.

final

viewUrl → String?

A URL to view the filter results in Jira, using the ID of the filter. For example, https://your-domain.atlassian.net/issues/?filter=10100.

final

Methods

copyWith({String? description, List<SharePermission>? editPermissions, bool? favourite, int? favouritedCount, String? id, String? jql, String? name, User? owner, String? searchUrl, String? self, List<SharePermission>? sharePermissions, UserList? sharedUsers, FilterSubscriptionsList? subscriptions, String? viewUrl}) → Filter

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, Object?>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited