Tankōbon / preload / ReadingListApi
Interface: ReadingListApi
Defined in: preload.ts:120
Reading lists (ordered piles of library entries), as window.tankobon.readingLists.
Methods
addEntries()
addEntries(
id,libraryIds):Promise<ReadingListAddResult>
Defined in: preload.ts:132
Appends several library entries to a reading list, in the order given: books already in it are skipped, and once it holds 50 books the rest are left out (the result counts each case).
Parameters
id
string
libraryIds
string[]
Returns
Promise<ReadingListAddResult>
addEntry()
addEntry(
id,libraryId):Promise<ReadingListResult>
Defined in: preload.ts:130
Appends a library entry to a reading list; refused when the list already holds 50 books.
Parameters
id
string
libraryId
string
Returns
Promise<ReadingListResult>
create()
create(
name):Promise<ReadingListResult>
Defined in: preload.ts:124
Creates an empty reading list; refused when the name is empty.
Parameters
name
string
Returns
Promise<ReadingListResult>
list()
list():
Promise<ReadingList[]>
Defined in: preload.ts:122
Every reading list, in the user's order (new lists last), each with its library entry ids in reading order.
Returns
Promise<ReadingList[]>
remove()
remove(
id):Promise<void>
Defined in: preload.ts:128
Deletes a reading list; its books stay in the library.
Parameters
id
string
Returns
Promise<void>
removeEntry()
removeEntry(
id,libraryId):Promise<ReadingListResult>
Defined in: preload.ts:134
Takes a library entry out of a reading list.
Parameters
id
string
libraryId
string
Returns
Promise<ReadingListResult>
rename()
rename(
id,name):Promise<ReadingListResult>
Defined in: preload.ts:126
Renames a reading list; refused when the name is empty.
Parameters
id
string
name
string
Returns
Promise<ReadingListResult>
reorder()
reorder(
id,entryIds):Promise<ReadingListResult>
Defined in: preload.ts:136
Stores a new order for a reading list; entryIds must hold exactly the list's current entries.
Parameters
id
string
entryIds
string[]
Returns
Promise<ReadingListResult>
reorderLists()
reorderLists(
listIds):Promise<ReadingListOrderResult>
Defined in: preload.ts:138
Stores a new order for the reading lists themselves; listIds must hold exactly the current lists.
Parameters
listIds
string[]
Returns
Promise<ReadingListOrderResult>