Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserStore

The UserStore class is used for managing users.

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

assistantList

localUser

rewards

  • get rewards(): Map<string, number>

  • Rewards info map key: User UUID value: The number of rewards the user gets

    Returns Map<string, number>

studentList

teacherList

userCount

  • get userCount(): number

  • Number of users in the room

    Returns number

users

Methods

fetchUserList

  • fetchUserList(params: FetchUserParam): Promise<{ count: any; list: any; nextId: any; total: any }>

  • Gets the user list

    Parameters

    Returns Promise<{ count: any; list: any; nextId: any; total: any }>

    User list

kickOutOnceOrBan

  • kickOutOnceOrBan(userUuid: string, isBan: boolean): Promise<undefined>

  • Kicks a user out of the room

    Parameters

    • userUuid: string

      The user ID

    • isBan: boolean

      Whether to ban the user

    Returns Promise<undefined>

updateUserProperties

  • updateUserProperties(users: { cause?: any; properties: any; userUuid: string }[], fromScene?: AgoraRteScene): Promise<void>

  • Updates users properties

    Parameters

    • users: { cause?: any; properties: any; userUuid: string }[]

      Information about the user properties to be updated

    • Optional fromScene: AgoraRteScene

      The room object in which the user resides. If not passed, defaults to the current room

    Returns Promise<void>