Classes

A label that defines identifying information for this view.

Declaration:

@objc
dynamic public var label: GranifyInlineViewLabel? { get set }

Initialization function used when this object is created programmatically, rather than by a storyboard.

Declaration:

public init(
label: GranifyInlineViewLabel,
expandHandler: @escaping GranifyInlineViewExpander,
collapseHandler: @escaping GranifyInlineViewCollapser
)

Initialization function used when this object is created by a storyboard. When using this initializer, setExpandHandler, setCollapseHandler, and setLabel must be called later.

Declaration:

required public init?(coder: NSCoder)

Registers a handler that is used to expand the GranifyInlineView. Expect this handler to be invoked before an inline campaign is displayed. TheGranifyInlineViewwill 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.

Refer to the Implement inline campaigns topic for details on setting up your GranifyInlineView.

Declaration:

public func setExpandHandler(expandHandler: @escaping GranifyInlineViewExpander)

Parameters:

Registers a handler that is used to collapse the GranifyInlineView so it is no longer visible. 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 notadd any additional animation handling.

Declaration:

public func setCollapseHandler(collapseHandler: @escaping GranifyInlineViewCollapser)

Parameters:

Attaches a GranifyInlineViewLabel, used by the Contextual Commerce SDK for GranifyInlineView identification. Whenever the contents of the superview of a GranifyInlineView are changed such that its GranifyInlineViewLabel is no longer reflective of the superview’s contents (e.g. new product id, sku), this should be called to update the GranifyInlineView‘s GranifyInlineViewLabel.

Declaration:

public func setLabel(label: GranifyInlineViewLabel)

Parameters:

Unlinks the view from its superview and its window, and removes it from the responder chain. This method is called automatically, and should not be called directly.

Declaration:

public override func removeFromSuperview()

Tells the view that its window object changed. This method is called automatically, and should not be called directly.

Declaration:

public override func didMoveToWindow()

Unique string identifier for the associated GranifyInlineView.

Declaration:

public let name: String

The ID of the associated product. Required when the associated GranifyInlineView is unique to a specific product. For example, any GranifyInlineView on a product page must have the productId included in the label.

Declaration:

public let productId: String?

The SKU of the associated product. Required only when the associated GranifyInlineView is unique to a specific productID/SKU combination.

Declaration:

public let sku: String?

Initialization function.

Declaration:

@objc
public init(name: String, productId: String? = nil, sku: String? = nil)

Parameters:

Returns a Boolean value that indicates whether the receiver and a given object are equal.

Declaration:

override public func isEqual(_ object: Any?) -> Bool

Parameters:

Evaluates if a [String: String] hash matches the label.

Declaration:

public func matchesHash(hash: [String : String]) -> Bool

Parameters:

Activates the Contextual Commerce SDK and initiates communication with Contextual Commerce servers. This function must be called on app launch before any other method on this API (excepting subscription and registration methods) to allow the SDK to intialize itself with the provided site information.

See the Activate SDK article for details on how to prepare the GranifyConfigurationobject.

When to call:

Call this method once when the app starts, before it renders the first page. Register all providers and subscribe to all events before you call this method.

Declaration:

@objc
public class func activateGranify(with config: GranifyConfiguration) throws

Parameters:

Registers a callback to notify you when a matching group has been assigned.

In most cases, this handler is expected to send the group assignment information to your analytics. This group assignment metric tracks whether the current shopper is eligible to be shown a message (“Granify” group), or not (“baseline” group). Expect your handler to be invoked by Granify on startup, and when a new session is started (eg: after a lengthy period of inactivity).

Placement:

Call this function once, immediately before activateGranify(...), to register a handler before group assignment.

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 on the group when reporting in your analytics.

Declaration:

@objc
public class func subscribeGroupAssigned(handler: @escaping (MatchingGroup) -> Void)

Parameters:

Registers a callback to notify you when a message is (or could have been) shown.

In most cases, this handler is expected to send the display status information to your analytics. The message shown metric tracks when our engine decides to show a message to a shopper. Messages may beshownornotShowndepending on the shopper’s group assignment (granifyvs.baseline, respectively).

Expect your handler to be invoked by Granify at any time, when our engine decides to show a message to a shopper.

Your handler will be invoked on the main process thread.

Placement:

Call this method once, immediately before activateGranify(...), to register a handler before messages appear.

Declaration:

@objc
public class func subscribeMessageShown(handler: @escaping (DisplayStatus) -> Void)

Parameters:

Register a handler for providing 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 handler instead. Allowed 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 handler 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 (starting traffic to the server) and at arbitrary later points when starting a new session after expiry.

Note that 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 handler) even though the server can recover the existing session for the shopper. UsesubscribeGroupAssigned(...)for reliable notifications of group assignments for new sessions.

Caution: No guarantees are made about which thread may invoke your provider callback. The main process thread or a different worker thread may be used.

When in use, this function must be called prior toactivateGranify(...)on application launch.

Declaration:

@objc
public class func registerGroupAssignment(provider: @escaping () -> MatchingGroup) throws

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.

Do not use email addresses for shopper IDs.

Placement:

Declaration:

@objc
public class func setShopperId(shopperId: String) throws

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:

@objc
public class func clearShopperId() throws

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 theGranify.trackPageView(...)method, beforeGranify.trackProduct(...)or any other Granify call.

Declaration:

@objc
public class func setChildSiteId(childSiteId: SiteIdentifier?) throws

Parameters:

Declaration:

@available(*, deprecated, message: "Use: trackPageView(pageIdentifier: PageIdentifier, mainScrollView: UIScrollView?, getInsets: (﹚ -> UIEdgeInsets﹚")
@objc
public class func trackPageView(pageType: PageType, parentView: UIView? = nil, mainScrollView: UIScrollView? = nil, getInsets: @escaping () -> UIEdgeInsets) throws

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 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. In UIKit, these metrics are inferred from the main UIScrollView for the page; however, in SwiftUI these scroll metrics are tracked differently.

See Track page views for more information. 

Placement:

Call this method whenever a page opens (including the first page) and when the app resumes, to ensure the session remains active. Call this method:

• On application launch
• On application resume from background
• Each time a page navigation occurs (inside theviewDidAppear()View Controller callback)

Declaration:

@objc
public class func trackPageView(pageIdentifier: PageIdentifier, parentView: UIView? = nil, mainScrollView: UIScrollView? = nil, getInsets: @escaping () -> UIEdgeInsets) throws

Parameters:

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

Declaration:

@objc
public class func trackProduct(products: [Product], currentProductCarterCallback: @escaping CurrentProductCarterCallback) throws

Parameters:

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

See Track Product for more details.

Placement:

This function must be called immediately aftertrackProduct(...), 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:

@objc
public class func setCurrentProduct(sku: String, productId: String) throws

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 is kept up to date is crucial to ensure cart-related campaigns work.

See Track Product for more details.

Placement:

Call trackCart immediately after activateGranify when the app starts. Call trackCart again whenever the app resumes or the cart changes. Common triggers include:

• 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
  • Item removal
  • 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:

@objc
public class func trackCart(items: [Product : Int]) throws

Parameters:

Notifies Contextual Commerce that an item has been added to the cart, or that the quantity of an item already in the cart has been increased.

This method requires only information about the change itself. It does not require the complete cart details.

See Track Product for more details.

Placement:

Call trackCartChange immediately when a change occurs in the cart. Do not call this method on app launch. Call this method when:

• A new item is added

• An item is removed

• An item's quantity changes

Note: This method should never be called in the same session withtrackCart. The two methods are intended for mutually exclusive circumstances; you should never need to call both in the same app.

Declaration:

@objc
public class func trackCartChange(add product: Product, quantity: Int) throws

Parameters:

Notifies Contextual Commerce that an item has been removed from the cart, or that the quantity of an item already in the cart has been decreased.

This method requires only information about the change itself. It does not require the complete cart details.

See Track Product for more details.

Placement:

Call trackCartChange immediately when a change occurs in the cart. Do not call this method on app launch. Call this method when:

• A new item is added

• An item is removed

• An item's quantity changes

Note:This method should never be called in the same session withtrackCart. The two methods are intended for mutually exclusive circumstances; you should never need to call both in the same app.

Declaration:

@objc
public class func trackCartChange(remove sku: String, quantity: Int) throws

Parameters:

Notifies Contextual Commerce about completed purchases.

Placement:

Call this method only after an order is finalized and paid (for example, on the receipt page). Do not call this method when the checkout process starts. Ensure the data provided to Contextual Commerce matches your analytics data.

Declaration:

@objc
public class func trackOrder(details: Order) throws

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 (for example, “Saved for Later”or “Christmas”) per user.

Placement:

Call trackWishList immediately after activateGranify. Call this method once for each wish list the user has. If wish list data is unavailable (for example, before sign-in), call the method with an empty list.

Call trackWishList again with updated contents whenever:

• The shopper signs in

• Items are added, removed, or modified

• A list is added or deleted (for deletions, send the list name with empty contents)

• The app resumes (to sync changes from other devices)

• Updated wish list information from a server response (e.g. from shopping performed on the same user account on a different device)

Declaration:

@objc
public class func trackWishList(name: String, contents: [WishListItem]) throws

Parameters:

Notifies Contextual Commerce of any information you want to remember and persist for any user of the device on which it is running. It will persist across pages within the current user session.

Placement:

Call this method whenever the information about the user you’d like to store has changed.

Declaration:

@objc
public class func trackUserData(userData: String) throws

Parameters:

let exampleUserData = """ {\ \"example_string\": \"Example String\",\ \"example_bool\": true,\ \"example_int\": 1,\ \"example_string_array\":[\"example_1\",\"example_2\"],\ \"example_bool_array\":[true,false],\ \"example_int_array\":[1,2,3,4]\ }\ """ try Granify.trackUserData(userData: exampleUserData)

Requests that Contextual Commerce show a specified concept (which we now call a campaign) within this session.

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

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 allows seeing what a given Granify campaign will look like within your application so that any desired changes can be requested of the Bazaarvoice team. Bazaarvoice strongly recommends creating an easy way for trusted users to trigger this function to simplify previewing and testing of new concepts as they become available.

The id strings used to request concepts, can be obtained through your Account Manager.

Refer to Show campaigns for more details.

Placement:

This function can be called:

• Any time afteractivateGranify(...)has been called

Declaration:

@objc
public class func showConcept(conceptId: String) throws

Parameters:

Tells Contextual Commerce to enter/exit a restricted state, during which no campaign can appear to the shopper. Note that this does not apply to inline campaigns, which willnotbe hidden while in a restricted state.

If your app has other popups, modals, or there are any times when you do not want a campaign to pop up, you can set the restricted state. When this state is on (.restricted), no campaigns will be shown. Switch it off to resume normal programming.

For example, if you have a promotional message that pops up when a shopper logs in, you might set the restricted state on while that popup is open, and then set if off again once the popup has been removed.

Please remember to always switch the restricted state off when you no longer require it.

The initial state of the SDK is RestrictionState.unrestricted upon activation.

Placement:

This function should be called:

• when entering a situation where a campaign should not be shown
• when exiting a situation where a campaign should not be shown

Declaration:

@objc
public class func setRestrictionState(to restrictionState: RestrictionState) throws

Parameters:

Generates an executable JavaScript script that will pass the current Contextual Commerce state to an embedded webview that is running a page that uses the Granify JavaScript SDK.

If your app is a hybrid app, such that some of the app runs natively, and other parts run as web pages in webviews, it is necessary for Contextual Commerce to pass state from the app to the webview whenever the app passes control from the app to the webview.

In such a case, call this method to receive a JavaScript snippet that will pass the current app state into the JavaScript Contextual Commerce SDK running in the webview. This script should be executed before the JavaScript Contextual Commerce SDK makes its first request to the Contextual Commerce backend servers (which happens pretty soon after load). It is safe to load this script before the JavaScript Contextual Commerce SDK has loaded. We recommend passing the script as soon as the webview finishes loading.

The internal state of the App Contextual Commerce SDK changes with every product viewed, and the JavaScript Contextual Commerce SDK needs the most up-to-date state to operate optimally. This means that the state must be passed again every time a new page loads into the webview - once for each time the JavaScript SDK loads.

Note: We do not currently support passing state from the webview to the app. We can only support one-way transitions. This is appropriate if the app hosts its cart and checkout in a webview, but everything else in the app.

Placement:

This function should be called:

• when passing control from the app to a webview
• must be called each time a new page loads inside the webview.

Declaration:

@objc
public class func getCurrentState() throws -> String

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:

@objc
public class func overrideGranifyInlineView(label: String) throws

Parameters:

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:

public static func write(message: String, logLevel: LogLevel, source: LogSource)

A closure that accepts a set of parameters, and performs a navigation to the page of the relevant type. A different set of parameters will be passed for each page type, depending on what is most appropriate for that page type. Most page types will receive an empty set of parameters, but.productpages, for example, will receive two parameters:productIdandsku. Note that the closure should not return aURL- it is the responsibility of the closure to perform the navigation itself.

Declaration:

public typealias DeepLinkFactory = ([String : String]) -> Void

The page type you are wanting to deep link to.

Declaration:

@objc
public let pageType: PageType

The URL used to deep link. eg com.mycompany.MyApp://cart.

Declaration:

@objc
public let link: URL?

A closure that performs the deep link. Accepts a collection of parameters, and allows the caller to decide exactly how the navigation should occur.

Declaration:

@objc
public let linkFactory: DeepLinkFactory?

Retrieves String representation of DeepLink.

Declaration:

public override var description: String { get }

Creates a DeepLink instance. Must pass either link or linkFactory. If both are passed, the factory will take precedence.

Declaration:

@objc
public init(pageType: PageType, link: URL? = nil, linkFactory: DeepLinkFactory? = nil)

Parameters:

The discount code string. Typically this is some coupon or promo code string entered by the user to apply the discount to the order.

Declaration:

@objc
public let code: String

The discounted amount.

Declaration:

@objc
public let amount: Price

Creates a DiscountCode instance.

Declaration:

@objc
public init(code: String, amount: Price)

Parameters:

A block to build a deep link URL directly to a product or sku. The block takes two arguments:

1. The id of product item to link to
2. Optionally, the specific sku, of that product, to link directly to, if applicable/possible

Caution: No guarantees are made about which thread may invoke your provided callback. The main process thread or a different worker thread may be used.

Declaration:

public typealias ProductLinkBuilderCallback = (String, String?) -> URL?

Creates a GranifyConfiguration instance.

Declaration:

@objc
public init(forSite siteId: SiteIdentifier,
childSiteId: SiteIdentifier? = nil,
codeVersion: String? = nil,
deepLinks: [DeepLink] = [])

Parameters:

Creates a GranifyConfiguration instance.

Declaration:

@available(*, deprecated, message: "Do not pass a productLinkBuilder; provide a DeepLink with a linkFactory instead.")
@objc
public convenience init(forSite siteId: SiteIdentifier,
childSiteId: SiteIdentifier? = nil,
codeVersion: String? = nil,
deepLinks: [DeepLink] = [],
productLinkBuilder: ProductLinkBuilderCallback? = nil)

Parameters:

Retrieves String representation of GranifyConfiguration.

Declaration:

public override var description: String { get }

The unique identifier for this order.

Declaration:

@objc
public let orderNumber: String

The local currency used for prices. Must be “USD”, unless another currency has been agreed upon by Bazaarvoice. 

Declaration:

@objc
public let currency: Currency

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

Declaration:

@objc
public let lineItemsTotal: Price

The total value of the items in the order after discounts but before shipping or taxes. This should match the order total you use in your own analytics.

Declaration:

@objc
public let subtotal: Price

The total value of any taxes applied to this order.

Declaration:

@objc
public let totalTax: Price

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

Declaration:

@objc
public let totalShipping: Price

The total price (after discounts) including shipping and possibly taxes.

Declaration:

@objc
public let total: Price

The products in the order and their corresponding ordered quantities.

Declaration:

@objc
public let lineItems: [Product : Int]

The total number of items in the order.

Declaration:

@objc
public var itemCount: Int { get }

A list of discounts applied to this order. If no discounts are applicable, this should be an empty array.

Declaration:

@objc
public let discountCodes: [DiscountCode]

The payment status of the order. This should always be "paid" unless you want to send information about fraud or cancelled orders.

Declaration:

@objc
public let financialStatus: String

The default financial status value for an order.

Declaration:

@objc
public static let defaultFinancialStatus: String

Creates an Order instance with all the required order details.

Declaration:

@available(*, deprecated, message: "Do not pass financialStatus, it is now defaulted to 'paid'.")
@objc
public init(orderNumber: String,
currency: Currency = Currency.usd,
lineItemsTotal: Price,
subtotal: Price,
totalTax: Price,
totalShipping: Price,
total: Price,
lineItems: [Product: Int],
discountCodes: [DiscountCode],
financialStatus: String = defaultFinancialStatus)

Parameters:

Creates an Order instance with all the required order details.

Declaration:

@objc
public init(orderNumber: String,
currency: Currency = Currency.usd,
lineItemsTotal: Price,
subtotal: Price,
totalTax: Price,
totalShipping: Price,
total: Price,
lineItems: [Product: Int],
discountCodes: [DiscountCode])

Parameters:

The PageType of the current page.

Declaration:

@objc
public let pageType: PageType

The unique path for the page.

Declaration:

@objc
public var path: String

Returns an integer that can be used as a table address in a hash table structure.

Declaration:

public override var hash: Int { get }

A textual representation of the receiver.

Declaration:

public override var description: String { get }

Initializer.

Declaration:

@objc
public init(pageType: PageType, path: String = "")

Parameters:

Formats the pageIdentifier in a URL-like string.

Declaration:

@objc
public func getIdentifyingURL() -> String

Sets the value of path, only if it has not previously been set.

Declaration:

public func updatePathIfEmpty(path: String)

Parameters:

Returns a Boolean value that indicates whether the receiver and a given object are equal.

Declaration:

public override func isEqual(_ object: Any?) -> Bool

Parameters:

The magnitude of the price to two decimal places.

Declaration:

@objc
public var amount: Decimal { get }

Override for Hashable protocol implementation to hash based on numeric value.

Declaration:

public override var hash: Int { get }

Retrieves String representation of Price.

Declaration:

public override var description: String { get }

Creates a Price instance. Returns nil if the provided amount cannot be represented (such as if it is negative).

Declaration:

@objc
public init?(amount: Decimal)

Parameters:

Returns a Boolean value that indicates whether the receiver and a given object are equal. Equality for Price objects is assessed by comparing its numeric components.

Declaration:

public override func isEqual(_ object: Any?) -> Bool

Parameters:

Encodes an instance of Price.

Declaration:

public func encode(to encoder: Encoder) throws

Retrieves String representation of PrimitiveWrapper.

Declaration:

override public var description: String { get }

Creates a PrimitiveWrapper instance holding a String value.

Declaration:

@objc
public init(stringValue: String)

Parameters:

Creates a PrimitiveWrapper instance holding an Int value.

Declaration:

@objc
public init(intValue: Int)

Parameters:

Creates a PrimitiveWrapper instance holding a Bool value.

Declaration:

@objc
public init(boolValue: Bool)

Parameters:

Creates a PrimitiveWrapper instance holding a Decimal value.

Declaration:

@objc
public init(decimalValue: Decimal)

Parameters:

Encodes an instance of PrimitiveWrapper.

Declaration:

public func encode(to encoder: Encoder) throws

The specific SKU of the product/variant.

Declaration:

@objc
public let sku: String

The parent ID of the product.

Declaration:

@objc
public let productId: String

The name or title of the product.

Declaration:

@objc
public let title: String

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

Declaration:

@objc
public let price: Price

The regular price of the product before sales or discounts.

Declaration:

@objc
public let regularPrice: Price

The address of the product image.

Declaration:

@objc
public let image: URL

Deep link to app location.

Declaration:

@objc
public let url: URL

The stock information for the product.

Declaration:

@objc
public let stock: ProductStock?

The review and rating information for the product.

Declaration:

@objc
public let reviews: ProductReviews?

The broad category containing this item.

Declaration:

@objc
public let category: String?

Further categorical identification of item (optional).

Declaration:

@objc
public let subCategory: String?

The color of the SKU item (optional).

Declaration:

@objc
public let color: String?

The size of the SKU item (optional).

Declaration:

@objc
public let size: String?

Named (keys) custom properties (values with a valid string 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:

@objc
public let customProperties: [String : PrimitiveWrapper]

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

Declaration:

@objc
public let childSiteOwnerId: SiteIdentifier?

Override for Hashable protocol implementation to make Productsrely only on the unique sku identifier.

Declaration:

override public var hash: Int { get }

Retrieves String representation of Product.

Declaration:

override public var description: String { get }

Creates a Product instance.

Declaration:

@objc
public init(sku: String,
productId: String,
title: String,
price: Price,
regularPrice: Price,
image: URL,
url: URL,
stock: ProductStock? = nil,
reviews: ProductReviews? = nil,
category: String? = nil,
subCategory: String? = nil,
color: String? = nil,
size: String? = nil,
childSiteOwnerId: SiteIdentifier? = nil,
customProperties: [String: PrimitiveWrapper] = [:])

Parameters:

Returns a new instance that’s a copy of the receiver.

Required for conforming to NSCopying, which is required for using Product as an NSDictionary key when using Contextual Commerce from Objective-C.

Declaration:

public func copy(with zone: NSZone? = nil) -> Any

Parameters:

Return value:

New copiedProductinstance

Returns a Boolean value that indicates whether the receiver and a given object are equal. Equality for Product objects is assessed by comparing only the unique sku identifiers.

Declaration:

override public func isEqual(_ object: Any?) -> Bool

Parameters:

Return value:

trueif the receiver andobjectare equal, otherwisefalse

The product rating rounded to two decimal places.

Declaration:

public var rating: Decimal? { get }

The allowable rating range.

Declaration:

public let ratingScale: ClosedRange?

The number of reviews.

Declaration:

public let reviewCount: UInt?

Retrieves String representation of ProductReviews.

Declaration:

public override var description: String { get }

Creates a ProductReviews instance. Returns nil if all parameters are nil or if rating is out of range for the provided ratingScale.

Declaration:

public init?(rating: Double?,
ratingScale: ClosedRange?,
reviewCount: UInt?)

Parameters:

Creates a StarRatedProductReviews instance. Returns nil if stars is not between 1 and 5 (inclusive).

Declaration:

public init?(stars: Double?, reviewCount: UInt?)

Parameters:

Creates a PercentRatedProductReviews instance. Returns nil if percentage is not between 0 and 100 (inclusive).

Declaration:

public init?(percentage: Double?, reviewCount: UInt?)

Parameters:

The number of the product in stock.

Declaration:

@objc
public let count: Int

Retrieves String representation of ProductStock.

Declaration:

public override var description: String { get }

Creates a ProductStock instance.

Declaration:

@objc
public init(count: Int)

Parameters:

Queries whether the product is currently in stock. Returns true if the product stock count is greater than 0; false otherwise.

Declaration:

@objc 


public func inStock() -> Bool 

Return value:

trueif the product stock count is greater than 0;falseotherwise

The parent ID of the product.

Declaration:

@objc
public let productId: String

Whether the item is currently in stock.

Declaration:

@objc
public let inStock: Bool

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

Declaration:

@objc
public let sku: String?

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

Declaration:

@objc
public let price: Price?

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

Declaration:

@objc
public let regularPrice: Price?

The name or title of the product (optional).

Declaration:

@objc
public let title: String?

The address of the product image (optional).

Declaration:

@objc
public let image: URL?

The date when the product was added to the list (optional).

Declaration:

@objc
public let dateAdded: Date?

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

Declaration:

@objc
public let priceWhenAdded: Price?

Address of the product’s anchor tag in the list page (optional).

Declaration:

@objc
public let callToAction: URL?

Address of the product page (optional).

Declaration:

@objc
public let productPage: URL?

Creates a WishListItem instance from each distinct item property.

Declaration:

@objc
public init(productId: String,
inStock: Bool,
sku: String? = nil,
price: Price? = nil,
regularPrice: Price? = nil,
title: String? = nil,
image: URL? = nil,
dateAdded: Date? = nil,
priceWhenAdded: Price? = nil,
callToAction: URL? = nil,
productPage: URL? = nil)

Parameters:

Creates a WishListItem instance from a Product and any additional (optional) property values.

Precondition:

The inStock property of the provided Product instance must be non-nil. nil will be returned if this condition is not met.

Declaration:

@objc
public convenience init?(product: Product,
dateAdded: Date? = nil,
priceWhenAdded: Price? = nil,
callToAction: URL? = nil,
productPage: URL? = nil)

Parameters:

Encodes an instance of WishListItem.

Declaration:

public func encode(to encoder: Encoder) throws