Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ZegoRoomConfig

Advanced room configuration.

Configure maximum number of users in the room and authentication token, etc.

Hierarchy

  • ZegoRoomConfig

Index

Constructors

Properties

Constructors

constructor

  • new ZegoRoomConfig(maxMemberCount: number, isUserStatusNotify: boolean, token: string): ZegoRoomConfig

  • Parameters

    • maxMemberCount: number
    • isUserStatusNotify: boolean
    • token: string

    Returns ZegoRoomConfig

Properties

isUserStatusNotify

isUserStatusNotify: boolean

Whether to enable the user in and out of the room callback notification [onRoomUserUpdate], the default is off. If developers need to use ZEGO Room user notifications, make sure that each user who login sets this flag to true

maxMemberCount

maxMemberCount: number

The maximum number of users in the room, Passing 0 means unlimited, the default is unlimited.

token

token: string

The token issued by the developer's business server is used to ensure security. For the generation rules, please refer to Using Token Authentication, the default is an empty string, that is, no authentication. In versions 2.17.0 and above, if appSign is not passed in when calling the [createEngine] API to create an engine, or if appSign is empty, this parameter must be set for authentication when logging in to a room.

Generated using TypeDoc