rbtools.api.resource.base_user¶

Base class for user resources.

Classes

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

Bases: ItemResource

Base class for user item resources.

Added in version 6.0.

__firstlineno__ = 38¶

__static_attributes__ = ()¶

avatar_html: str | None¶

HTML for rendering the avatar at specified sizes.

This is only present if the resource was fetched with ?render-avatars-at= (for GET requests) or render-avatars-at= (for POST requests).

avatar_url: str | None¶

The URL for an avatar representing the user, if available.

avatar_urls: dict[str, str]¶

The URLs for an avatar representing the user.

The keys of this will be screen pixel density (for example, 1x or 2x). The values are URLs to avatar images to render for that screen type.

email: str | None¶

The user’s e-mail address.

first_name: str | None¶

The user’s first name.

fullname: str | None¶

The user’s full name (first and last).

id: int¶

The numeric ID of the user.

is_active: bool¶

Whether or not the user is active.

Inactive users are not able to log in or make changes to Review Board.

last_name: str | None¶

The user’s last name.

url: str¶

The URL to the user’s page on the site.

username: str¶

The user’s username.

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

Bases: Generic[TItemResource], ListResource[TItemResource]

Base class for user list resources.

Added in version 6.0.

__firstlineno__ = 128¶

__static_attributes__ = ()¶

class rbtools.api.resource.base_user.UserGetListParams[source]¶

Bases: BaseGetListParams

Params for the user list GET operation.

Added in version 6.0.

__firstlineno__ = 98¶

__static_attributes__ = ()¶

fullname: bool¶

Specifies whether the q parameter should also match the full name.

If set, queries will also match the beginning of the first name or last name. Ignored if q is not set.

include_inactive: bool¶

Whether to include users who have been marked as inactive.

q: str¶

The string to match.

By default, this will match the start of the username field. If fullname is set, this will also match first and last names. This is case-sensitive.

render_avatars_at: str¶

A comma-separated list of avatar pixel sizes to render.

Each of the requested sizes will be available in the avatar_html field of the returned resource.

class rbtools.api.resource.base_user.UserGetParams[source]¶

Bases: BaseGetParams

Params for the user item GET operation.

Added in version 6.0.

__firstlineno__ = 24¶

__static_attributes__ = ()¶

render_avatars_at: str¶

A comma-separated list of avatar pixel sizes to render.

Each of the requested sizes will be available in the avatar_html field of the returned resource.