kavita_client.api.reader.get_api_reader_bookmark_info

Module Contents

Functions

asyncio	Returns various information about all bookmark files for a Series. Side effect: This will cache the bookmark images for reading.
asyncio_detailed	Returns various information about all bookmark files for a Series. Side effect: This will cache the bookmark images for reading.
sync	Returns various information about all bookmark files for a Series. Side effect: This will cache the bookmark images for reading.
sync_detailed	Returns various information about all bookmark files for a Series. Side effect: This will cache the bookmark images for reading.

API

async kavita_client.api.reader.get_api_reader_bookmark_info.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET, include_dimensions: bool | kavita_client.types.Unset = True) → kavita_client.models.bookmark_info_dto.BookmarkInfoDto | None

Returns various information about all bookmark files for a Series. Side effect: This will cache the bookmark images for reading.

Args:

series_id (int | Unset): include_dimensions (bool | Unset): Default: True.

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:

BookmarkInfoDto

async kavita_client.api.reader.get_api_reader_bookmark_info.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET, include_dimensions: bool | kavita_client.types.Unset = True) → kavita_client.types.Response[kavita_client.models.bookmark_info_dto.BookmarkInfoDto]

Returns various information about all bookmark files for a Series. Side effect: This will cache the bookmark images for reading.

Args:

series_id (int | Unset): include_dimensions (bool | Unset): Default: True.

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

kavita_client.api.reader.get_api_reader_bookmark_info.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET, include_dimensions: bool | kavita_client.types.Unset = True) → kavita_client.models.bookmark_info_dto.BookmarkInfoDto | None

Returns various information about all bookmark files for a Series. Side effect: This will cache the bookmark images for reading.

Args:

series_id (int | Unset): include_dimensions (bool | Unset): Default: True.

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:

BookmarkInfoDto

kavita_client.api.reader.get_api_reader_bookmark_info.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET, include_dimensions: bool | kavita_client.types.Unset = True) → kavita_client.types.Response[kavita_client.models.bookmark_info_dto.BookmarkInfoDto]

Returns various information about all bookmark files for a Series. Side effect: This will cache the bookmark images for reading.

Args:

series_id (int | Unset): include_dimensions (bool | Unset): Default: True.

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