Interface HostAdaptor

Interface for connecting the Modal Dressing Room Component (MDRC) with the host website. THe adaptor is responsible for providing information about the content in the dressing room. This covers garments, avatars and scenes. Furthermore, it provides (optional) functionality for further functionality like add to cart, looking sharing or custom avatars.

interface HostAdaptor {
    analytics?: AnalyticsConfig;
    animations?: IAnimationProvider;
    avatars: ByMode<IAvatarProvider>;
    callbacks?: IHostCallbacks;
    commerce?: ICommerceProvider;
    customAvatars?: ByMode<IMutableAvatarProvider>;
    dressingRoom: {
        mode: RenderMode;
        options?: IDressingRoomOptions;
    };
    garments: ByMode<IGarmentProvider>;
    inventory?: IInventoryProvider;
    logger?: ILoggingProvider;
    performanceMetrics?: IPerformanceMetricsProvider;
    scenes: ByMode<ISceneProvider>;
    sharing?: ISharingProvider;
    translator?: ITranslator;
}

Properties

analytics? animations? avatars callbacks? commerce? customAvatars? dressingRoom garments inventory? logger? performanceMetrics? scenes sharing? translator?

Properties

Optionalanalytics

analytics?: AnalyticsConfig

Optionalanimations

animations?: IAnimationProvider

avatars

avatars: ByMode<IAvatarProvider>

Mandatory provider to populate the dressing room with avatars.

Optionalcallbacks

callbacks?: IHostCallbacks

Optionalcommerce

commerce?: ICommerceProvider

OptionalcustomAvatars

customAvatars?: ByMode<IMutableAvatarProvider>

dressingRoom

dressingRoom: {
    mode: RenderMode;
    options?: IDressingRoomOptions;
}

garments

garments: ByMode<IGarmentProvider>

Mandatory provider to populate the dressing room with garments.

Optionalinventory

inventory?: IInventoryProvider

Optionallogger

logger?: ILoggingProvider

OptionalperformanceMetrics

performanceMetrics?: IPerformanceMetricsProvider

scenes

scenes: ByMode<ISceneProvider>

Mandatory provider to populate the dressing room with scenes.

Optionalsharing

sharing?: ISharingProvider

Optionaltranslator

translator?: ITranslator

Settings

Member Visibility

On This Page

Properties