Interface IDressingRoomBuilder

The MDRC builder interface to construct an MDRC instance.

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

interface IDressingRoomBuilder {
    build(): Promise<{
        api: IDressingRoomApi;
    }>;
    forOrganisation(org: string): IDressingRoomBuilder;
    getSetting(collectionId: string, organizationId?: string): Promise<null | IMDRCSettingV1>;
    withHostAdaptor(hostAdaptor: HostAdaptor): IDressingRoomBuilder;
}

Index

Methods

build forOrganisation getSetting withHostAdaptor

Methods

build

build(): Promise<{
api: IDressingRoomApi;
}>
Build the MDRC instance

Returns Promise<{
api: IDressingRoomApi;
}>
- Defined in packages/public-types/src/mdrc.ts:77

forOrganisation

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

getSetting

getSetting(collectionId, organizationId?): Promise<null | IMDRCSettingV1>
Fetch the MDRC setting from the central asset platform
Parameters
- collectionId: string
  The reference id
- OptionalorganizationId: string
  The organization id
Returns Promise<null | IMDRCSettingV1>
- Defined in packages/public-types/src/mdrc.ts:65

withHostAdaptor

withHostAdaptor(hostAdaptor): IDressingRoomBuilder
Register a host adaptor for the MDRC instance that is constructed here.
Parameters
- hostAdaptor: HostAdaptor
  The host adaptor
Returns IDressingRoomBuilder
- Defined in packages/public-types/src/mdrc.ts:72