Interface VirtualStylingBuilder

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

Index

Methods

addConsentCallback addGoogleAnalytics build forOrganisation getCollection setAnalytics setAvatarPosition setCustomStyle setECommerceProvider setGarmentInformationProvider setSharingProvider

Methods

addConsentCallback

addConsentCallback(cb): void
Parameters
- cb: (() => {
  consent?: ConsentState;
  internalAnalytics?: boolean;
  })
  - - (): {
      consent?: ConsentState;
      internalAnalytics?: boolean;
      }
    - Returns {
      consent?: ConsentState;
      internalAnalytics?: boolean;
      }
      Optionalconsent?: ConsentState
      OptionalinternalAnalytics?: boolean
Returns void
- Defined in packages/public-types/src/virtual-styling.ts:127

addGoogleAnalytics

addGoogleAnalytics(ga?): VirtualStylingBuilder
Parameters
- Optionalga: string
Returns VirtualStylingBuilder
- Defined in packages/public-types/src/virtual-styling.ts:123

build

build(): Promise<{
api: VirtualStylingApi;
opened: boolean;
}>
Returns Promise<{
api: VirtualStylingApi;
opened: boolean;
}>
- Defined in packages/public-types/src/virtual-styling.ts:131

forOrganisation

forOrganisation(org): VirtualStylingBuilder
Parameters
- org: string
Returns VirtualStylingBuilder
- Defined in packages/public-types/src/virtual-styling.ts:118

getCollection

getCollection(collectionId, organizationId?): Promise<null | Collection>
Parameters
- collectionId: string
- OptionalorganizationId: string
Returns Promise<null | Collection>
- Defined in packages/public-types/src/virtual-styling.ts:119

Interface VirtualStylingBuilder

Index

Methods

Methods

addConsentCallback

Parameters

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

Optionalconsent?: ConsentState

OptionalinternalAnalytics?: boolean

Returns void

addGoogleAnalytics

Parameters

Returns VirtualStylingBuilder

build

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

forOrganisation

Parameters

Returns VirtualStylingBuilder

getCollection

Parameters

Returns Promise<null | Collection>

setAnalytics

Parameters

Returns VirtualStylingBuilder

setAvatarPosition

Parameters

Returns VirtualStylingBuilder

setCustomStyle

Parameters

Returns VirtualStylingBuilder

setECommerceProvider

Parameters

Returns VirtualStylingBuilder

setGarmentInformationProvider

Parameters

Returns VirtualStylingBuilder

setSharingProvider

Parameters

Returns VirtualStylingBuilder

Settings

On This Page

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

`Optional`consent?: ConsentState

`Optional`internalAnalytics?: boolean

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