kavita_client.api.reader.get_api_reader_file_dimensions

Module Contents

Functions

asyncio	Returns the file dimensions for all pages in a chapter. If the underlying chapter is PDF, use extractPDF to unpack as images.
asyncio_detailed	Returns the file dimensions for all pages in a chapter. If the underlying chapter is PDF, use extractPDF to unpack as images.
sync	Returns the file dimensions for all pages in a chapter. If the underlying chapter is PDF, use extractPDF to unpack as images.
sync_detailed	Returns the file dimensions for all pages in a chapter. If the underlying chapter is PDF, use extractPDF to unpack as images.

API

async kavita_client.api.reader.get_api_reader_file_dimensions.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) → list[kavita_client.models.file_dimension_dto.FileDimensionDto] | None

Returns the file dimensions for all pages in a chapter. If the underlying chapter is PDF, use extractPDF to unpack as images.

This has a side effect of caching the images.

This will only be populated on archive filetypes and not in bookmark mode

Args:

chapter_id (int | Unset): extract_pdf (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:

list[FileDimensionDto]

async kavita_client.api.reader.get_api_reader_file_dimensions.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) → kavita_client.types.Response[list[kavita_client.models.file_dimension_dto.FileDimensionDto]]

Returns the file dimensions for all pages in a chapter. If the underlying chapter is PDF, use extractPDF to unpack as images.

This has a side effect of caching the images.

This will only be populated on archive filetypes and not in bookmark mode

Args:

chapter_id (int | Unset): extract_pdf (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[list[FileDimensionDto]]

kavita_client.api.reader.get_api_reader_file_dimensions.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) → list[kavita_client.models.file_dimension_dto.FileDimensionDto] | None

Returns the file dimensions for all pages in a chapter. If the underlying chapter is PDF, use extractPDF to unpack as images.

This has a side effect of caching the images.

This will only be populated on archive filetypes and not in bookmark mode

Args:

chapter_id (int | Unset): extract_pdf (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:

list[FileDimensionDto]

kavita_client.api.reader.get_api_reader_file_dimensions.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) → kavita_client.types.Response[list[kavita_client.models.file_dimension_dto.FileDimensionDto]]

Returns the file dimensions for all pages in a chapter. If the underlying chapter is PDF, use extractPDF to unpack as images.

This has a side effect of caching the images.

This will only be populated on archive filetypes and not in bookmark mode

Args:

chapter_id (int | Unset): extract_pdf (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[list[FileDimensionDto]]