Class ConnectionStore

The ConnectionStore class is used for managing connection states.

Hierarchy

EduStoreBase
- ConnectionStore

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ConnectionStore(store: EduClassroomStore): ConnectionStore

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

Properties

classroomState

classroomState: ClassroomState

Room connection state

Optional engine

engine?: AgoraRteEngine

RTE engine

rtcState

rtcState: AGRtcState

RTC connection state

Accessors

scene

get scene(): undefined | AgoraRteScene

current scene object

Returns undefined | AgoraRteScene

sceneId

get sceneId(): string

Current scene id

Returns string

Methods

addCloudProxyObserver

addCloudProxyObserver(observer: AgoraCloudProxyObserver): void

Adds an observer for cloud proxy, this method can only be called after joinClassroom succeeds

Parameters
- observer: AgoraCloudProxyObserver
Returns void

checkIn

checkIn(sessionInfo: EduSessionInfo, sceneType: SceneType, mode: "check-in" | "entry"): Promise<void>

Precheck before joining the room, call this method before joining room.

Parameters
- sessionInfo: EduSessionInfo
  
  session info
- sceneType: SceneType
  
  sceneType
- mode: "check-in" | "entry"
Returns Promise<void>

getEngine

getEngine(): AgoraRteEngine

Gets instance of RTE Engine, it will throw if this method gets called before calling connectionStore.initialize

Returns AgoraRteEngine
RTE engine

getRtcState

getRtcState(connectionType: AGRtcConnectionType): AGRtcState

Gets the RTC state

Parameters
- connectionType: AGRtcConnectionType
Returns AGRtcState

initialize

initialize(): void

Initializes RteEngine

Returns void

joinClassroom

joinClassroom(options?: { mode: "check-in" | "entry" }): Promise<undefined>

Joins the room

Parameters
- Optional options: { mode: "check-in" | "entry" }
  - mode: "check-in" | "entry"
Returns Promise<undefined>

joinRTC

joinRTC(options?: AgoraRteSceneJoinRTCOptions): Promise<void>

Joins an RTC channel

Parameters
- Optional options: AgoraRteSceneJoinRTCOptions
  
  The RTC options
Returns Promise<void>

joinSubRoom

joinSubRoom(roomUuid: string): Promise<void>

Joins a sub-room

Parameters
- roomUuid: string
  
  The sub-room ID
Returns Promise<void>

leaveClassroom

leaveClassroom(reason: LeaveReason, promise?: Promise<void>): Promise<void>

Leaves the room

Parameters
- reason: LeaveReason
  
  The reason
- Optional promise: Promise<void>
Returns Promise<void>

leaveRTC

leaveRTC(connectionType?: AGRtcConnectionType): Promise<void>

Leaves the RTC channel

Parameters
- Optional connectionType: AGRtcConnectionType
  
  connection type
Returns Promise<void>

leaveSubRoom

leaveSubRoom(): Promise<void>

Leaves the sub-room

Returns Promise<void>

onDestroy

onDestroy(): void

Overrides EduStoreBase.onDestroy
Returns void

onInstall

onInstall(): void

Overrides EduStoreBase.onInstall
Returns void

removeCloudProxyObserver

removeCloudProxyObserver(observer: AgoraCloudProxyObserver): void

Removes an observer for cloud proxy, this method can only be called after joinClassroom succeeds

Parameters
- observer: AgoraCloudProxyObserver
Returns void