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

    Class Status

    Aggregated account status returned by account/status.

    A few rarely-used sub-objects (stationData, barBelow) remain raw JSON; the commonly-used permissions, subscription and plus are typed.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    account? advertisement? barBelow? cacheLimit? client? defaultEmail? experiment? hasOptions? masterhub? permissions? plus? premiumRegion? pretrialActive? skipsPerHour? stationData? stationExists? subeditor? subeditorLevel? subscription? userhash?

    Methods

    deJson requireClient

    Constructors

    Properties

    account?: Account

    Account info.

    advertisement?: string

    Advertisement payload.

    barBelow?: JSONValue

    Bar-below alert (raw JSON, pending a typed model).

    cacheLimit?: number

    Offline cache track limit.

    client?: Client

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

    defaultEmail?: string

    Default email.

    experiment?: number

    Experiment bucket.

    hasOptions?: boolean

    Whether the account has purchase options.

    masterhub?: JSONValue

    Masterhub payload (raw JSON, pending a typed model).

    permissions?: Permissions

    Granted permissions.

    plus?: Plus

    Yandex Plus status.

    premiumRegion?: number

    Premium region.

    pretrialActive?: boolean

    Whether a pre-trial is active.

    skipsPerHour?: number

    Allowed skips per hour.

    stationData?: JSONValue

    Station data (raw JSON, pending a typed model).

    stationExists?: boolean

    Whether a personal station exists.

    subeditor?: boolean

    Whether the user is a sub-editor.

    subeditorLevel?: number

    Sub-editor level.

    subscription?: Subscription

    Subscription state.

    userhash?: string

    User hash.

    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