MemberListQueryParams

data class MemberListQueryParams @JvmOverloads constructor(var order: MemberListQuery.Order = Order.MEMBER_NICKNAME_ALPHABETICAL, var operatorFilter: OperatorFilter = OperatorFilter.ALL, var mutedMemberFilter: MutedMemberFilter = MutedMemberFilter.ALL, var memberStateFilter: MemberStateFilter = MemberStateFilter.ALL, var nicknameStartsWithFilter: String? = null, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a MemberListQuery object.

Since

4.0.0

See also

Constructors

Link copied to clipboard
constructor(order: MemberListQuery.Order = Order.MEMBER_NICKNAME_ALPHABETICAL, operatorFilter: OperatorFilter = OperatorFilter.ALL, mutedMemberFilter: MutedMemberFilter = MutedMemberFilter.ALL, memberStateFilter: MemberStateFilter = MemberStateFilter.ALL, nicknameStartsWithFilter: String? = null, limit: Int = QUERY_DEFAULT_LIMIT)

Properties

Link copied to clipboard
var limit: Int

The maximum number of items per queried page.

Link copied to clipboard

A filter to return members with the member state matching to MemberStateFilter.

Link copied to clipboard

Muted member filter.

Link copied to clipboard

A filter to return members whose nicknames start with the specified string.

Link copied to clipboard

Operator filter.

Link copied to clipboard

Indicates how the query result should be ordered. If set to