Interface GarmentProvider

Provides information about the garments in the dressing room

interface GarmentProvider {
    addById?: ((id: ReferenceData) => void);
    getAddedAt?: ((id: ReferenceData) => Awaitable<undefined | Date>);
    getById(id: ReferenceData): Awaitable<undefined | AssetInfo>;
    getIds(): Awaitable<ReferenceData[]>;
    getName(id: ReferenceData): Awaitable<undefined | string>;
    getThumbnail(id: ReferenceData): Awaitable<undefined | string>;
    removeById(id: ReferenceData): Awaitable<void>;
}

Hierarchy

AssetProvider
- GarmentProvider

Index

Properties

addById? getAddedAt?

Methods

getById getIds getName getThumbnail removeById

Properties

`Optional`addById

addById?: ((id: ReferenceData) => void)

Callback to add a garments from a shared look into the current dressing room / garment provider.

Type declaration

- (id): void
- Parameters
  - id: ReferenceData
    Unique ID if the garment as used in your systems
  Returns void

`Optional`getAddedAt

getAddedAt?: ((id: ReferenceData) => Awaitable<undefined | Date>)

Return the date at which the garment was added to the MDRC.

Type declaration

- (id): Awaitable<undefined | Date>
- Parameters
  - id: ReferenceData
    Unique ID if the garment as used in your systems
  Returns Awaitable<undefined | Date>
  The date the garment as added

Methods

getById

getById(id): Awaitable<undefined | AssetInfo>
Returns the asset bundle for a specific resource
Parameters
- id: ReferenceData
  Unique ID if the garment as used in your systems
Returns Awaitable<undefined | AssetInfo>
Inherited from AssetProvider.getById
- Defined in packages/public-types/src/mdrc.ts:41

getIds

getIds(): Awaitable<ReferenceData[]>
Returns a list of ids for the available resources for this provider.

Returns Awaitable<ReferenceData[]>
Inherited from AssetProvider.getIds
- Defined in packages/public-types/src/mdrc.ts:36

getName

getName(id): Awaitable<undefined | string>
Return the display name of a garment as string. This will be shown for example below the garment tile and in the details drawer.
Parameters
- id: ReferenceData
  Unique ID if the garment as used in your systems
Returns Awaitable<undefined | string>
- Defined in packages/public-types/src/mdrc.ts:59

getThumbnail

getThumbnail(id): Awaitable<undefined | string>
Returns an url to the thumbnail image of a garment. This will be shown for example below the garment tile and in the details drawer.
Parameters
- id: ReferenceData
Returns Awaitable<undefined | string>
- Defined in packages/public-types/src/mdrc.ts:64

removeById

removeById(id): Awaitable<void>
Removes the given garment from the dressing room. Is called when someone clicks "Remove from dressing room" on a garment tile.
Parameters
- id: ReferenceData
  Unique ID if the garment as used in your systems
Returns Awaitable<void>
- Defined in packages/public-types/src/mdrc.ts:70