kavita_client.api.book.get_api_book_chapter_id_chapters

Module Contents

Functions

asyncio	This will return a list of mappings from ID -> page num. ID will be the xhtml key and page num will be the reading order this is used to rewrite anchors in the book text so that we always load properly in our reader.
asyncio_detailed	This will return a list of mappings from ID -> page num. ID will be the xhtml key and page num will be the reading order this is used to rewrite anchors in the book text so that we always load properly in our reader.
sync	This will return a list of mappings from ID -> page num. ID will be the xhtml key and page num will be the reading order this is used to rewrite anchors in the book text so that we always load properly in our reader.
sync_detailed	This will return a list of mappings from ID -> page num. ID will be the xhtml key and page num will be the reading order this is used to rewrite anchors in the book text so that we always load properly in our reader.

API

async kavita_client.api.book.get_api_book_chapter_id_chapters.asyncio(chapter_id: int, *, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → list[kavita_client.models.book_chapter_item.BookChapterItem] | None

This will return a list of mappings from ID -> page num. ID will be the xhtml key and page num will be the reading order this is used to rewrite anchors in the book text so that we always load properly in our reader.

This is essentially building the table of contents

Args:

chapter_id (int):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

list[BookChapterItem]

async kavita_client.api.book.get_api_book_chapter_id_chapters.asyncio_detailed(chapter_id: int, *, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → kavita_client.types.Response[list[kavita_client.models.book_chapter_item.BookChapterItem]]

This will return a list of mappings from ID -> page num. ID will be the xhtml key and page num will be the reading order this is used to rewrite anchors in the book text so that we always load properly in our reader.

This is essentially building the table of contents

Args:

chapter_id (int):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[list[BookChapterItem]]

kavita_client.api.book.get_api_book_chapter_id_chapters.sync(chapter_id: int, *, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → list[kavita_client.models.book_chapter_item.BookChapterItem] | None

This will return a list of mappings from ID -> page num. ID will be the xhtml key and page num will be the reading order this is used to rewrite anchors in the book text so that we always load properly in our reader.

This is essentially building the table of contents

Args:

chapter_id (int):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

list[BookChapterItem]

kavita_client.api.book.get_api_book_chapter_id_chapters.sync_detailed(chapter_id: int, *, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → kavita_client.types.Response[list[kavita_client.models.book_chapter_item.BookChapterItem]]

This will return a list of mappings from ID -> page num. ID will be the xhtml key and page num will be the reading order this is used to rewrite anchors in the book text so that we always load properly in our reader.

This is essentially building the table of contents

Args:

chapter_id (int):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[list[BookChapterItem]]