Interface IVirtualStylingBuilder

A builder interface for the VSC component. This allows to set up default settings for the VSC instance.

For the full documentation on the VSC component please take a look into our docs VSC documentation

See IGarmentInformationProvider on how to provide garment information to the VSC component.

See ICommerceProvider on how to provide e-commerce information and actions to the VSC component.

See hostAdaptors.SharingProvider on how to implement sharing functionality in the VSC component.

interface IVirtualStylingBuilder {
    addConsentCallback(cb: (() => {
        consent?: ConsentState;
        internalAnalytics?: boolean;
    })): void;
    addGoogleAnalytics(ga?: string): IVirtualStylingBuilder;
    build(): Promise<{
        api: IVirtualStylingApi;
        opened: boolean;
    }>;
    forOrganisation(org: string): IVirtualStylingBuilder;
    getCollection(collectionId: string, organizationId?: string): Promise<null | Collection>;
    setAnalytics(analytics: Partial<IAnalyticProvider>[]): IVirtualStylingBuilder;
    setAvatarPosition(position: TopBottomPosition): IVirtualStylingBuilder;
    setCustomStyle(style: string): IVirtualStylingBuilder;
    setECommerceProvider(commerceProvider: ICommerceProvider): IVirtualStylingBuilder;
    setGarmentInformationProvider(informationProvider: Partial<IGarmentInformationProvider>): IVirtualStylingBuilder;
    setSharingProvider(provider: ISharingProvider): IVirtualStylingBuilder;
}

Index

Methods

addConsentCallback addGoogleAnalytics build forOrganisation getCollection setAnalytics setAvatarPosition setCustomStyle setECommerceProvider setGarmentInformationProvider setSharingProvider

Methods

addConsentCallback

addConsentCallback(cb): void
Add a consent callback that can be used to query the consent state of the user.
Parameters
- cb: (() => {
  consent?: ConsentState;
  internalAnalytics?: boolean;
  })
  The callback
  - - (): {
      consent?: ConsentState;
      internalAnalytics?: boolean;
      }
    - Returns {
      consent?: ConsentState;
      internalAnalytics?: boolean;
      }
      Optionalconsent?: ConsentState
      OptionalinternalAnalytics?: boolean
Returns void
- Defined in packages/public-types/src/virtual-styling.ts:350

addGoogleAnalytics

addGoogleAnalytics(ga?): IVirtualStylingBuilder
Set up an integration with GA as analytics proider.
Parameters
- Optionalga: string
  measurement id
Returns IVirtualStylingBuilder
- Defined in packages/public-types/src/virtual-styling.ts:322

build

build(): Promise<{
api: IVirtualStylingApi;
opened: boolean;
}>
Construct the VSC component. This will always return the same instance, and doesn't allow for new configurations to be set after this call.

But further customizations can still be done using the options argument in the IVirtualStylingApi show function.

Returns Promise<{
api: IVirtualStylingApi;
opened: boolean;
}>
- Defined in packages/public-types/src/virtual-styling.ts:362

forOrganisation

forOrganisation(org): IVirtualStylingBuilder
Sets the default organization or customer id (these are the same)
Parameters
- org: string
  The organization or customer id
Returns IVirtualStylingBuilder
- Defined in packages/public-types/src/virtual-styling.ts:286

getCollection

getCollection(collectionId, organizationId?): Promise<null | Collection>
Fetch a collection based in the received reference id and organization id
Parameters
- collectionId: string
  The collection reference
- OptionalorganizationId: string
  The organization id
Returns Promise<null | Collection>
- Defined in packages/public-types/src/virtual-styling.ts:294

setAnalytics

setAnalytics(analytics): IVirtualStylingBuilder
Sets an Array of analytic providers
Parameters
- analytics: Partial<IAnalyticProvider>[]
Returns IVirtualStylingBuilder
- Defined in packages/public-types/src/virtual-styling.ts:308

setAvatarPosition

setAvatarPosition(position): IVirtualStylingBuilder
Set the avatar position
Parameters
- position: TopBottomPosition
  The position
Returns IVirtualStylingBuilder
- Defined in packages/public-types/src/virtual-styling.ts:336

setCustomStyle

setCustomStyle(style): IVirtualStylingBuilder
The custom css style to be used to customize the VSC look and feel.
Parameters
- style: string
  CSS style
Returns IVirtualStylingBuilder
- Defined in packages/public-types/src/virtual-styling.ts:329

setECommerceProvider

setECommerceProvider(commerceProvider): IVirtualStylingBuilder
Sets the default e-commerce provider.
Parameters
- commerceProvider: ICommerceProvider
  The e-commerce provider
Returns IVirtualStylingBuilder
- Defined in packages/public-types/src/virtual-styling.ts:315

setGarmentInformationProvider

setGarmentInformationProvider(informationProvider): IVirtualStylingBuilder
Sets the default information provider.
Parameters
- informationProvider: Partial<IGarmentInformationProvider>
  The information provider
Returns IVirtualStylingBuilder
- Defined in packages/public-types/src/virtual-styling.ts:301

setSharingProvider

setSharingProvider(provider): IVirtualStylingBuilder
Set the sharing provider.
Parameters
- provider: ISharingProvider
  The sharing provider that should be used.
Returns IVirtualStylingBuilder
- Defined in packages/public-types/src/virtual-styling.ts:343

Interface IVirtualStylingBuilder

Index

Methods

Methods

addConsentCallback

Parameters

Returns { consent?: ConsentState; internalAnalytics?: boolean; }

Optionalconsent?: ConsentState

OptionalinternalAnalytics?: boolean

Returns void

addGoogleAnalytics

Parameters

Returns IVirtualStylingBuilder

build

Returns Promise<{ api: IVirtualStylingApi; opened: boolean; }>

forOrganisation

Parameters

Returns IVirtualStylingBuilder

getCollection

Parameters

Returns Promise<null | Collection>

setAnalytics

Parameters

Returns IVirtualStylingBuilder

setAvatarPosition

Parameters

Returns IVirtualStylingBuilder

setCustomStyle

Parameters

Returns IVirtualStylingBuilder

setECommerceProvider

Parameters

Returns IVirtualStylingBuilder

setGarmentInformationProvider

Parameters

Returns IVirtualStylingBuilder

setSharingProvider

Parameters

Returns IVirtualStylingBuilder

Settings

On This Page

Returns {
consent?: ConsentState;
internalAnalytics?: boolean;
}

`Optional`consent?: ConsentState

`Optional`internalAnalytics?: boolean

Returns Promise<{
api: IVirtualStylingApi;
opened: boolean;
}>