Options
All
  • Public
  • Public/Protected
  • All
Menu

User object.

Configure user ID and username to identify users in the room. Note that the userID must be unique under the same appID, otherwise, there will be mutual kicks when logging in to the room. It is strongly recommended that userID corresponds to the user ID of the business APP, that is, a userID and a real user are fixed and unique, and should not be passed to the SDK in a random userID. Because the unique and fixed userID allows ZEGO technicians to quickly locate online problems.

Hierarchy

  • ZegoUser

Index

Constructors

Properties

Constructors

constructor

  • new ZegoUser(userID: string, userName: string): ZegoUser
  • Parameters

    • userID: string
    • userName: string

    Returns ZegoUser

Properties

userID

userID: string

User ID, a utf8 string with a maximum length of 64 bytes or less.Privacy reminder: Please do not fill in sensitive user information in this field, including but not limited to mobile phone number, ID number, passport number, real name, etc.Caution: Only support numbers, English characters and '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', ''. Do not use '%' if you need to communicate with the Web SDK.

userName

userName: string

User Name, a utf8 string with a maximum length of 256 bytes or less.Please do not fill in sensitive user information in this field, including but not limited to mobile phone number, ID number, passport number, real name, etc.

Generated using TypeDoc