au-widget-pim-ajax

Classes

AuWidgetProductInformationAJAX

Provides methods for saving and restoring widget data.

Implements

• IRestorableWidget

Constructors

Constructor

new AuWidgetProductInformationAJAX(): AuWidgetProductInformationAJAX;

Returns

AuWidgetProductInformationAJAX

Overrides

AuBaseInvisibleWidget.constructor;

Properties

params

params: any;

Compiled widget configuration.

Inherited from

AuBaseInvisibleWidget.params;

Accessors

backOfficeUrl

Get Signature

get backOfficeUrl(): string;

Returns

string

costDetails

Get Signature

get costDetails(): ProductCostDetailsDto;

Returns

ProductCostDetailsDto

currencyCode

Get Signature

get currencyCode(): string;

Returns

string

currentChoices

Get Signature

get currentChoices(): Record<string, number[]>;

Returns

Record<string, number[]>

designs

Get Signature

get designs(): ProductInformationDesign[];

Returns

ProductInformationDesign[]

designsSettings

Get Signature

get designsSettings(): DesignVariantsApiPointParams;

Returns

DesignVariantsApiPointParams

driverChoices

Get Signature

get driverChoices(): Record<string, number[]>;

Returns

Record<string, number[]>

isPreselectSelectionStrategy

Get Signature

get isPreselectSelectionStrategy(): boolean;

Returns

boolean

mockups

Get Signature

get mockups(): ProductInformationMockup[];

Returns

ProductInformationMockup[]

mockupsSettings

Get Signature

get mockupsSettings(): ApiParams;

Returns

ApiParams

options

Get Signature

get options(): ProductInformationOption[];

Returns

ProductInformationOption[]

price

Get Signature

get price(): number;

Returns

number

priceIsFetching

Get Signature

get priceIsFetching(): boolean;

Returns

boolean

productId

Get Signature

get productId(): string | number;

Returns

string | number

productInfo

Get Signature

get productInfo(): ProductInformation;

Returns

ProductInformation

productLinkId

Get Signature

get productLinkId(): string | number;

Returns

string | number

productVersionId

Get Signature

get productVersionId(): string | number;

Returns

string | number

quantity

Get Signature

get quantity(): number;

Returns

number

reference

Get Signature

get reference(): string;

Returns

string

selectedVariantSku

Get Signature

get selectedVariantSku(): string;

Returns

string

selectionStrategy

Get Signature

get selectionStrategy(): SelectionStrategy;

Returns

SelectionStrategy

storefrontId

Get Signature

get storefrontId(): string;

Returns

string

storefrontUserId

Get Signature

get storefrontUserId(): string;

Returns

string

summary

Get Signature

get summary(): any;

Returns

any

tenantId

Get Signature

get tenantId(): number;

Returns

number

token

Get Signature

get token(): string;

Returns

string

variants

Get Signature

get variants(): ProductInformationVariant[];

Returns

ProductInformationVariant[]

variantsHashMap

Get Signature

get variantsHashMap(): Record<string, number[]>[];

Returns

Record<string, number[]>[]

variantsSettings

Get Signature

get variantsSettings(): ApiParams;

Returns

ApiParams

template

Get Signature

get static template(): any;

Returns

any

Inherited from

AuBaseInvisibleWidget.template;

Methods

checkInitDependenciesWidgets()

checkInitDependenciesWidgets(): string[];

Returns an array of widget names, due to which the current widget cannot receive parameters.

Returns

string[]

Inherited from

AuBaseInvisibleWidget.checkInitDependenciesWidgets;

exportWidgetData()

exportWidgetData(force): Promise<any>;

Parameters

Parameter	Type
force	boolean

Returns

Promise<any>

Implementation of

IRestorableWidget.exportWidgetData

getDesignVariants()

getDesignVariants(productId, params): Promise<PagedOfProductVariantDesignDto>;

Parameters

Parameter	Type
productId	number
params	DesignVariantsApiPointParams

Returns

Promise<PagedOfProductVariantDesignDto>

getMockupVariants()

getMockupVariants(productId, params): Promise<PagedOfProductVariantDesignDto>;

Parameters

Parameter	Type
productId	number
params	ApiParams

Returns

Promise<PagedOfProductVariantDesignDto>

getProductVariants()

getProductVariants(productId, params): Promise<PagedOfProductVariantDto>;

Parameters

Parameter	Type
productId	number
params	ApiParams

Returns

Promise<PagedOfProductVariantDto>

resetPreloaderState()

resetPreloaderState(): void;

Returns

void

Inherited from

AuBaseInvisibleWidget.resetPreloaderState;

restoreWidgetFromData()

restoreWidgetFromData(data, force): Promise<void>;

Parameters

Parameter	Type
data	any
force	boolean

Returns

Promise<void>

Implementation of

IRestorableWidget.restoreWidgetFromData

showPreloader()

showPreloader(
   isPreload,
   message?,
   timeout?): void;

Shows a preloader.

"onClick": [
  "{{#function main.showPreloader(true, 'Creating print files...')}}",
  "{{#function $['editor'].getHiResImages(800,800)}}",
  "{{#function main.showPreloader(false)}}"
]

Parameters

Parameter	Type	Default value	Description
isPreload	boolean	undefined	If true, enables the preloader.
message	string | string[]	...	A text message that appears next to the preloader.
timeout	number	5	-

Returns

void

Inherited from

AuBaseInvisibleWidget.showPreloader;

showToast()

showToast(data?, duration?): void;

Shows a toast.

return editor.loadUserInfo(data)
    .catch(err => {
        this.widget.showToast("Error: Invalid data");
        console.log(err);
    });

Parameters

Parameter	Type	Description
data?	string	A string message to display in the toast.
duration?	number	Defines how long to show the toast for.

Returns

void

Inherited from

AuBaseInvisibleWidget.showToast;

References

widget

Renames and re-exports AuWidgetProductInformationAJAX