MemberListQueryParams

public final class MemberListQueryParams: NSObject
extension MemberListQueryParams: NSCopying

Undocumented

  • 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 = .all

  • Sets a filter to query muted member list.

    Since

    3.0.89

    Declaration

    Swift

    public var mutedMemberFilter: GroupChannelMutedMemberFilter = .all

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

    Declaration

    Swift

    public var memberStateFilter: MemberStateFilter = .all

  • 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 = .nicknameAlphabetical

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

    Declaration

    Swift

    public var limit: UInt = 20

  • Default constructor.

    Declaration

    Swift

    public override init()

  • Initializes and returns a newly allocated params object that mutated through builder closure.

    Declaration

    Swift

    public init(builder: (MemberListQueryParams) -> Void)

    Parameters

    builder

    The builder closure.

    Return Value

    An initialized params object.

Equatable

  • Undocumented

    Declaration

    Swift

    public override func isEqual(_ object: Any?) -> Bool

NSCopying

  • Undocumented

    Declaration

    Swift

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