Interface GarmentInformationProvider

interface GarmentInformationProvider {
    getBrand?(reference: AssetReference): Awaitable<undefined | string>;
    getDetailLink(reference: AssetReference): Awaitable<undefined | string>;
    getName(reference: AssetReference): Awaitable<undefined | string>;
    getPrice(reference: AssetReference): Awaitable<undefined | {
        currency: string;
        price: number;
        strikePrice?: number;
    }>;
    getSizes?(id: ReferenceData): Awaitable<ItemSize[]>;
    isAvailable?(reference: AssetReference): Awaitable<boolean>;
    preLoad?(items: AssetReference[]): Awaitable<void>;
}

Implemented by

DefaultInformationProvider

Index

Methods

getBrand? getDetailLink getName getPrice getSizes? isAvailable? preLoad?

Methods

`Optional`getBrand

getBrand(reference): Awaitable<undefined | string>
Parameters
- reference: AssetReference
Returns Awaitable<undefined | string>
- Defined in packages/public-types/src/virtual-styling.ts:66

getDetailLink

getDetailLink(reference): Awaitable<undefined | string>
Parameters
- reference: AssetReference
Returns Awaitable<undefined | string>
- Defined in packages/public-types/src/virtual-styling.ts:72

getName

getName(reference): Awaitable<undefined | string>
Parameters
- reference: AssetReference
Returns Awaitable<undefined | string>
- Defined in packages/public-types/src/virtual-styling.ts:65

getPrice

getPrice(reference): Awaitable<undefined | {
    currency: string;
    price: number;
    strikePrice?: number;
}>
Parameters
- reference: AssetReference
Returns Awaitable<undefined | {
    currency: string;
    price: number;
    strikePrice?: number;
}>
- Defined in packages/public-types/src/virtual-styling.ts:67

`Optional`getSizes

getSizes(id): Awaitable<ItemSize[]>
Returns the available sizes for a garment with the given ID.
Parameters
- id: ReferenceData
  Unique ID of the garment
Returns Awaitable<ItemSize[]>
- Defined in packages/public-types/src/virtual-styling.ts:87

`Optional`isAvailable

isAvailable(reference): Awaitable<boolean>
If this methods is defined, it can be used to determine if a garment should be used in the expirience. If this methods returns false, that garment is removed from the garment selection AND all outfits that reference this garment are also removed and not available!
Parameters
- reference: AssetReference
  The garment in question
Returns Awaitable<boolean>
- Defined in packages/public-types/src/virtual-styling.ts:81

`Optional`preLoad

preLoad(items): Awaitable<void>
Allows the provider to preload and batch load garment information.
Parameters
- items: AssetReference[]
  The array of references that should be preloaded
Returns Awaitable<void>
- Defined in packages/public-types/src/virtual-styling.ts:93