Class AgoraWidgetController
Properties
logger
logger: LoggerFacade
Accessors
widgetIds
- get widgetIds(): string[]
Methods
broadcast
- broadcast(messageType: string, message?: unknown): void
Parameters
messageType: string
Optional message: unknown
Returns void
deleteWidget
- deleteWidget(widgetId: string): Promise<{ data: any }>
Parameters
Returns Promise<{ data: any }>
getWidgetProperties
- getWidgetProperties(widgetId: string): any
getWidgetState
- getWidgetState(widgetId: string): any
getWidgetTrack
- getWidgetTrack(widgetId: string): any
getWidgetUserProperties
- getWidgetUserProperties(widgetId: string): any
removeWidgetExtraProperties
- removeWidgetExtraProperties(widgetId: string, keys?: string[]): Promise<{ data: any }>
Parameters
widgetId: string
Optional keys: string[]
Returns Promise<{ data: any }>
removeWidgetMessageListener
removeWidgetStateListener
removeWidgetUserProperties
- removeWidgetUserProperties(widgetId: string, keys?: string[]): Promise<{ data: any }>
Parameters
widgetId: string
Optional keys: string[]
Returns Promise<{ data: any }>
sendMessage
- sendMessage(toWidgetId: string, messageType: string, message?: unknown): void
Parameters
toWidgetId: string
messageType: string
Optional message: unknown
Returns void
setWidegtActive
- setWidegtActive(widgetId: string, props?: any, ownerUserUuid?: string): Promise<{ data: any }>
Parameters
widgetId: string
Optional props: any
Optional ownerUserUuid: string
Returns Promise<{ data: any }>
setWidgetInactive
- setWidgetInactive(widgetId: string, props?: any): Promise<{ data: any }>
Parameters
widgetId: string
Optional props: any
Returns Promise<{ data: any }>
updateWidgetProperties
- updateWidgetProperties(widgetId: string, props: any): Promise<{ data: any }>
Parameters
widgetId: string
props: any
Returns Promise<{ data: any }>
updateWidgetUserProperties
- updateWidgetUserProperties(widgetId: string, props: any): void
Parameters
widgetId: string
props: any
Returns void