rbtools.api.resource.user¶

Resource definitions for users.

Added in version 6.0.

Classes

`UserItemResource`(transport, payload, url[, ...])	Item resource for users.
`UserListResource`(transport, payload, url[, ...])	List resource for users.

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

Bases: BaseUserItemResource

Item resource for users.

This corresponds to Review Board’s User Resource.

Added in version 6.0.

__firstlineno__ = 32¶

__static_attributes__ = ()¶

get_api_tokens(**kwargs: Unpack[BaseGetListParams]) → APITokenListResource[source]¶

Get an API token list resource.

Parameters:

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

Returns:

The API token list resource.

Return type:

rbtools.api.resource.APITokenListResource

Raises:

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

get_archived_review_requests(**kwargs: QueryArgs) → ArchivedReviewRequestListResource[source]¶

Get an archived review requests list resource.

Parameters:

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

Returns:

The archived review request list resource.

Return type:

rbtools.api.resource.ArchivedReviewRequestListResource

Raises:

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

get_muted_review_requests(**kwargs: QueryArgs) → MutedReviewRequestListResource[source]¶

Get a muted review requests list resource.

Parameters:

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

Returns:

The muted review request list resource.

Return type:

rbtools.api.resource.MutedReviewRequestListResource

Raises:

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

get_user_file_attachments(**kwargs: Unpack[BaseGetListParams]) → UserFileAttachmentListResource[source]¶

Get the user file attachments list resource.

Parameters:

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

Returns:

The user file attachment list resource.

Return type:

rbtools.api.resource.UserFileAttachmentListResource

Raises:

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

get_watched(**kwargs: Unpack[BaseGetParams]) → WatchedResource[source]¶

Get the watched resource.

Parameters:

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

Returns:

The watched resource.

Return type:

rbtools.api.resource.WatchedResource

Raises:

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

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

Bases: BaseUserListResource[UserItemResource]

List resource for users.

This corresponds to Review Board’s User List Resource.

Added in version 6.0.

__annotations_cache__ = {}¶

__firstlineno__ = 179¶

__static_attributes__ = ()¶