foo-webview-sdk
    Preparing search index...

    Interface PlaylistGetTracksSuccess

    Successful response from playlist.getTracks.

    interface PlaylistGetTracksSuccess {
        contentVersion?: string;
        count: number;
        playlist: number;
        playlistGuid?: string;
        start: number;
        success: true;
        total: number;
        tracks: PlaylistTrackPartial[];
    }
    Index
    contentVersion? count playlist playlistGuid? start success total tracks
    contentVersion?: string

    Pages can be joined only when this matches; absent when the playlist does not exist.

    count: number

    Rows returned.

    playlist: number

    The playlist read, as given or resolved. -1 when there is none to name: playlist was omitted and there is no active playlist, or no playlist has the playlistGuid. An index past the last playlist comes back as given.

    playlistGuid?: string

    GUID of the playlist read, as playlistGuid takes it; absent when the playlist does not exist, so its absence is what tells a missing playlist from an empty one.

    start: number

    The start applied.

    success: true

    Always true here; a failed call resolves with ApiFailure instead.

    total: number

    Rows in the playlist; 0 when it does not exist.

    tracks: PlaylistTrackPartial[]

    The rows from start: whole rows, or index plus the fields asked for.

    Settings
    Member Visibility

    On This Page
    Properties