kavita_client.api.library.post_api_library_scan_all

Module Contents

Functions

asyncio_detailed	Scans a given library for file changes. If another scan task is in progress, will reschedule the invocation for 3 hours in future.
sync_detailed	Scans a given library for file changes. If another scan task is in progress, will reschedule the invocation for 3 hours in future.

API

async kavita_client.api.library.post_api_library_scan_all.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, force: bool | kavita_client.types.Unset = False) → kavita_client.types.Response[Any]

Scans a given library for file changes. If another scan task is in progress, will reschedule the invocation for 3 hours in future.

Args:

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

kavita_client.api.library.post_api_library_scan_all.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, force: bool | kavita_client.types.Unset = False) → kavita_client.types.Response[Any]

Scans a given library for file changes. If another scan task is in progress, will reschedule the invocation for 3 hours in future.

Args:

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