MembersQuery class

A query for retrieving feed members with filtering, sorting, and pagination.

Configures how feed members should be fetched from the Stream Feeds API including filters, sorting options, and pagination parameters.

Example

final query = MembersQuery(
  fid: FeedId(group: 'team', id: 'developers'),
  filter: Filter.equal(MembersFilterField.role, "moderator"),
  sort: MembersSort.defaultSort,
  limit: 20,
);

Available extensions

• MembersQueryRequest

Annotations

• @freezed

Constructors

MembersQuery({required FeedId fid, MembersFilter? filter, List<MembersSort>? sort, int? limit, String? next, String? previous})

const

Properties

copyWith → $MembersQueryCopyWith<MembersQuery>

Create a copy of MembersQuery with the given fields replaced by the non-null parameter values.

no setter, inherited

fid → FeedId

The feed ID to fetch members for.

final

filter → MembersFilter?

The filter criteria for this query.

final

hashCode → int

The hash code for this object.

no setter, inherited

limit → int?

The maximum number of members to return.

final

next → String?

The next page cursor for pagination.

final

previous → String?

The previous page cursor for pagination.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sort → List<MembersSort>?

The sorting criteria for this query.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toRequest() → QueryFeedMembersRequest

Available on MembersQuery, provided by the MembersQueryRequest extension

Converts this query to an API request format.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited