Skip to main content

ChannelMemberListQuery

A query type used for fetching channel members from the backend.

public struct ChannelMemberListQuery: Encodable

Inheritance​

Encodable

Initializers​

init(cid:filter:sort:pageSize:)​

Creates new ChannelMemberListQuery instance.

public init(
        cid: ChannelId,
        filter: Filter<MemberListFilterScope>? = nil,
        sort: [Sorting<ChannelMemberListSortingKey>] = [],
        pageSize: Int = .channelMembersPageSize
    )

Parameters​

  • cid: The channel identifier.
  • filter: The members filter. Empty filter will return all users.
  • sort: The sorting for members list.
  • pageSize: The page size for pagination.

Properties​

cid​

A channel identifier the members should be fetched for.

public let cid: ChannelId

filter​

A filter for the query (see Filter).

public let filter: Filter<MemberListFilterScope>?

sort​

A sorting for the query (see Sorting).

public let sort: [Sorting<ChannelMemberListSortingKey>]

pagination​

A pagination.

public var pagination: Pagination

Methods​

encode(to:)​

public func encode(to encoder: Encoder) throws

Did you find this page helpful?