Class ChatRoom

The chat room instance class.

To get the correct value, ensure that you call ChatRoomManager.fetchChatRoomInfoFromServer to get chat room details before calling this method.

Constructors

constructor

Properties

adminList? announcement? blockList? createTimestamp? description? isAllMemberMuted? isInWhitelist? maxUsers? memberCount? memberList? muteExpireTimestamp? muteKVList? muteList? owner permissionType roomId roomName?

Constructors

constructor

  • new ChatRoom(params): ChatRoom

  • Parameters

    • params: {
          adminList?: string[];
          announcement?: string;
          blockList?: string[];
          createTimestamp?: number;
          description?: string;
          isAllMemberMuted?: boolean;
          isInWhitelist?: boolean;
          maxUsers?: string;
          memberCount?: string;
          memberList?: string[];
          muteExpireTimestamp?: number;
          muteKVList?: Record<string, number>;
          muteList?: string[];
          owner: string;
          permissionType: number;
          roomId: string;
          roomName?: string;
      }
      • OptionaladminList?: string[]
      • Optionalannouncement?: string
      • OptionalblockList?: string[]
      • OptionalcreateTimestamp?: number
      • Optionaldescription?: string
      • OptionalisAllMemberMuted?: boolean
      • OptionalisInWhitelist?: boolean
      • OptionalmaxUsers?: string
      • OptionalmemberCount?: string
      • OptionalmemberList?: string[]
      • OptionalmuteExpireTimestamp?: number
      • OptionalmuteKVList?: Record<string, number>
      • OptionalmuteList?: string[]
      • owner: string
      • permissionType: number
      • roomId: string
      • OptionalroomName?: string

    Returns ChatRoom

Properties

OptionaladminList

adminList?: string[]

The admin list of the chat room.

Optionalannouncement

announcement?: string

The chat room announcement.

OptionalblockList

blockList?: string[]

The block list of the chat room.

OptionalcreateTimestamp

createTimestamp?: number

Gets the timestamp(ms) when the chat room was created. This property is available once join the chat room.

Optionaldescription

description?: string

The chat room description.

OptionalisAllMemberMuted

isAllMemberMuted?: boolean

Whether all members are muted in the chat room.

  • true: Yes.
  • false: No.

OptionalisInWhitelist

isInWhitelist?: boolean

Current user is in allow list or not. This property is available once join the chat room. This property will be updated when current user is added or removed from the white list.

  • true: In white list.
  • false: Not in white list.

OptionalmaxUsers

maxUsers?: string

The maximum number of users allowed to join a chat room. This field is specified during the creation of a chat room.

OptionalmemberCount

memberCount?: string

The number of members in the chat room.

OptionalmemberList

memberList?: string[]

The member list of the chat room.

OptionalmuteExpireTimestamp

muteExpireTimestamp?: number

Gets the timestamp(ms) when Current user will be unmuted.

This property is available once join the chat room. This property will be updated when current use is muted or unmuted.

  • Current use is not muted if it is zero.
  • Means cannot get MuteUntilTimeStamp correctly if it is be set with -1;

OptionalmuteKVList

muteKVList?: Record<string, number>

The mute list of the chat room.

key: userId value: mute expire time

OptionalmuteList

muteList?: string[]

The mute list of the chat room.

Deprecated

2024-12-03 Please use muteKVList instead.

owner

owner: string

The user ID of the chat room owner.

permissionType

permissionType: ChatRoomPermissionType

The role of the current user in the chat room. For role types, see ChatRoomPermissionType.

roomId

roomId: string

The chat room ID.

OptionalroomName

roomName?: string

The chat room name.

Settings

Member Visibility

On This Page

Constructors
Properties