Core
Methods
getModule
getModule(token: Token
): undefined | Module
Returns a registered module by its token synchronously.
If no module is registered with the specified token, returns undefined.
See: ConferenceManager, CallManager, SmartQueue, Messaging, StreamModule, NoiseSuppressionBalanced, NoiseSuppressionAggressive
Returns
type:
undefined | Module
getModuleAsync
getModuleAsync(token: Token
): Promise<Module>
Returns a registered module by its token.
If a module with the specified token is registered, returns it immediately.
If a module with the specified token is not registered, returns a promise that is resolved/rejected only after the module registration is complete.
See: ConferenceManager, CallManager, SmartQueue, Messaging, StreamModule, NoiseSuppressionBalanced, NoiseSuppressionAggressive
Returns
type:
Promise<Module>
Throws
CoreInternalError if a module registration has failed after this method call
init
init(options: ): Initializes the SDK and returns an instance.
If the SDK is already initialized, returns the previously created instance without applying the new options.
Parameters
options:
Initialization options
Returns
type:
registerModules
registerModules(modules: ModuleLoader[]
): void
Registers the SDK modules in the WebSDK container.
It is allowed to call this method multiple times and register the modules as needed.
Modules cannot be obtained and used until they are successfully registered.
After calling this method, all specified modules are initialized and available via Core.getModule or Core.getModuleAsync.
See: ConferenceLoader, CallLoader, SmartQueueLoader, MessagingLoader, StreamLoader, NoiseSuppressionBalancedLoader, NoiseSuppressionAggressiveLoader
Parameters
modules:
ModuleLoader[]
Returns
type:
void