kavita_client.api.library.get_api_library_jump_bar

Module Contents

Functions

asyncio	For a given library, generate the jump bar information
asyncio_detailed	For a given library, generate the jump bar information
sync	For a given library, generate the jump bar information
sync_detailed	For a given library, generate the jump bar information

API

async kavita_client.api.library.get_api_library_jump_bar.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, library_id: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.jump_key_dto.JumpKeyDto] | None

For a given library, generate the jump bar information

Args:

library_id (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:

list[JumpKeyDto]

async kavita_client.api.library.get_api_library_jump_bar.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, library_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.jump_key_dto.JumpKeyDto]]

For a given library, generate the jump bar information

Args:

library_id (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[list[JumpKeyDto]]

kavita_client.api.library.get_api_library_jump_bar.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, library_id: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.jump_key_dto.JumpKeyDto] | None

For a given library, generate the jump bar information

Args:

library_id (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:

list[JumpKeyDto]

kavita_client.api.library.get_api_library_jump_bar.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, library_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.jump_key_dto.JumpKeyDto]]

For a given library, generate the jump bar information

Args:

library_id (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[list[JumpKeyDto]]