bookshelf_queue
Manage the download queue: list items, fetch status and details, grab single or bulk items, or delete entries using specified operations.
Instructions
bookshelf queue operations on Bookshelf. Pass operation and an arguments dict matching that operation's parameters.
bookshelf_bulk_delete_queue(remove_from_client=True, blocklist=False, skip_redownload=False, change_category=False, body={}) — Bulk delete queue bulk. Query params: removeFromClient, blocklist, skipRedownload, changeCategory. DESTRUCTIVE: this deletes data.
bookshelf_delete_queue(id, remove_from_client=True, blocklist=False, skip_redownload=False, change_category=False) — Delete queue. Query params: removeFromClient, blocklist, skipRedownload, changeCategory. DESTRUCTIVE: this deletes data.
bookshelf_get_queue_details(author_id=None, book_ids=None, include_author=False, include_book=True) — List detailed queue items for an author or books.
bookshelf_get_queue_status() — Get queue statistics: total/full count and warnings.
bookshelf_grab_queue_bulk(body={}) — Grab multiple queue items now. Body is a QueueBulkResource with ids.
bookshelf_grab_queue_item(id) — Grab a single queue item now.
bookshelf_list_queue(page=1, page_size=10, sort_key=None, sort_direction=None, include_unknown_author_items=False, include_author=False, include_book=False) — List queue. Query params: page, pageSize, sortKey, sortDirection, includeUnknownAuthorItems, includeAuthor, includeBook.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| arguments | No | ||
| operation | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |