Skip to main content

Type Alias: SpiffThemeLoader

SpiffThemeLoader = object

Methods​

addToEcommerceCart()​

addToEcommerceCart(message): void

Sends the provided design information to the e-commerce platform and adds the design to the cart.

Parameters​

message​

DesignCreationMessage | BundleDesignCreationMessage

The design information to send.

Returns​

void


close()​

close(): void

Closes the theme and exits the Spiff Commerce platform.

Returns​

void


completeQuote()​

completeQuote(message?): void

Signal that a quote has been completed.

Parameters​

message?​

CompleteQuoteMessage

The quote information to send.

Returns​

void


configureClient()​

configureClient(client): void

Configures the provided SpiffCommerceClient instance with the necessary settings to communicate with the Spiff Commerce API.

Parameters​

client​

SpiffCommerceClient

The SpiffCommerceClient instance to configure.

Returns​

void


getContext()​

getContext(): Promise<ThemeContext>

Retrieves the current theme context. If the context is not yet available, this method will return a promise that resolves when the context is available.

Returns​

Promise<ThemeContext>


navigateToCustomerPortal(): void

Navigates away from the Theme and launches the Customer Portal.

WARNING: This will immediately exit your session.

Returns​

void


themeLoaded()​

themeLoaded(): void

Notifies the Spiff Commerce platform that the theme has been loaded. This hides any loading indicators and allows the user to interact with the theme.

Returns​

void