kavita_client.api.reader.get_api_reader_chapter_info

Module Contents

Functions

asyncio	Returns various information about a Chapter. Side effect: This will cache the chapter images for reading.
asyncio_detailed	Returns various information about a Chapter. Side effect: This will cache the chapter images for reading.
sync	Returns various information about a Chapter. Side effect: This will cache the chapter images for reading.
sync_detailed	Returns various information about a Chapter. Side effect: This will cache the chapter images for reading.

API

async kavita_client.api.reader.get_api_reader_chapter_info.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, chapter_id: int | kavita_client.types.Unset = UNSET, extract_pdf: bool | kavita_client.types.Unset = False, include_dimensions: bool | kavita_client.types.Unset = False) → kavita_client.models.chapter_info_dto.ChapterInfoDto | None

Returns various information about a Chapter. Side effect: This will cache the chapter images for reading.

This is generally the first call when attempting to read to allow pre-generation of assets needed

for reading

Args:

chapter_id (int | Unset): extract_pdf (bool | Unset): Default: False. include_dimensions (bool | Unset): Default: False.

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:

ChapterInfoDto

async kavita_client.api.reader.get_api_reader_chapter_info.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, chapter_id: int | kavita_client.types.Unset = UNSET, extract_pdf: bool | kavita_client.types.Unset = False, include_dimensions: bool | kavita_client.types.Unset = False) → kavita_client.types.Response[kavita_client.models.chapter_info_dto.ChapterInfoDto]

Returns various information about a Chapter. Side effect: This will cache the chapter images for reading.

This is generally the first call when attempting to read to allow pre-generation of assets needed

for reading

Args:

chapter_id (int | Unset): extract_pdf (bool | Unset): Default: False. include_dimensions (bool | Unset): Default: False.

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[ChapterInfoDto]

kavita_client.api.reader.get_api_reader_chapter_info.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, chapter_id: int | kavita_client.types.Unset = UNSET, extract_pdf: bool | kavita_client.types.Unset = False, include_dimensions: bool | kavita_client.types.Unset = False) → kavita_client.models.chapter_info_dto.ChapterInfoDto | None

Returns various information about a Chapter. Side effect: This will cache the chapter images for reading.

This is generally the first call when attempting to read to allow pre-generation of assets needed

for reading

Args:

chapter_id (int | Unset): extract_pdf (bool | Unset): Default: False. include_dimensions (bool | Unset): Default: False.

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:

ChapterInfoDto

kavita_client.api.reader.get_api_reader_chapter_info.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, chapter_id: int | kavita_client.types.Unset = UNSET, extract_pdf: bool | kavita_client.types.Unset = False, include_dimensions: bool | kavita_client.types.Unset = False) → kavita_client.types.Response[kavita_client.models.chapter_info_dto.ChapterInfoDto]

Returns various information about a Chapter. Side effect: This will cache the chapter images for reading.

This is generally the first call when attempting to read to allow pre-generation of assets needed

for reading

Args:

chapter_id (int | Unset): extract_pdf (bool | Unset): Default: False. include_dimensions (bool | Unset): Default: False.

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[ChapterInfoDto]