Documentation
    Preparing search index...

    Interface RcsEmbeddedEngineOptions<App>

    Options for the RcsEmbeddedEngine.

    interface RcsEmbeddedEngineOptions<App extends FederatedApplicationName> {
        application: App;
        assetId: string;
        authTokenResolver: () => Promise<string>;
        dev?: boolean;
        overwriteAPIHost?: string;
        remoteEnvironment?: string;
    }

    Type Parameters

    Index

    Properties

    application assetId authTokenResolver dev? overwriteAPIHost? remoteEnvironment?

    Properties

    application: App

    The application for which the RCS is being embedded. Determins the configuration to use.

    assetId: string

    The ID of the asset to be rendered.

    authTokenResolver: () => Promise<string>

    A (async) function that resolves the authentication token for the user.

    dev?: boolean

    Optional flag to enable development mode. Will properly configure remote environments for localhost development.

    overwriteAPIHost?: string

    Optional remote environment to override the default host for the API. When not set, the API host will be determined by the remote environment.

    remoteEnvironment?: string

    Optional remote environment from which to load the remote RCS application. Defaults to prod if not specified.

    Settings

    Member Visibility

    On This Page

    Properties