InterfaceMemberListQueryParams

interface MemberListQueryParams {
    limit?: number;
    memberStateFilter?: MemberStateFilter;
    mutedMemberFilter?: MutedMemberFilter;
    nicknameStartsWithFilter?: string;
    operatorFilter?: OperatorFilter;
    order?: MemberListOrder;
}

Hierarchy

BaseListQueryParams
- MemberListQueryParams

Index

Properties

limit? memberStateFilter? mutedMemberFilter? nicknameStartsWithFilter? operatorFilter? order?

Properties

`Optional`limit

limit?: number

Description

The maximum number of data per queried page.

`Optional`memberStateFilter

memberStateFilter?: MemberStateFilter

Description

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

`Optional`mutedMemberFilter

mutedMemberFilter?: MutedMemberFilter

Description

Muted member filter.

`Optional`nicknameStartsWithFilter

nicknameStartsWithFilter?: string

Description

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

`Optional`operatorFilter

operatorFilter?: OperatorFilter

Description

Operator filter.

`Optional`order

order?: MemberListOrder

Description

Indicates how the query result should be ordered.