MemberListQuery

public final class MemberListQuery: NSObject, Queryable

The MemberListQuery class is a query class for getting the list member in group channels.

The instance of this class is created by createMemberListQuery() in GroupChannel class.

  • Boolean indicates there are more data to fetch

    Declaration

    Swift

    public internal(set) var hasNext: Bool = true

  • Indicates the query is currently loading or not

    Declaration

    Swift

    public internal(set) var isLoading: Bool = false

  • Fetches next page

    Declaration

    Swift

    public func loadNextPage(completionHandler: @escaping MemberListHandler)

    Parameters

    completionHandler

    completion handler

  • Copies this object

    Declaration

    Swift

    public func copy(with zone: NSZone? = nil) -> Any

    Parameters

    zone

    optional NSZone

    Return Value

    MemberListQuery instance

Params Bridge

  • Filters members of nickname that starts with.

    Since

    3.0.102

    Declaration

    Swift

    public var nicknameStartsWithFilter: String?

  • Sets a filter to query operators.

    Since

    3.0.89

    Declaration

    Swift

    public var operatorFilter: GroupChannelOperatorFilter

  • Sets a filter to query muted member list.

    Since

    3.0.89

    Declaration

    Swift

    public var mutedMemberFilter: GroupChannelMutedMemberFilter

  • Sets a filter to query member list with member state.

    Declaration

    Swift

    public var memberStateFilter: MemberStateFilter

  • Sets how the query result should be ordered.

    If the order is .nicknameAlphabetical, the result will be ordered by the nickname in alphabetical order. If the order is .operatorThenMemberNicknameAlphabetical, then the result will contain the operators first, and then the members. The two groups (operators and members) will be ordered by the nickname in alphabetical order. The default value is .nicknameAlphabetical.

    Since

    3.0.198

    Declaration

    Swift

    public var order: MemberListOrder

  • Specifies the number of results to return per call. (Default: 20)

    Declaration

    Swift

    public var limit: UInt