Interface PlaylistGetLockInfoSuccess

Successful response from playlist.getLockInfo.

interface PlaylistGetLockInfoSuccess {
    isLocked: boolean;
    playlist: number;
    playlistGuid: string;
    success: true;
}

Properties

isLocked: boolean

Whether it carries a lock.

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.