文档中心
灵动课堂
API 参考
WidgetStore | agora classroom sdk
Edu Store API Reference for Web/Electron
Properties
Protected Readonly classroomStore
Protected Readonly logger
logger: Logger
Methods
deleteWidget
- deleteWidget(widgetId: string): undefined | Promise<{ data: any }>
Parameters
Returns undefined | Promise<{ data: any }>
removeWidgetExtra
- removeWidgetExtra(widgetId: string, keys?: string[]): undefined | Promise<{ data: any }>
Parameters
widgetId: string
Optional keys: string[]
Returns undefined | Promise<{ data: any }>
removeWidgetStateListener
removeWidgetUserProperties
- removeWidgetUserProperties(widgetId: string, keys?: string[]): undefined | Promise<{ data: any }>
Parameters
widgetId: string
Optional keys: string[]
Returns undefined | Promise<{ data: any }>
setActive
- setActive(widgetId: string, widgetProps?: any, ownerUserUuid?: string): void
Parameters
widgetId: string
Optional widgetProps: any
Optional ownerUserUuid: string
Returns void
setInactive
- setInactive(widgetId: string, widgetProps?: any): void
Parameters
widgetId: string
Optional widgetProps: any
Returns void
updateWidgetProperties
- updateWidgetProperties(widgetId: string, widgetProps?: any): undefined | Promise<{ data: any }>
Parameters
widgetId: string
Optional widgetProps: any
Returns undefined | Promise<{ data: any }>
updateWidgetUserProperties
- updateWidgetUserProperties(widgetId: string, widgetProps?: any): undefined | void
Parameters
widgetId: string
Optional widgetProps: any
Returns undefined | void
Responsibilities: 1.Provide data access and state access of the active widgets upward 2.Provide direct access of the instance of WidgetController 3.Provide APIs about widget, which can be used to activate, inactivate and update state of widgets