foo-webview-sdk
    Preparing search index...

    Interface LibraryGetAllSuccess

    Successful response from library.getAll.

    interface LibraryGetAllSuccess {
        fromCache?: boolean;
        items?: LibraryTrack[];
        limit?: number;
        offset?: number;
        pending?: boolean;
        requestId?: string;
        success: true;
        total?: number;
        tracks?: LibraryTrack[];
    }
    Index
    fromCache? items? limit? offset? pending? requestId? success total? tracks?
    fromCache?: boolean

    true when the page came from the kept list.

    items?: LibraryTrack[]

    The same list as tracks.

    limit?: number

    The limit applied.

    offset?: number

    The offset applied.

    pending?: boolean

    true when the page will arrive as the library:getAllResult event; the page fields are then absent.

    requestId?: string

    Id the library:getAllResult event carries; present with pending.

    success: true

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

    total?: number

    Tracks in the library.

    tracks?: LibraryTrack[]

    The page in library order; index is the position in the library.

    Settings
    Member Visibility

    On This Page
    Properties