kavita_client.api.stream.get_api_stream_dashboard

Module Contents

Functions

asyncio	Returns the layout of the user’s dashboard
asyncio_detailed	Returns the layout of the user’s dashboard
sync	Returns the layout of the user’s dashboard
sync_detailed	Returns the layout of the user’s dashboard

API

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

Returns the layout of the user’s dashboard

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

async kavita_client.api.stream.get_api_stream_dashboard.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.dashboard_stream_dto.DashboardStreamDto]]

Returns the layout of the user’s dashboard

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

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

Returns the layout of the user’s dashboard

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

kavita_client.api.stream.get_api_stream_dashboard.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.dashboard_stream_dto.DashboardStreamDto]]

Returns the layout of the user’s dashboard

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