Packages

Activates the Contextual Commerce SDK and initiates communication with Contextual Commerce servers.

Placement:

This function must be called on app launch before any other API functions, except those that register callbacks (e.g. subscribeGroupAssigned, subscribeMessageShown, subscribeErrorReporting, and registerGroupAssignmentProvider).

Declaration:

@JvmStatic
fun activateGranify(configuration: GranifyConfiguration)

Parameters:

Clears the current shopper identifier.

Placement:

This function should be called whenever the current shopper identifier is no longer applicable, such as user log-out.

Declaration:

@JvmStatic
fun clearShopperId()

Specifies a GranifyInlineView location in which to display inline widgets for testing purposes.

Placement:

Call this function when a user has manually entered an override string into a debug menu.

Declaration:

@JvmStatic
fun overrideGranifyInlineView(label: String?)

Parameters:

{"name": <GranifyInlineViewLabel.name>, "productId"(optional): <GranifyInlineViewLabel.productId>, "sku"(optional): <GranifyInlineViewLabel.sku>}

Register a callback provider for specifying group assignments when a new session is created.

In most cases, Contextual Commerce controls matching group assignments, but arrangements can be made with Contextual Commerce to control group assignments via this callback instead; thereby manually controlling the group split or delegating it to another provider. Permitted group values for your site may be a subset of those in the MatchingGroup enumeration, so work with your Account Manager to determine how to use this function for your specific needs.

Expect your provider callback to be invoked by Granify any time a request is made that may result in a new session. This will happen after the first trackPageView request is made and at arbitrary later points when starting a new session after expiry.

Note: An invocation of this callback does not necessarily indicate that a new session will start. In some cases, the SDK may expect the session to be expired even though it is still active on the server. For example, rebooting the application will clear all local state causing the SDK to assume a new session is needed (thereby invoking this callback) even though the server can recover the existing session for the shopper. Use subscribeGroupAssigned for reliable notification of group assignments for new sessions. 

Expect your provider callback to be invoked by Granify at any time when active. No guarantees are made regarding the thread the provider will be invoked on.

Placement:

When in use, this function must be called prior to activateGranify on application launch.

Declaration:

@JvmStatic
fun registerGroupAssignmentProvider(provider: () -> MatchingGroup)

Parameters:

Notifies Contextual Commerce that the child site has changed.

In cases where a client has an app that uses multiple child sites (multiple brands), use this method when the shopper switches from one brand to another.

Placement:

This function should be called as soon as the child site (brand) in the app changes from the child site initially set in configuration, as well as any subsequent changes. If the brand changes because a new page is loaded, call this method immediately after the Granify.trackPageView(...) method, before Granify.trackProduct(...) or any other Granify call.

Declaration:

@JvmStatic
fun setChildSiteId(childSiteId: SiteIdentifier?)

Parameters:

Notifies Contextual Commerce which specific product on a product page is currently selected.

Placement:

This function should be called immediately after trackProduct and when the focused item is changed on a product page. This includes:

• On application launch to a product page (call with the default selected product sku).
• On application resume from background to a product page (call with the selected product sku when the view loads).
• From a navigation action leading to a product page (call with the default selected product sku).
• User action that changes the selected product sku on a product page.

Declaration:

@JvmStatic
fun setCurrentProduct(sku: String, productId: String)

Parameters:

Tells Contextual Commerce to enter/exit a restricted state in which no campaign can be shown to the shopper.

Note: This does not apply to inline campaigns, which will not be hidden while in a restricted state. 

The initial state of the SDK is UNRESTRICTED upon activation.

Placement:

This function should be called:

• When entering a situation whereby a campaign should not be shown (excluding restricted page types).
• When exiting a situation whereby a campaign should not be shown (excluding navigating from restricted page types).

Declaration:

@JvmStatic
fun setRestrictionState(restrictionState: RestrictionState)

Parameters:

Notifies Contextual Commerce of the current customer's unique identifier.

This should be the same identifier you use in your store for your customers. It should not change if the same customer returns. If the shopper cannot be uniquely identified, this function should not be called.

Placement:

This function should be called as soon as the shopper's identifier is known. This may be:

• On application launch.
• After the shopper signs in to their account.

Declaration:

@JvmStatic
fun setShopperId(shopperId: String)

Parameters:

Requests that Contextual Commerce show the specified campaign (or message) within this session.

Once requested, the campaign matching campaignId will be shown at the next available opportunity. As campaigns are designed with various limitations around their presentation (e.g. only showing on a product page), the campaign may not appear immediately after this call is made.

Caution: This method is not intended for regular use and should not be called during regular customer shopping sessions. 

It is a business review tool that grants the ability to see what a given Contextual Commerce campaign will look like within your application. Bazaarvoice strongly recommends creating an easy way for trusted users to trigger this function. This will simplify the previewing and testing of new campaigns as they become available.

The campaignId strings, used to request campaigns, can be obtained through your Account Manager.

Placement:

This function can be called any time after activateGranify has been called.

Declaration:

@JvmStatic
fun showCampaign(campaignId: String)

Parameters:

Registers a callback handler to be notified when the Contextual Commerce SDK has encountered an error it cannot resolve internally.

When the supplied handler is invoked, it indicates that the SDK is transitioning to an error state and will cease any further processing. Refer to the documentation of the provided ErrorType to determine the appropriate action to take. Some errors indicate incorrect API usage and require a code change, whereas others indicate runtime errors that may be handled with logic such as retrying an operation.

Expect your handler to be invoked by Granify at any time after activateGranify has been called. No guarantees are made regarding the thread the handler will be invoked on.

Placement:

This function can be called at any time, but it is most usefully called prior to activateGranify to ensure a handler is registered in advance of any errors occurring.

Declaration:

@JvmStatic
fun subscribeErrorReporting(handler: (ErrorType, String) -> Unit)

Parameters:

Registers a callback handler to be notified when a matching group has been assigned.

In most cases, the handler implementation is expected to send the group assignment information to your analytics system. This allows for tracking messaging eligibility as a metric across all sessions. A Granify (or similar) matching group is eligible to see messages whereas a Baseline (or similar) group is ineligible.

Expect your handler to be invoked by Granify when a new session is started. No guarantees are made regarding the thread the handler will be invoked on.

Placement:

This function can be called at any time, but it is most usefully called prior to activateGranify to ensure a handler is registered in advance of the group assignment taking place.

Usage:

The group that your handler receives when invoked is the exact group that should be reported in your analytics.

Caution: No changes are permitted to be performed on the group when reporting in your analytics. 

Declaration:

@JvmStatic
fun subscribeGroupAssigned(handler: (MatchingGroup) -> Unit)

Parameters:

Registers a callback handler to be notified when a message is (or could have been) shown.

In most cases, this handler implementation is expected to send the display status information to your analytics system. This allows for tracking messages displayed (as determined by the Contextual Commerce engine) as a metric across all sessions.

Expect your handler to be invoked by Granify at any time, when our engine decides to show a message to a shopper. No guarantees are made regarding the thread the handler will be invoked on.

Placement:

This function can be called at any time, but it is most usefully called prior to activateGranify to ensure a handler is registered in advance of any messages being shown.

Declaration:

@JvmStatic
fun subscribeMessageShown(handler: (DisplayStatus) -> Unit)

Parameters:

Notifies Contextual Commerce of the contents of the shopper's cart.

All cart information is required (rather than partial changesets) to sync the customer's cart with Contextual Commerce. Ensuring that this information is kept up to date is crucial to enable cart-related campaigns to work.

Placement:

This function should be called:

• On initial app launch.
• After there is any change made to the cart. This includes:
  • After a purchase is completed (to clear the cart); including through the use of a "Buy It Now" or other express purchase button.
  • The removal of an item.
  • Cart item quantity changes.
  • Updated cart information from a server response (e.g. from shopping performed on the same user account on a different device).

Declaration:

@JvmStatic
fun trackCart(items: Map)

Parameters:

Notifies Contextual Commerce about completed purchases.

Placement:

Call this function after the order has been finalized and paid (for example, when the receipt page is displayed). The data provided to Granify must match the data provided to your analytics.

Declaration:

@JvmStatic
fun trackOrder(details: Order)

Parameters:

Tracks any changes to the active "page" or view that is displayed to the user in the application.

It is important to keep Contextual Commerce notified about the current page and the shopper's navigation through the app so that our engine can make appropriate decisions about what messages should be shown to which shoppers for maximum impact. This includes tracking what the user is currently viewing on the page via the use of scroll distance metrics which are inferred from the main scrollable view for the page.

Placement:

This function should be called:

• On application launch.
• On application resume from background.
• Each time a page navigation occurs.

It is recommended to call trackPageView in the onResume lifecycle callback of an Activity or onResume lifecycle callback of a Fragment. Contextual Commerce requires access to the current FragmentActivity at all times, so calling trackPageView from onResume ensures it is always available even when the activity is recreated due to a configuration change.

Note: Any modifications to the Window.Callback of an activity must be made before a trackPageView call; otherwise,  Contextual Commerce will not be able to capture touch events.

Declaration:

@JvmOverloads
@JvmStatic
fun trackPageView(
pageIdentifier: PageIdentifier,
activity: FragmentActivity,
navigator: Navigator,
safeArea: () -> SliderMargins? = null,
scrollableView: ScrollableView? = null,
pageRestrictionState: RestrictionState = RestrictionState.UNRESTRICTED
)

Parameters:

pageIdentifier	A PageIdentifier object containing the page type of the current page and its path.
activity	The current activity. Contextual Commerce requires the current activity for displaying campaign fragments and for capturing touch data.
navigator	Class implementing Navigator, providing functions to navigate to different pages within the application.
safeArea	A closure that returns SliderMargins where the margins given dictate the area where it is safe to draw a slider. This ensures a slider does not block app functionality such as navigation. If your app has a navbar displayed at the bottom of the activity, a sample SliderMargins to use is SliderMargins(left: 0, top: 0, right: 0, bottom: navBar.height). The closure passed into this method will be invoked on the main thread whenever an orientation change of the device or an activity change occurs to allow the Contextual Commerce widgets to always use an up-to-date safe area for display.
scrollableView	The main ScrollableView on the page. These must be passed through the provided wrapper classes such as ScrollViewWrapper. Note: This parameter is only required for pages that use a views-based UI. For pages using Jetpack Compose, or a similar declarative UI toolkit, it should be left null.
pageRestrictionState	a RestrictionState indicating whether or not the page is eligible to have a slider displayed on it. This parameter is not required, and defaults to UNRESTRICTED.

Tracks any changes to the active "page" or view that is displayed to the user in the application.

It is important to keep Contextual Commerce notified about the current page and the shopper's navigation through the app so that our engine can make appropriate decisions about what messages should be shown to which shoppers for maximum impact. This includes tracking what the user is currently viewing on the page via the use of scroll distance metrics which are inferred from the main scrollable view for the page.

Deprecated:

Do not pass in safeArea as SliderMargins, safeArea should now be passed as a closure that returns SliderMargins.

Replace with:

Granify.trackPageView(
pageIdentifier: PageIdentifier,
activity: FragmentActivity,
navigator: Navigator,
safeArea: (() -> SliderMargins?)? = null,
scrollableView: ScrollableView? = null,
pageRestrictionState: RestrictionState = RestrictionState.UNRESTRICTED)

Placement:

This function should be called:

• On application launch.
• On application resume from background.
• Each time a page navigation occurs.

It is recommended to call trackPageView in the onResume lifecycle callback of an Activity or onResume lifecycle callback of a Fragment. Contextual Commerce requires access to the current FragmentActivity at all times, so calling trackPageView from onResume ensures it is always available even when the activity is recreated due to a configuration change.

Note that any modifications to the Window.Callback of an activity must be made before a trackPageView call; otherwise, Contextual Commerce will not be able to capture touch events.

Declaration:

@JvmStatic
fun trackPageView(
pageIdentifier: PageIdentifier, 
activity: FragmentActivity, 
navigator: Navigator, 
safeArea: SliderMargins? = null, 
scrollableView: ScrollableView? = null, 
pageRestrictionState: RestrictionState = RestrictionState.UNRESTRICTED
)

Parameters:

Notifies Contextual Commerce about the products available on a product page.

Supplied product information is cached in memory and may be used for the display of messages at a later point in time. All product variations (i.e. skus) on a page should be provided. For example, if a shirt has different colors or sizes, the product list provided should include an entry for every combination of shirt color and size.

Placement:

This function should be called after trackPageView when a product page is loaded:

• On application launch to a product page.
• On application resume from background (when resuming to a product page).
• From a navigation action leading to a product page.

Declaration:

@JvmStatic
fun trackProduct(products: List, carter: Carter)

Parameters:

Notifies Contextual Commerce of the contents of the shopper's wish list.

This method can be called multiple times for different lists you wish to track. Please ensure that you use a unique name for each list tracked (e.g. "Saved for Later", "Christmas", etc.) per user.

Placement:

This function should be called:

• On initial app launch.
• After there is any change made to the wish list.
• Upon updating wish list information from a server response (e.g. from shopping performed on the same user account on a different device).

Declaration:

@JvmStatic
fun trackWishList(name: String, contents: List)

Parameters:

Registers a handler that is used to collapse the GranifyInlineView. Expect this handler to be invoked anytime the GranifyInlineView is no longer needed to display. The Contextual Commerce SDK handles animation of the inlines internally.

Caution: Do not add any additional animation handling. 

Declaration:

fun setCollapseHandler(collapseHandler: GranifyInlineViewCollapser)

Registers a handler that is used to expand the GranifyInlineView. Expect this handler to be invoked before an inline campaign is displayed. The GranifyInlineView will expand and the inline campaign will be displayed inside of it. The Contextual Commerce SDK handles animation of the inlines internally.

Caution: Do not add any additional animation handling. 

Declaration:

fun setExpandHandler(expandHandler: GranifyInlineViewExpander)

Installs a label that is used to uniquely identify this GranifyInlineView.

Declaration:

fun setLabel(label: GranifyInlineViewLabel)

Declaration:

constructor(name: String, productId: String? = null, sku: String? = null)

Parameters:

Throws:

The name of this label location. If there are multiple GranifyInlineViewLabel on the page, then this parameter should be unique per-product. (e.g. You can have the name "aboveProduct" in different labels as long as they each have different productId and/or sku fields) 

Declaration:

val name: String

The ID of the associated product. Required when theGranifyInlineView is located on a product page, or on any page where it is associated with a specific product (e.g. inlines associated with a cart product). 

Declaration:

val productId: String? = null

Declaration:

val sku: String? = null

Declaration:

open operator override fun equals(other: Any?): Boolean

Declaration:

@JvmOverloads
constructor(
applicationContext: Context,
siteId: SiteIdentifier,
childSiteId: SiteIdentifier? = null,
codeVersion: String = "unknown"
)

Parameters:

The application context. This will be used to generate a preference file named 'Granify'.

Declaration:

val applicationContext: Context

The 5-character (alpha-numeric, case sensitive) site identifier for the child site. This should be null in most cases. The exceptions are installs with parent and child sites; usually when a shared top-level domain exists across stores.

Declaration:

val childSiteId: SiteIdentifier? = null

The version string of your application code. For example: 1.3.0 is a code version with 1 being the major version number, 3 being the minor, and 0 being the patch number.

Declaration:

val codeVersion: String = "unknown"

The 5-character (alpha-numeric, case sensitive) site identifier provided to you by your account executive.

Declaration:

val siteId: SiteIdentifier

Declaration:

case DISABLED

Declaration:

case DEBUG

Declaration:

case INFO

Declaration:

case CALL

Declaration:

case WARN

Declaration:

case ERROR

Declaration:

case CRITICAL

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Declaration:

fun valueOf(value: String): Level

Parameters:

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants. 

Declaration:

fun values(): Array<Level>

Declaration:

object Companion

Declaration:

val description: String

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Declaration:

val entries: EnumEntries<Level>

Declaration:

val name: String

Declaration:

val ordinal: Int

Not intended for public use; this method is exposed due to technical requirements but is not intended to be used externally. Do not call or otherwise interact with this method.

Declaration:

fun write(log: String, level: Level, source: LogSource)

Declaration:

case ANDROID

Declaration:

case REACT_NATIVE_ANDROID_MODULE

Declaration:

case REACT_NATIVE_TS_API

Declaration:

val tag: String

Declaration:

val value: Int

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Declaration:

fun valueOf(value: String): LogSource

Parameters:

Returns an array containing the constants of this enum type, in the order they're declared.

Declaration:

fun values(): Array<LogSource>

Adds the current product to the cart.

When invoked, the current product should be added to the cart or some indication should occur to notify the shopper of any selections that must first be made before the item can be added to the cart.

Caution: trackCart must be called with the updated cart after the current product is added. 

Declaration:

abstract fun addCurrentProductToCart()

United States Dollar.

Declaration:

case USD

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Declaration:

val entries: EnumEntries<Currency>

Declaration:

val name: String

Declaration:

val ordinal: Int

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Declaration:

fun valueOf(value: String): Currency

Parameters:

Returns an array containing the constants of this enum type, in the order they're declared.

Declaration:

fun values(): Array<Currency>

Creates a DiscountCode instance.

Declaration:

constructor(code: String, amount: Price)

Parameters:

The discounted amount.

Declaration:

val amount: Price

The discount code string.

Declaration:

val code: String

Indicates that the message was shown to the shopper.

Declaration:

case SHOWN

Indicates that the message was not shown to the shopper.

Declaration:

case NOT_SHOWN

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Declaration:

val entries: EnumEntries<DisplayStatus>

Declaration:

val name: String

Declaration:

val ordinal: Int

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Declaration:

fun valueOf(value: String): DisplayStatus

Parameters:

Returns an array containing the constants of this enum type, in the order they're declared.

Declaration:

fun values(): Array<DisplayStatus>

Reported when attempting to initialize the SDK more than once with activateGranify.

A code change is required in the host application to fix errors of this type.

Declaration:

case SDK_ALREADY_ACTIVATED

Reported when incorrectly using a method that requires activateGranify to first be called. Refer to method documentation in the Granify class to determine which methods require an activated SDK.

A code change is required in the host application to fix errors of this type.

Declaration:

case SDK_NOT_ACTIVATED

Reported when the SDK reaches a failure state. A failure state occurs when an unchecked error occurs in the SDK or when processing cannot be performed in soft real-time.

Declaration:

case SDK_SHUTDOWN

Reported when loading the application's configuration from the server failed. The configuration is loaded while processing a call to activateGranify.

This can be a transient error due to a network failure, so retrying Granify activation is allowed after a short delay.

Declaration:

case CONFIGURATION_LOAD_FAILED

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Declaration:

val entries: EnumEntries<ErrorType>

Declaration:

val name: String

Declaration:

val ordinal: Int

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Declaration:

fun valueOf(value: String): ErrorType

Parameters:

Returns an array containing the constants of this enum type, in the order they're declared.

Declaration:

fun values(): Array<ErrorType>

Baseline group that will not be shown any message that the engine may match.

This uses the default (baseline) single-match engine.

Declaration:

case BASELINE

Active group that will be shown any single message that the engine may match.

This uses the default single-match engine.

Declaration:

case GRANIFY

Granify group 'B' used for A/B tests between two default groups on a site (alongside the GRANIFY group).

This uses the default single-match engine.

Declaration:

case GRANIFY_B

Baseline group 'B' used for A/B tests between two default groups on a site (alongside the BASELINE group).

This uses the default (baseline) single-match engine.

Declaration:

case BASELINE_B

Active group that will be shown any messages the engine may match.

This uses the multi-match engine, utilizing the single-match engine but with a second layer running in tandem to allow for multi-match configured campaigns to show whenever they are matched.

Declaration:

case GRANIFY_MULTI_MATCH

Baseline group that will not be shown any messages that the engine may match.

This uses the (baseline) multi-match engine, utilizing the single-match engine but with a second layer running in tandem to allow for multi-match configured campaigns to match at will.

Declaration:

case BASELINE_MULTI_MATCH

Granify multi-match group 'B' used for A/B tests between two multi-match groups on a site (alongside the GRANIFY_MULTI_MATCH group).

This uses the multi-match engine.

Declaration:

case GRANIFY_MULTI_MATCH_B

Baseline multi-match group 'B' used for A/B tests between two multi-match groups on a site (alongside the BASELINE_MULTI_MATCH group).

This uses the (baseline) multi-match engine.

Declaration:

case BASELINE_MULTI_MATCH_B

Active Granify platform group that will be shown any messages that the engine may match.

This uses the Granify platform engine, allowing multiple child engines to be configured per tool pair.

Declaration:

case GRANIFY_PLATFORM

Baseline Granify platform group that will not be shown any messages that the engine may match.

This uses the Contextual Commerce platform engine, allowing multiple child engines to be configured per tool pair. This matching group functions as a top-level holdout, so messages are not displayed even for eligible tool pairs.

Declaration:

case HOLDOUT_PLATFORM

Used to explicitly identify legacy traffic configured in rules to only match to 1-pixel test only during an active period. Group or matching pair can be used to filter paused traffic in reporting for billing and performance purposes.

Declaration:

case PAUSED_GRANIFY

Used to explicitly identify legacy traffic configured in rules to only match to 1-pixel test only during an active period. Group or matching pair can be used to filter paused traffic in reporting for billing and performance purposes.

Declaration:

case PAUSED_BASELINE

A predictions first matching engine which allows ongoing predictions.

Declaration:

case PREDICTIONS_FIRST_GRANIFY

A predictions first matching engine which allows ongoing predictions.

Declaration:

case PREDICTIONS_FIRST_BASELINE

The same as GRANIFY_MULTI_MATCH but using an updated MultiMatch Engine.

Declaration:

case GRANIFY_MULTI_MATCH_V1

The same as BASELINE_MULTI_MATCH but using an updated MultiMatch Engine.

Declaration:

case BASELINE_MULTI_MATCH_V1

This uses the updated multi-match engine, utilizing the predictions first single-match engine but with a second layer running in tandem to allow for multi-match configured campaigns to show whenever they are matched.

Declaration:

case GRANIFY_MULTI_MATCH_V2

This uses the (baseline) updated multi-match engine, utilizing the predictions first single-match engine but with a second layer running in tandem to allow for multi-match configured campaigns to match at will.

Declaration:

case BASELINE_MULTI_MATCH_V2

This uses the EVMax V0.1 engine.

Declaration:

case GRANIFY_EVMAX_V01

This uses the (baseline) EVMax V0.1 engine.

Declaration:

case BASELINE_EVMAX_V01

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Declaration:

val entries: EnumEntries<MatchingGroup>

Declaration:

val name: String

Declaration:

val ordinal: Int

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Declaration:

fun valueOf(value: String): MatchingGroup

Parameters:

Returns an array containing the constants of this enum type, in the order they're declared.

Declaration:

fun values(): Array<MatchingGroup>

Navigates from the current page to the cart.

Declaration:

abstract fun navigateToCart()

Navigates from the current page to a product page.

Declaration:

abstract fun navigateToProduct(productId: String, sku: String?)

Parameters:

Creates an Order instance with all the required order details.

Declaration:

@JvmOverloads
constructor(
orderNumber: String,
lineItemsTotal: Price,
subtotal: Price,
totalTax: Price,
totalShipping: Price,
total: Price,
lineItems: HashMap<Product, Int>,
discountCodes: List<DiscountCode>,
financialStatus: String = defaultFinancialStatus,
currency: Currency = Currency.USD
)

Parameters:

The local currency used for prices.

Declaration:

val currency: Currency

A list of discounts applied to this order.

Declaration:

val discountCodes: List<DiscountCode>

The payment status of the order.

Declaration:

val financialStatus: String

The products in the order and their corresponding ordered quantities.

Declaration:

val lineItems: HashMap<Product, Int>

The total value of all items in the cart before any discounts, taxes, and shipping, but after sale pricing.

Declaration:

val lineItemsTotal: Price

The unique identifier for this order.

Declaration:

val orderNumber: String

The total value of the items in the order after discounts but before shipping or taxes.

Declaration:

val subtotal: Price

The total value of the order (after discounts) including shipping and taxes.

Declaration:

val total: Price

The total value of any shipping costs applied to this order.

Declaration:

val totalShipping: Price

The total value of any taxes applied to this order.

Declaration:

val totalTax: Price

Declaration:

constructor(pageType: PageType, path: String)

Parameters:

Declaration:

val pageType: PageType

Declaration:

val path: String

Declaration:

open override fun toString(): String

Declaration:

@JvmOverloads
constructor(amount: Double, currency: Currency = Currency.USD)

Parameters:

The magnitude of the price.

Declaration:

val amount: Double

The currency associated with the amount.

Declaration:

val currency: Currency

Returns a string representation of the price.

Declaration:

open override fun toString(): String

The home page for the application.

Declaration:

case HOME

A page listing a single product (sometimes with multiple sku variations).

Declaration:

case PRODUCT

A page containing a collection of products. Often, this is a page listing some category of products.

Declaration:

case COLLECTION

A page containing search results.

Declaration:

case SEARCH

A page containing supporting blog content or articles.

Declaration:

case BLOG

The cart page for a store, listing the user's current cart contents, and often the entry point for a checkout.

Declaration:

case CART

The checkout page allowing a user to complete the checkout process.

Declaration:

case CHECKOUT

Pages containing listings of flight options (intended for use by flight-booking applications).

Declaration:

case FLIGHTS

Pages relating to the shopper's account.

Declaration:

case ACCOUNT

The shopper login page.

Declaration:

case LOGIN

Informational pages about the application (e.g. an "About" page).

Declaration:

case INFO

Pages containing guidance information for shoppers.

Declaration:

case GUIDE

Video content pages on the application.

Declaration:

case VIDEO

All pages that do not fit into any of the other page types categories should be classified as OTHER.

Declaration:

case OTHER

The receipt page shown after completing the checkout process.

Declaration:

case RECEIPT

A page containing the customer's list of personally archived items.

Declaration:

case WISHLIST

The canonical string representation for the page type.

Declaration:

val description: String

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Declaration:

val entries: EnumEntries<PageType>

Declaration:

val name: String

Declaration:

val ordinal: Int

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Declaration:

fun valueOf(value: String): PageType

Parameters:

Returns an array containing the constants of this enum type, in the order they're declared.

Declaration:

fun values(): Array<PageType>

Declaration:

constructor(
sku: String,
productId: String,
title: String,
price: Price,
regularPrice: Price,
image: URL? = null,
stock: ProductStock? = null,
reviews: ProductReviews? = null,
category: String? = null,
subCategory: String? = null,
color: String? = null,
size: String? = null,
childSiteOwnerId: SiteIdentifier? = null,
customProperties: Map<String, StringOrInt> = mapOf()
)

Parameters:

The broad category containing this item (optional).

Declaration:

val category: String? = null

The site id of the child site this product belongs to. Leave this null unless your configuration uses child sites, in which case this value is required (optional).

Declaration:

val childSiteOwnerId: SiteIdentifier? = null

The color of the SKU item (optional).

Declaration:

val color: String? = null

Named (keys) custom properties (values with a valid string or integer representation) to be stored and reported to Contextual Commerce with the product. This is useful for adding additional properties that may be domain-specific to your site and do not fit into any of the existing properties available on this class.

Declaration:

val customProperties: Map<String, StringOrInt>

The address of the product image. If supplied, must use HTTPS. (optional).

Declaration:

val image: URL? = null

The current unit price of the product (after discount or sale pricing).

Declaration:

val price: Price

The parent ID of the product.

Declaration:

val productId: String

The regular price of the product before sales or discounts.

Declaration:

val regularPrice: Price

The review and rating information for the product (optional).

Declaration:

val reviews: ProductReviews? = null

The size of the SKU item (optional).

Declaration:

val size: String? = null

The specific SKU of the product/variant.

Declaration:

val sku: String

The stock information for the product (optional).

Declaration:

val stock: ProductStock? = null

Further categorical identification for the item (optional).

Declaration:

val subCategory: String? = null

The name or title of the product.

Declaration:

val title: String

Creates a ProductStock instance.

Declaration:

constructor(count: Int)

Parameters:

The amount of product in stock.

Declaration:

val count: Int

Queries whether the product is currently in stock.

Return:

Declaration:

fun inStock(): Boolean

Declaration:

constructor(rating: Double?, ratingScale: Range<Double>?, reviewCount: UInt?)

Throws:

Parameters:

The product rating.

Declaration:

val rating: Double?

The allowable rating range.

Declaration:

val ratingScale: Range<Double>?

The number of reviews.

Declaration:

val reviewCount: UInt?

Declaration:

open override fun toString(): String

Indicates that Granify is restricted from showing campaigns.

Declaration:

case RESTRICTED

Indicates that Granify is allowed to show campaigns.

Declaration:

case UNRESTRICTED

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Declaration:

val entries: EnumEntries<RestrictionState>

Declaration:

val name: String

Declaration:

val ordinal: Int

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Declaration:

fun valueOf(value: String): RestrictionState

Parameters:

Returns an array containing the constants of this enum type, in the order they're declared.

Declaration:

fun values(): Array<RestrictionState>

Wrapper for a ScrollView.

Declaration:

class ScrollViewWrapper(scrollView: ScrollView) : ScrollableView

Properties:

Initializes a WishListItem instance.

Declaration:

abstract class ScrollableView 


@JvmOverloads


constructor(product: Product, dateAdded: Date? = null, priceWhenAdded: Price? = null)​

constructor(
productId: String,
inStock: Boolean,
sku: String? = null,
price: Price? = null,
regularPrice: Price? = null,
title: String? = null,
image: URL? = null,
dateAdded: Date? = null,
priceWhenAdded: Price? = null
)

Parameters:

The date the item was added to the wish list (optional).

Declaration:

val dateAdded: Date? = null

The address of the product image (optional).

Declaration:

val image: URL? = null

Whether the item is currently in stock.

Declaration:

val inStock: Boolean

The current unit price of the product after discount or sale pricing (optional).

Declaration:

val price: Price? = null

The price of the product when it was added to the wish list (optional).

Declaration:

val priceWhenAdded: Price? = null

The parent ID of the product.

Declaration:

val productId: String

The regular price of the product before sales or discounts (optional).

Declaration:

val regularPrice: Price? = null

The specific SKU of the product/variant (optional).

Declaration:

val sku: String? = null

The name or title of the product (optional).

Declaration:

val title: String? = null

A wrapper around an Int.

Declaration:

class IntWrapper(val int: Int) : StringOrInt

A wrapper around a String.

Declaration:

class StringWrapper(val string: String) : StringOrInt

Creates a SliderMargins instance.

Declaration:

constructor(top: Int, bottom: Int, right: Int, left: Int)

constructor(parcel: Parcel) 

Parameters:

Distance in pixels from the bottom of the screen that a slider should not occupy.

Declaration:

val bottom: Int

Distance in pixels from the left side of the screen that a slider should not occupy.

Declaration:

val left: Int

Distance in pixels from the right side of the screen that a slider should not occupy.

Declaration:

val right: Int

Distance in pixels from the top of the screen that a slider should not occupy.

Declaration:

val top: Int

Declaration:

constructor(identifier: String)

Throws:

Declaration:

open override fun toString(): String