Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoomStore

The RoomStore class is used for initializing rooms and listening for the room data.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

classroomSchedule

classroomSchedule: ClassroomSchedule

Classroom schedule info

Accessors

acceptedList

carousel

clientServerTimeShift

  • get clientServerTimeShift(): number

  • Difference between server and local time(non-observable), unit: milliseconds

    Returns number

clockTime

  • get clockTime(): number

  • Clock time of the room

    Returns number

expandedScope

flexProps

  • get flexProps(): Record<string, any>

  • Custom room properties

    Returns Record<string, any>

inviteList

  • List of users which are being invited to the stage

    Returns HandUpProgress[]

isOnPodium

  • get isOnPodium(): boolean

  • Whether the local user is on stage

    Returns boolean

isScreenSharing

  • get isScreenSharing(): boolean

  • Whether the local user is currently sharing the screen

    Returns boolean

recordOnHold

  • get recordOnHold(): boolean

  • Whether the recording has been ready

    Returns boolean

recordReady

  • get recordReady(): boolean

  • Whether the recording has been ready

    Returns boolean

recordStatus

recordStreamingUrl

screenShareStreamUuid

  • get screenShareStreamUuid(): undefined | string

  • Returns undefined | string

screenShareUserUuid

  • get screenShareUserUuid(): undefined | string

  • Returns undefined | string

waveArmList

Methods

addCustomMessageObserver

removeCustomMessageObserver

sendCustomChannelMessage

  • sendCustomChannelMessage(data: Record<string, any>, needSync?: boolean): Promise<void>

  • Parameters

    • data: Record<string, any>
    • Optional needSync: boolean

    Returns Promise<void>

sendCustomPeerMessage

  • sendCustomPeerMessage(data: Record<string, any>, toUserUuid: string, needAck?: boolean): Promise<void>

  • Parameters

    • data: Record<string, any>
    • toUserUuid: string
    • Optional needAck: boolean

    Returns Promise<void>

sendRewards

  • sendRewards(rewards: { changeReward: number; userUuid: string }[], isBatch?: boolean): Promise<void>

  • Sends rewards to users

    Parameters

    • rewards: { changeReward: number; userUuid: string }[]

      userUuid: user being rewarded, changeRecord: reward quantity

    • Optional isBatch: boolean

      Whether sends records in a batch

    Returns Promise<void>

startCarousel

  • startCarousel(params: Pick<CarouselSetting, "range" | "type" | "interval">): Promise<void>

  • Starts the video gallery rotation

    Parameters

    • params: Pick<CarouselSetting, "range" | "type" | "interval">

      Carousel setting

    Returns Promise<void>

stopCarousel

  • stopCarousel(): Promise<void>

  • Stops the video carousel rotation

    Returns Promise<void>

updateClassState

  • updateClassState(state: ClassState): Promise<void>

  • Updates the class state

    Parameters

    Returns Promise<void>

updateFlexProperties

  • updateFlexProperties(properties: any, cause: any): Promise<void>

  • Updates room flex properties

    Parameters

    • properties: any
    • cause: any

    Returns Promise<void>