Skip to content
plyr.fm docs

preferences

backend.api.preferences

Section titled “backend.api.preferences”

user preferences api endpoints.

Functions

Section titled “Functions”

get_preferences source

Section titled “get_preferences source”
get_preferences(db: Annotated[AsyncSession, Depends(get_db)], session: Session = Depends(require_auth)) -> PreferencesResponse

get user preferences (creates default if not exists).

update_preferences source

Section titled “update_preferences source”
update_preferences(update: PreferencesUpdate, db: Annotated[AsyncSession, Depends(get_db)], session: Session = Depends(require_auth)) -> PreferencesResponse

update user preferences.

Classes

Section titled “Classes”

PreferencesResponse source

Section titled “PreferencesResponse source”

user preferences response model.

PreferencesUpdate source

Section titled “PreferencesUpdate source”

user preferences update model.

Methods:

validate_support_url source

Section titled “validate_support_url source”
validate_support_url(cls, v: str | None) -> str | None

validate support url: empty, ‘atprotofans’, or https:// URL.