getMembers

View as Markdown

getMembers

  • getMembers(params): Promise<{ members: ChatMemberEntity[] }> - See ChatMemberEntity for more details.

Returns the list of members in the given channel.

Parameters

NameTypeDescription
paramsObject-
params.channelstringThe channel for which to get the list of members.

Returns

Promise<{ members: ChatMemberEntity[] }> - See ChatMemberEntity for more details.

Example

1const m = await chatClient.getMembers({ channel: "my-channel" });
2
3m.members.length; // 7
4m.members[0]; // { id: ..., channel: ..., state: ... }