ovok_sdk.auth.user_session

The signed-in user's session and its token refresh.

UserSessionCopy Anchor Link

UserSession(
    store: SessionStore,
    endpoint: TokenEndpoint,
    settings: OvokSettings,
    clock: Clock = epoch_ms,
)

The signed-in user's tokens, kept in storage and refreshed a minute before they expire.

Parameters

current()Copy Anchor Link

current() -> Session | None

Return the stored session, or None when no one is signed in.

begin()Copy Anchor Link

begin(tokens: Mapping[str, Any]) -> Session

Start a session from a sign-in response and notify listeners.

Parameters

Returns

• Session: The new session.

end()Copy Anchor Link

end() -> None

Delete the session and notify listeners.

on_change()Copy Anchor Link

on_change(listener: Callable[[], None]) -> None

Call listener whenever the session starts, refreshes or ends.

access_token()Copy Anchor Link

access_token() -> str | None

Return the access token, refreshing it first when it is stale; None when signed out.

refresh()Copy Anchor Link

refresh() -> bool

Exchange the refresh token for new tokens.

A refused refresh signs the user out and calls on_unauthenticated.

Returns

• bool: True when the session was refreshed; False when there is nothing to refresh
• bool: or the refresh was refused.

Raises

• OvokError: The refresh failed for another reason, such as an outage.