MemberListQuery

MemberListQuery

Query class used to retrieve users from chat groups. Initialize this class with groupChannel.createMemberListQuery()

Constructor

new MemberListQuery(channelUrl)

See:
Parameters:
Name Type Description
channelUrl string

Members

(static) MutedMemberFilter

Properties:
Name Type Description
ALL string

"all"
MUTED string

"muted"
UNMUTED string

"unmuted"

String enum object for describing type of users to fetch

(static) Order

Properties:
Name Type Description
MEMBER_NICKNAME_ALPHABETICAL string

"member_nickname_alphabetical"
OPERATOR_THEN_MEMBER_ALPHABETICAL string

"operator_then_member_alphabetical"

String enum object for describing the order of retrieval

hasNext :boolean

Type:
  • boolean

isLoading :boolean

Type:
  • boolean

limit :number

Default Value:
  • 20
Type:
  • number

memberStateFilter :string

Default Value:
  • "all"
See:
Type:
  • string

mutedMemberFilter :string

Default Value:
  • "all"
See:
Type:
  • string

(nullable) nicknameStartsWithFilter :string

Default Value:
  • null
Type:
  • string

(nullable) order :string

Default Value:
  • member_nickname_alphabetical
Type:
  • string

Methods

next(callbackopt) → {Promise|undefined}

Executes the query

Parameters:
Name Type Attributes Description
callback groupChannelMemberListQueryCallback <optional>
Returns:
Type
Promise | undefined