getMembers

getMembers

• getMembers(params): Promise<{ members: ChatMemberEntity[] }>

Returns the list of members in the given channel.

Parameters

Returns

Promise<{ members: ChatMemberEntity[] }>

A promise that resolves to an object containing the list of members in the given channel.

Example

In this example, we fetch all the members in the channel channel1 and print the number of members and the list of members to the console.

1
import { SignalWire } from "@signalwire/realtime-api";
2
3
const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })
4
5
const chatClient = client.chat;
6
7
const m = await chatClient.getMembers({ channel: "channel1" });
8
9
console.log(`There are a total of ${m.members.length} members in channel1.
10
The list of members are: ${m.members.map(m => m.id).join(", ")}`);