Interface PlaylistGetSelectionSuccess

Successful response from playlist.getSelection.

interface PlaylistGetSelectionSuccess {
    contentVersion: string;
    count: number;
    items: number[];
    playlist: number;
    playlistGuid: string;
    success: true;
}

Properties

contentVersion: string

The row numbers in items hold only while the playlist keeps this version.

count: number

Number of entries in items.

items: number[]

Selected rows, in playlist order.

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.

success: true

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