Chat SDK v1.3.5 for React Native
    Preparing search index...

    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.

    Index

    Constructors

    • Parameters

      • params: {
            adminList?: string[];
            announcement?: string;
            blockList?: string[];
            description?: string;
            isAllMemberMuted?: boolean;
            maxUsers?: string;
            memberCount?: string;
            memberList?: string[];
            muteList?: string[];
            owner: string;
            permissionType: number;
            roomId: string;
            roomName?: string;
        }

      Returns ChatRoom

    Properties

    adminList?: string[]

    The admin list of the chat room.

    announcement?: string

    The chat room announcement.

    blockList?: string[]

    The block list of the chat room.

    description?: string

    The chat room description.

    isAllMemberMuted?: boolean

    Whether all members are muted in the chat room.

    • true: Yes.
    • false: No.
    maxUsers?: string

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

    memberCount?: string

    The number of members in the chat room.

    memberList?: string[]

    The member list of the chat room.

    muteList?: string[]

    The mute list of the chat room.

    owner: string

    The user ID of the chat room owner.

    permissionType: ChatRoomPermissionType

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

    roomId: string

    The chat room ID.

    roomName?: string

    The chat room name.