Interface ChatRoomEventListener

The chat room event listener.

interface ChatRoomEventListener {
    onAdminAdded?(params: { admin: string; roomId: string }): void;
    onAdminRemoved?(params: { admin: string; roomId: string }): void;
    onAllChatRoomMemberMuteStateChanged?(
        params: { isAllMuted: boolean; roomId: string },
    ): void;
    onAllowListAdded?(params: { members: string[]; roomId: string }): void;
    onAllowListRemoved?(params: { members: string[]; roomId: string }): void;
    onAnnouncementChanged?(
        params: { announcement: string; roomId: string },
    ): void;
    onAttributesRemoved?(
        params: { from: string; removedKeys: string[]; roomId: string },
    ): void;
    onAttributesUpdated?(
        params: {
            attributes: Map<string, string>;
            from: string;
            roomId: string;
        },
    ): void;
    onDestroyed?(params: { roomId: string; roomName?: string }): void;
    onMemberExited?(
        params: { participant: string; roomId: string; roomName?: string },
    ): void;
    onMemberJoined?(params: { participant: string; roomId: string }): void;
    onMemberRemoved?(
        params: {
            participant?: string;
            reason?: string;
            roomId: string;
            roomName?: string;
        },
    ): void;
    onMuteListAdded?(
        params: { expireTime?: string; mutes: string[]; roomId: string },
    ): void;
    onMuteListRemoved?(params: { mutes: string[]; roomId: string }): void;
    onOwnerChanged?(
        params: { newOwner: string; oldOwner: string; roomId: string },
    ): void;
    onSpecificationChanged?(room: ChatRoom): void;
}

Index

Methods

onAdminAdded? onAdminRemoved? onAllChatRoomMemberMuteStateChanged? onAllowListAdded? onAllowListRemoved? onAnnouncementChanged? onAttributesRemoved? onAttributesUpdated? onDestroyed? onMemberExited? onMemberJoined? onMemberRemoved? onMuteListAdded? onMuteListRemoved? onOwnerChanged? onSpecificationChanged?

Methods

`Optional`onAdminAdded

onAdminAdded?(params: { admin: string; roomId: string }): void
Occurs when a chat room member is set as an admin. The member set as the chat room admin receives this event.
Parameters
- params: { admin: string; roomId: string }
Returns void
Params
The parameter set.
- Param [roomId] The chat room ID.
- Param [admin] The user ID of the member who is set as an admin.

`Optional`onAdminRemoved

onAdminRemoved?(params: { admin: string; roomId: string }): void
Occurs when the chat room member(s) is/are removed from the admin list. The admin removed from the admin list receives this event.
Parameters
- params: { admin: string; roomId: string }
Returns void
Params
The parameter set.
- Param [roomId] The chat room ID.
- Param [admin] The user ID of the admin whose administrative privileges are removed.

`Optional`onAllChatRoomMemberMuteStateChanged

onAllChatRoomMemberMuteStateChanged?(
params: { isAllMuted: boolean; roomId: string },
): void
Occurs when all members in the chat room are muted or unmuted. All chat room members receive this event.
Parameters
- params: { isAllMuted: boolean; roomId: string }
Returns void
Params
The parameter set.
- Param [roomId] The chat room ID.
- Param [isAllMuted] Whether all chat room members are muted.
  
  true: Yes.
  
  false: No.

`Optional`onAllowListAdded

onAllowListAdded?(params: { members: string[]; roomId: string }): void
Occurs when the chat room member(s) is/are added to the allow list. The members added to the allow list receive this event.
Parameters
- params: { members: string[]; roomId: string }
Returns void
Params
The parameter set.
- Param [roomId] The chat room ID.
- Param [members] The member(s) added to the allow list of the chat room.

`Optional`onAllowListRemoved

onAllowListRemoved?(params: { members: string[]; roomId: string }): void
Occurs when the chat room member(s) is/are removed from the allow list. The members that are removed from the allow list receive this event.
Parameters
- params: { members: string[]; roomId: string }
Returns void
Params
The parameter set.
- Param [roomId] The chat room ID.
- Param [members] The member(s) removed from the allow list of the chat room.

`Optional`onAnnouncementChanged

onAnnouncementChanged?(params: { announcement: string; roomId: string }): void
Occurs when the chat room announcement changes. All chat room members receive this event.
Parameters
- params: { announcement: string; roomId: string }
Returns void
Params
The parameter set.
- Param [roomId] The chat room ID.
- Param [announcement] The new announcement.

`Optional`onAttributesRemoved

onAttributesRemoved?(
params: { from: string; removedKeys: string[]; roomId: string },
): void
The custom chat room attribute(s) is/are removed. All chat room members receive this event.
Parameters
- params: { from: string; removedKeys: string[]; roomId: string }
Returns void
Params
params
- roomId: The chat room ID.
- removedKeys: The key list of custom chat room attributes that are removed.
- from: The user ID of the operator.

`Optional`onAttributesUpdated

onAttributesUpdated?(
    params: {
        attributes: Map<string, string>;
        from: string;
        roomId: string;
    },
): void
The custom chat room attribute(s) is/are updated. All chat room members receive this event.
Parameters
- params: { attributes: Map<string, string>; from: string; roomId: string }
Returns void
Params
params
- roomId: The chat room ID.
- attributes: The list of custom chat room attributes (key-value) that are updated.
- from: The user ID of the operator.

`Optional`onDestroyed

onDestroyed?(params: { roomId: string; roomName?: string }): void
Occurs when the chat room is destroyed. All chat room members receive this event.
Parameters
- params: { roomId: string; roomName?: string }
Returns void
Params
The parameter set.
- Param [roomId] The chat room ID.
- Param [roomName] The name of the chat room.

`Optional`onMemberExited

onMemberExited?(
params: { participant: string; roomId: string; roomName?: string },
): void
Occurs when a member exits the chat room. All chat room members, except the member exiting the chat room, receive this event.
Parameters
- params: { participant: string; roomId: string; roomName?: string }
Returns void
Params
The parameter set.
- Param [roomId] The chat room ID.
- Param [participant] The user ID of the member who leaves the chat room.

`Optional`onMemberJoined

onMemberJoined?(params: { participant: string; roomId: string }): void
Occurs when a member joins the chat room. All chat room members, except the new member, receive this event.
Parameters
- params: { participant: string; roomId: string }
Returns void
Params
The parameter set.
- Param [roomId] The chat room ID.
- Param [participant] The user ID of the new member.

`Optional`onMemberRemoved

onMemberRemoved?(
    params: {
        participant?: string;
        reason?: string;
        roomId: string;
        roomName?: string;
    },
): void
Occurs when a member is removed from a chat room. The member that is kicked out of the chat room receive this event.
Parameters
- params: { participant?: string; reason?: string; roomId: string; roomName?: string }
Returns void
Params
The parameter set.
- Param [roomId] The chat room ID.
- Param [roomName] The name of the chat room.
- Param [participant] The user ID of the member that is removed from a chat room.
- Param [reason] Reason for removal.

`Optional`onMuteListAdded

onMuteListAdded?(
params: { expireTime?: string; mutes: string[]; roomId: string },
): void
Occurs when the chat room member(s) is/are added to the mute list. The muted members receive this event.
Parameters
- params: { expireTime?: string; mutes: string[]; roomId: string }
Returns void
Params
The parameter set.
- Param [roomId] The chat room ID.
- Param [mutes] The user ID(s) of muted member(s).
- Param [expireTime] Reserved parameter. The Unix timestamp when the mute duration expires.

`Optional`onMuteListRemoved

onMuteListRemoved?(params: { mutes: string[]; roomId: string }): void
Occurs when the chat room member(s) is/are removed from the mute list. The members that are removed from the mute list receive this event.
Parameters
- params: { mutes: string[]; roomId: string }
Returns void
Params
The parameter set.
- Param [roomId] The chat room ID.
- Param [mutes] The user ID(s) of unmuted member(s).

`Optional`onOwnerChanged

onOwnerChanged?(
params: { newOwner: string; oldOwner: string; roomId: string },
): void
Occurs when the chat room owner is changed. The chat room owner receives this event.
Parameters
- params: { newOwner: string; oldOwner: string; roomId: string }
Returns void
Params
The parameter set.
- Param [roomId] The chat room ID.
- Param [newOwner] The user ID of the new chat room owner.
- Param [oldOwner] The user ID of the previous chat room owner.

`Optional`onSpecificationChanged

onSpecificationChanged?(room: ChatRoom): void
Occurs when the chat room specifications changes. All chat room members receive this event.
Parameters
- room: ChatRoom
  The chat room.
Returns void

Interface ChatRoomEventListener

Index

Methods

Methods

OptionalonAdminAdded

Parameters

Returns void

Params

OptionalonAdminRemoved

Parameters

Returns void

Params

OptionalonAllChatRoomMemberMuteStateChanged

Parameters

Returns void

Params

OptionalonAllowListAdded

Parameters

Returns void

Params

OptionalonAllowListRemoved

Parameters

Returns void

Params

OptionalonAnnouncementChanged

Parameters

Returns void

Params

OptionalonAttributesRemoved

Parameters

Returns void

Params

OptionalonAttributesUpdated

Parameters

Returns void

Params

OptionalonDestroyed

Parameters

Returns void

Params

OptionalonMemberExited

Parameters

Returns void

Params

OptionalonMemberJoined

Parameters

Returns void

Params

OptionalonMemberRemoved

Parameters

Returns void

Params

OptionalonMuteListAdded

Parameters

Returns void

Params

OptionalonMuteListRemoved

Parameters

Returns void

Params

OptionalonOwnerChanged

Parameters

Returns void

Params

OptionalonSpecificationChanged

Parameters

Returns void

Settings

On This Page

`Optional`onAdminAdded

`Optional`onAdminRemoved

`Optional`onAllChatRoomMemberMuteStateChanged

`Optional`onAllowListAdded

`Optional`onAllowListRemoved

`Optional`onAnnouncementChanged

`Optional`onAttributesRemoved

`Optional`onAttributesUpdated

`Optional`onDestroyed

`Optional`onMemberExited

`Optional`onMemberJoined

`Optional`onMemberRemoved

`Optional`onMuteListAdded

`Optional`onMuteListRemoved

`Optional`onOwnerChanged

`Optional`onSpecificationChanged