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

    Class UserSettings

    A user's playback and library preferences.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    addNewTrackOnPlaylistTop? adsDisabled? autoPlayRadio? childModeChangedByUser? childModEnabled? client? diskEnabled? explicitForbidden? facebookScrobblingEnabled? lastFmScrobblingEnabled? modified? promosDisabled? rbtDisabled? showDiskTracksInLibrary? shuffleEnabled? syncQueueEnabled? theme? uid? userCollectionHue? userMusicVisibility? userSocialVisibility? volumePercents? wizardIsPassed?

    Methods

    deJson requireClient

    Constructors

    Properties

    addNewTrackOnPlaylistTop?: boolean

    Whether newly added tracks go to the top of playlists.

    adsDisabled?: boolean

    Whether ads are disabled.

    autoPlayRadio?: boolean

    Whether radio auto-plays.

    childModeChangedByUser?: boolean

    Whether child mode was changed by the user.

    childModEnabled?: boolean

    Whether child mode is enabled.

    client?: Client

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

    diskEnabled?: boolean

    Whether Yandex Disk integration is enabled.

    explicitForbidden?: boolean

    Whether explicit content is forbidden for the account.

    facebookScrobblingEnabled?: boolean

    Whether Facebook scrobbling is enabled.

    lastFmScrobblingEnabled?: boolean

    Whether Last.fm scrobbling is enabled.

    modified?: string

    Last modification timestamp.

    promosDisabled?: boolean

    Whether promos are disabled.

    rbtDisabled?: boolean

    Whether ringback tones are disabled.

    showDiskTracksInLibrary?: boolean

    Whether Disk tracks appear in the library.

    shuffleEnabled?: boolean

    Whether shuffle is enabled.

    syncQueueEnabled?: boolean

    Whether queue sync is enabled.

    theme?: string

    UI theme.

    uid?: number

    Owner uid.

    userCollectionHue?: string

    Library accent hue chosen by the user.

    userMusicVisibility?: string

    Visibility of the user's music.

    userSocialVisibility?: string

    Visibility of the user's social activity.

    volumePercents?: number

    Default playback volume (percent).

    wizardIsPassed?: boolean

    Whether the onboarding wizard has been completed.

    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