Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ChatroomEvent

Index

Properties

attributes?: string[] | {}

ChatRoom Attributes.

ext?: string

The extension fields.

from: string

Message sender.

id: string

The ID of a chatroom.

memberCount?: number

The member count. For a chat room with more than 2000 members, memberCount will not be returned.

name?: string

The name of a chatroom.

operation: "deleteFile" | "uploadFile" | "deleteAnnouncement" | "updateAnnouncement" | "removeAdmin" | "destroy" | "removeMember" | "unblockMember" | "updateInfo" | "memberPresence" | "memberAbsence" | "setAdmin" | "muteMember" | "unmuteMember" | "addUserToAllowlist" | "removeAllowlistMember" | "muteAllMembers" | "unmuteAllMembers" | "updateChatRoomAttributes" | "removeChatRoomAttributes"

The type of operation.
destroy: Occurs when the chat room was destroyed.
removeMember: Occurs when you are removed from a chat room or added to block list. Only the removed person receives this event.
unblockMember: Occurs when being removed from the block list. Only the removed person receives this event.
updateInfo: Occurs when modifying chat room.
memberPresence: Occurs when someone joined the chat room.
memberAbsence: Occurs when someone leaved the chat room.
setAdmin: Occurs when being set as administrator. Only the person who is set to administrator can receive this event.
removeAdmin: Occurs when you are removed as an administrator. Only the removed person can receive this event.
muteMember: Occurs when you are muted. Only the person who is muted can receive this event.
unmuteMember: Occurs when you are unmuted. Only the person who is unmuted can receive this event.
updateAnnouncement: Occurs when the chat room announcement was updated.
deleteAnnouncement: Occurs when the chat room announcement was deleted.
uploadFile: Occurs when a shared file is uploaded.
deleteFile: Occurs when a shared file is deleted.
addUserToAllowlist: Occurs when being added to the allow list.
removeAllowlistMember: Occurs when being removed from the allow list.
muteAllMembers: Occurs when the chat room was set with a ban for all members.
unmuteAllMembers: Occurs when the chat room lifted the ban.
updateChatRoomAttributes: Occurs when the chat room attributes are updated.
removeChatRoomAttributes: when the chat room attributes are deleted.

reason?: string

The reason for the event.

Generated using TypeDoc