Chat

ChatMember

View as Markdown

This class represents a member in a chat. A ChatMember object is received in the onMemberJoined, onMemberUpdated, and onMemberLeft event handlers when listening to chat events.

Properties

id
stringRequired

The id of this member.

channel
stringRequired

The channel of this member.

state
Record<any, any>Required

The state of this member.

Example

Listening for member events and accessing ChatMember properties:

1import { SignalWire } from "@signalwire/realtime-api";
2
3const client = await SignalWire({ project: "your-project-id", token: "your-api-token" });
4
5await client.chat.listen({
6  channels: ["my-channel"],
7  onMemberJoined: (member) => {
8    console.log("Member joined:", member.id);
9    console.log("Channel:", member.channel);
10    console.log("State:", member.state);
11  },
12  onMemberUpdated: (member) => {
13    console.log("Member updated:", member.id);
14    console.log("New state:", member.state);
15  },
16  onMemberLeft: (member) => {
17    console.log("Member left:", member.id);
18  }
19});