foo-webview-sdk
    Preparing search index...

    Interface QueueAddPathsSuccess

    Successful response from queue.addPaths.

    interface QueueAddPathsSuccess {
        addedCount: number;
        invalidCount: number;
        playlist: number;
        playlistGuid: string;
        queueCount: number;
        success: true;
    }
    Index
    addedCount invalidCount playlist playlistGuid queueCount success
    addedCount: number

    How many tracks were appended and queued.

    invalidCount: number

    Entries of paths dropped: empty ones, ones longer than 2048 characters, a |subsong:N no track could be made for, and the plain paths when none of them resolved. A plain path that resolves to nothing while another plain path of the call resolves is not counted, so a call that succeeds can have dropped more than this.

    playlist: number

    The playlist the tracks were appended to.

    playlistGuid: string

    Unique identifier of the playlist, formatted as {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}. Pass as playlistGuid to reliably target this playlist.

    queueCount: number

    Queue length afterwards.

    success: true

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

    Settings
    Member Visibility

    On This Page
    Properties