Interface PlaylistClearSuccess

Successful response from playlist.clear.

interface PlaylistClearSuccess {
    clearedCount: number;
    playlist: number;
    playlistGuid: string;
    remainingCount: number;
    success: true;
}

Properties

clearedCount: number

Number of tracks it held before.

playlist: number

Index of the playlist.

playlistGuid: string

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

remainingCount: number

Number of tracks left; 0 on success.

success: true

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