Interface LibraryGetAlbumsSuccess

Successful response from library.getAlbums.

interface LibraryGetAlbumsSuccess {
    albums: AlbumInfo[];
    fromCache: boolean;
    hasMore: boolean;
    includeCover: boolean;
    limit: number;
    offset: number;
    success: true;
    total: number;
}

Properties

albums: AlbumInfo[]

The albums of this page, sorted by sort.

fromCache: boolean

true when the answer came from the kept list.

hasMore: boolean

Whether albums remain after this page.

includeCover: boolean

The includeCover applied.

limit: number

The limit applied.

offset: number

The offset applied.

success: true

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

total: number

Albums matching query, before offset and limit.