getMembers | SignalWire

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

Returns the list of members in the given channel.

Parameters

params

objectRequired

Configuration object for getting members

params.channel

stringRequired

The channel for which to get the list of members.

Returns

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

Example

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