kavita_client.api.reader.get_api_reader_bookmark_image

Module Contents

Functions

asyncio_detailed	Returns an image for a given bookmark series. Side effect: This will cache the bookmark images for reading.
sync_detailed	Returns an image for a given bookmark series. Side effect: This will cache the bookmark images for reading.

API

async kavita_client.api.reader.get_api_reader_bookmark_image.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET, api_key: str | kavita_client.types.Unset = UNSET, page: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[Any]

Returns an image for a given bookmark series. Side effect: This will cache the bookmark images for reading.

We must use api key as bookmarks could be leaked to other users via the API

Args:

series_id (int | Unset): api_key (str | Unset): page (int | Unset):

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

kavita_client.api.reader.get_api_reader_bookmark_image.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET, api_key: str | kavita_client.types.Unset = UNSET, page: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[Any]

Returns an image for a given bookmark series. Side effect: This will cache the bookmark images for reading.

We must use api key as bookmarks could be leaked to other users via the API

Args:

series_id (int | Unset): api_key (str | Unset): page (int | Unset):

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