rbtools.api.resource.watched¶

Resource definitions for the watched list.

Classes

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

Bases: ItemResource

The watched list resource.

This corresponds to Review Board’s Watched List Resource.

Added in version 6.0.

__firstlineno__ = 27¶

__static_attributes__ = ()¶

get_watched_review_groups(**kwargs: Unpack[BaseGetListParams]) → WatchedReviewGroupListResource[source]¶

Get the watched review group list resource.

Parameters:

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

Returns:

The watched review group list resource.

Return type:

rbtools.api.resource.WatchedReviewGroupListResource

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_review_requests(**kwargs: Unpack[BaseGetListParams]) → WatchedReviewRequestListResource[source]¶

Get the watched review request list resource.

Parameters:

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

Returns:

The watched review request list resource.

Return type:

rbtools.api.resource.WatchedReviewRequestListResource

Raises:

• rbtools.api.errors.APIError – The Review Board API returned an error.

• rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.