Class HandUpStore

The HandUpStore class provides abilities related to the hand-raising feature.

Hierarchy

EduStoreBase
- HandUpStore

Index

Constructors

constructor

Methods

Constructors

constructor

new HandUpStore(store: EduClassroomStore): HandUpStore

Inherited from EduStoreBase.constructor
Parameters
- store: EduClassroomStore
Returns HandUpStore

Methods

allowHandsUp

allowHandsUp(state: 0 | 1, autoStage: boolean): void

Configure allowing students to raise hands

Parameters
- state: 0 | 1
  
  Whether allow raising hands or not, 0 not allowed, 1 allowed
- autoStage: boolean
  
  Whether 'auto up stage' is enabled or not
Returns void

cancelHandUp

cancelHandUp(): Promise<void>

The student lowers the hand to cancel the application for "going onto the stage"

Returns Promise<void>

confirmInvited

confirmInvited(): Promise<void>

Confirm the acceptance by the invitation

Returns Promise<void>

invitePodium

invitePodium(userUuid: string, duration: number, payload?: unknown): Promise<void>

Invited students interaction

Parameters
- userUuid: string
  
  The student ID
- duration: number
  
  duration to timeout
- Optional payload: unknown
  
  extra info
Returns Promise<void>

offPodium

offPodium(userUuid: string): Promise<void>

Lets a student "go off the stage"

Parameters
- userUuid: string
  
  The user ID
Returns Promise<void>

offPodiumAll

offPodiumAll(): Promise<void>

Lets all students "go off the stage"

Returns Promise<void>

onPodium

onPodium(userUuid: string, source?: PodiumSrouce): Promise<void>

Allows a student to "go onto the stage"

Parameters
- userUuid: string
  
  The user ID
- Optional source: PodiumSrouce
  The source:
  - The teacher requests the student in the user list to "go onto the stage".
  - The teacher accepts the student's application for "going onto the stage".
Returns Promise<void>

rejectHandUp

rejectHandUp(userUuid: string): Promise<void>

The teacher rejects the student's application for "going onto the stage"

Parameters
- userUuid: string
  
  The user ID
Returns Promise<void>

waveArm

waveArm(teacherUuid: string, duration: number, payload?: unknown): Promise<void>

The student waves a hand to apply for "going onto the stage"

Parameters
- teacherUuid: string
  
  The teacher ID
- duration: number
  
  duration to timeout
- Optional payload: unknown
  
  extra info
Returns Promise<void>