rbtools.api.resource.session¶

Resource definition for the session resource.

Added in version 6.0.

Classes

SessionResource(transport, payload, url[, token])

Resource for the session.

class rbtools.api.resource.session.SessionResource(transport: Transport, payload: JSONDict, url: str, token: str | None = None, **kwargs)[source]¶

Bases: ItemResource

Resource for the session.

This corresponds to Review Board’s Session Resource.

Added in version 6.0.

__firstlineno__ = 20¶

__static_attributes__ = ()¶

authenticated: bool¶: Whether the session is logged in.

get_user(**kwargs: Unpack[UserGetParams]) → UserItemResource[source]¶

Get the logged-in user for the session.

Parameters:

**kwargs (dict) – Query arguments to include with the request.

Returns:

The user item resource for the logged-in user.

Return type:

rbtools.api.resource.UserItemResource

Raises:

rbtools.api.errors.APIError – The Review Board API returned an error.
rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.