Class RcsEmbeddedEngine<App>

The RcsEmbeddedEngine class is responsible for embedding the RCS application into a host application.

Type Parameters

App extends FederatedApplicationName

Index

Constructors

Methods

attach destroy detatch getSDKClient

Constructors

constructor

new RcsEmbeddedEngine<App extends "multivista">(
options: RcsEmbeddedEngineOptions<App>,
): RcsEmbeddedEngine<App>
Type Parameters
- App extends "multivista"
Parameters
- options: RcsEmbeddedEngineOptions<App>
Returns RcsEmbeddedEngine<App>
- Defined in embedded/engine/src/lib/RcsEmbeddedEngine.tsx:58

Methods

attach

attach(
    container: HTMLElement,
    options?: {
        loaderComponent?: ReactElement<
            unknown,
            string
            | JSXElementConstructor<any>,
        >;
    },
): void
Renders the RCS application into the specified container element
Parameters
- container: HTMLElement
  The container element to attach the RCS to.
- Optionaloptions: { loaderComponent?: ReactElement<unknown, string | JSXElementConstructor<any>> }
  Optional parameters for the loader component. Works only if React is used as the framework.
Returns void
Remarks
- This method should only be called once per container.
- The container element should have a proper size (600x600) and be visible in the DOM.
- Defined in embedded/engine/src/lib/RcsEmbeddedEngine.tsx:73

destroy

destroy(): void
Permanently unmounts the React root and cleans up all resources. After calling this, the engine instance cannot be reattached.

Returns void
- Defined in embedded/engine/src/lib/RcsEmbeddedEngine.tsx:104

detatch

detatch(): void
Detaches the RCS application from the container element.

Returns void
- Defined in embedded/engine/src/lib/RcsEmbeddedEngine.tsx:94

getSDKClient

getSDKClient(): Promise<FederationSDKTypes[App] | null>
Returns the API client to interact with the RCS instance.

Returns Promise<FederationSDKTypes[App] | null>
Remarks
Depending on the application provided in the constructor options, this will return different SDK clients.
- multivista: Returns the FederationSDKMultivista client.
- Defined in embedded/engine/src/lib/RcsEmbeddedEngine.tsx:118