Lens Scripting API
    Preparing search index...

    Class Price

    Represents the price of a product in a Lens.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    currency displayPrice price

    Methods

    getTypeName getTypeName isOfType isSame

    Constructors

    • Parameters

      • price: number
      • displayPrice: string
      • currency: string

      Returns Price

    Properties

    currency: string

    The standard three-letter code that indicates the currency of the price (e.g., "USD" for US Dollars, "EUR" for Euros). It helps ensure that prices are displayed and processed correctly across different regions.

    displayPrice: string

    Provides a pre-formatted string of the product's price, including the appropriate currency symbol and localized formatting (e.g., "$10.99" in the US, "10,99 €" in Europe). This ensures prices are displayed clearly and correctly to users worldwide without requiring manual formatting.

    price: number

    The price of the product in cents (e.g., 1099 for $10.99 USD). This format is commonly used for displaying prices.

    Methods

    • Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

      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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods