rbtools.api.resource.screenshot¶

Resource definitions for screenshots.

Classes

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

Bases: ItemResource

Item resource for screenshots.

This corresponds to Review Board’s Screenshot Resource.

Added in version 6.0.

__firstlineno__ = 28¶

__static_attributes__ = ()¶

absolute_url: str¶

The absolute URL of the screenshot file, for downloading purposes.

caption: str¶

The screenshot’s descriptive caption.

filename: str¶

The name of the screenshot file.

get_screenshot_comments(**kwargs: Unpack[BaseGetListParams]) → ScreenshotCommentListResource[source]¶

Get the comments on the screenshot.

Parameters:

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

Returns:

The screenshot comment list resource.

Return type:

rbtools.api.resource.ScreenshotCommentListResource

Raises:

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

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

id: int¶

The numeric ID of the screenshot.

path: str¶

The path of the screenshot’s image file.

This is relative to the configured media directory on the Review Board server.

review_url: str¶

The URL to the review UI for this screenshot

thumbnail_url: str¶

The URL of the screenshot’s thumbnail file.

If this is not an absolute URL, it is relative to the Review Board server URL.

url: str¶

The URL of the screenshot file.

This is deprecated in favor of the absolute_url attribute.

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

Bases: ScreenshotUploadMixin, ListResource[ScreenshotItemResource]

List resource for screenshots.

This corresponds to Review Board’s Screenshot List Resource.

__annotations_cache__ = {}¶

__firstlineno__ = 100¶

__static_attributes__ = ()¶