kavita_client.api.stream.get_api_stream_sidenav

Module Contents

Functions

asyncio	Return’s the user’s side nav
asyncio_detailed	Return’s the user’s side nav
sync	Return’s the user’s side nav
sync_detailed	Return’s the user’s side nav

API

async kavita_client.api.stream.get_api_stream_sidenav.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, visible_only: bool | kavita_client.types.Unset = True) → list[kavita_client.models.side_nav_stream_dto.SideNavStreamDto] | None

Return’s the user’s side nav

Args:

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

list[SideNavStreamDto]

async kavita_client.api.stream.get_api_stream_sidenav.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, visible_only: bool | kavita_client.types.Unset = True) → kavita_client.types.Response[list[kavita_client.models.side_nav_stream_dto.SideNavStreamDto]]

Return’s the user’s side nav

Args:

visible_only (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[list[SideNavStreamDto]]

kavita_client.api.stream.get_api_stream_sidenav.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, visible_only: bool | kavita_client.types.Unset = True) → list[kavita_client.models.side_nav_stream_dto.SideNavStreamDto] | None

Return’s the user’s side nav

Args:

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

list[SideNavStreamDto]

kavita_client.api.stream.get_api_stream_sidenav.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, visible_only: bool | kavita_client.types.Unset = True) → kavita_client.types.Response[list[kavita_client.models.side_nav_stream_dto.SideNavStreamDto]]

Return’s the user’s side nav

Args:

visible_only (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[list[SideNavStreamDto]]