Lens Scripting API

    Class ShoppingModule

    Allows the creation of Shopping Lenses with an integrated Product Catalog.

    The ShoppingModule includes several input fields for you to define as you create your Shopping Lens. The fields include:

    Domain:* name of the product line (e.g., Running Shoes). Description:* (of the domain): description of the domain (e.g., Winter Season Collection). State(s):* name of the single product displayed in that state (e.g., Shoe ABC). Description* (of each state): description of the product in the state (e.g., SKU ID 12345, red shoe).

    Shopping Lens guide.

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    Properties

    domains: DomainInfo[]

    The domain within this shopping module.

    name: string

    The name of the Asset in Lens Studio.

    onError: event2<number, string, void>

    Triggered when an error has occured on the module.

    onProductStateUpdate: event1<string, void>

    Triggered when the client (e.g. Snapchat) has changed the product state.

    uniqueIdentifier: string

    Methods

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean

    • Returns the status of whether the module has loaded.

      Returns any

    MMNEPVFCICPMFPCPTTAAATR