@dvxch/yandex-music
    Preparing search index...

    Class Product

    A purchasable subscription product.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    available? buttonAdditionalText? buttonText? cheapest? client? commonPeriodDuration? debug? description? duration? family? familySub? fbImage? fbName? feature? features? introPeriodDuration? introPrice? licenceTextParts? paymentMethodTypes? plus? price? productId? startPeriodDuration? startPrice? title? trialAvailable? trialDuration? trialPeriodDuration? type? vendorTrialAvailable?

    Methods

    deJson requireClient

    Constructors

    Properties

    available?: boolean

    Whether the product is available.

    buttonAdditionalText?: string

    Additional button text.

    buttonText?: string

    Call-to-action button text.

    cheapest?: boolean

    Whether this is the cheapest product.

    client?: Client

    The client that created this model, used by convenience methods.

    commonPeriodDuration?: string

    Common period duration.

    debug?: boolean

    Whether this is a debug product.

    description?: string

    Description.

    duration?: number

    Subscription duration.

    family?: boolean

    Whether the product is a family plan.

    familySub?: boolean

    Whether this is a family subscription.

    fbImage?: string

    Facebook share image.

    fbName?: string

    Facebook share name.

    feature?: string

    Feature key.

    features?: string[]

    Feature keys.

    introPeriodDuration?: string

    Intro period duration.

    introPrice?: Price

    Intro price.

    licenceTextParts?: LicenceTextPart[]

    Licence text parts.

    paymentMethodTypes?: string[]

    Accepted payment-method types.

    plus?: boolean

    Whether the product includes Plus.

    price?: Price

    Recurring price.

    productId?: string

    Product id.

    startPeriodDuration?: string

    Start period duration.

    startPrice?: Price

    Start price.

    title?: string

    Display title.

    trialAvailable?: boolean

    Whether a trial is available.

    trialDuration?: number

    Trial duration.

    trialPeriodDuration?: string

    Trial period duration.

    type?: string

    Product type.

    vendorTrialAvailable?: boolean

    Whether a vendor trial is available.

    Methods

    • Assert that this model carries a client, returning it narrowed to non-null.

      Convenience methods that need to call the API use this to fail fast with a clear message instead of a generic "cannot read property of undefined".

      Returns Client

      The owning Client.

      When the model was created without a client.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods