Skip to main content

UserListQuery

A query is used for querying specific users from backend. You can specify filter, sorting and pagination.

public struct UserListQuery: Encodable

Inheritance​

Encodable

Initializers​

init(filter:sort:pageSize:)​

Init a users query.

public init(
        filter: Filter<UserListFilterScope>? = nil,
        sort: [Sorting<UserListSortingKey>] = [],
        pageSize: Int = .usersPageSize
    )

Parameters​

  • filter: a users filter. Empty filter will return all users.
  • sort: a sorting list for users.
  • pageSize: a page size for pagination.

Properties​

filter​

A filter for the query (see Filter).

public var filter: Filter<UserListFilterScope>?

sort​

A sorting for the query (see Sorting).

public let sort: [Sorting<UserListSortingKey>]

pagination​

A pagination.

public var pagination: Pagination?

Methods​

encode(to:)​

public func encode(to encoder: Encoder) throws

Did you find this page helpful?