rbtools.api.resource.file_attachment_comment¶

Resource definitions for file attachment comments.

Classes

class rbtools.api.resource.file_attachment_comment.AllFileAttachmentCommentsGetListParams[source]¶

Bases: BaseGetListParams

Params for the all file attachment comments list resource GET operation.

Added in version 6.0.

__firstlineno__ = 101¶

__static_attributes__ = ()¶

file_attachment_id: int¶

The ID of the file attachment that comments must be on.

file_name: str¶

The filename of the file that comments must be on.

is_reply: bool¶

Whether to return file attachment comments that are replies.

last_updated_from: str¶

The earliest date/time the comment could be last updated.

This is compared against the comment’s timestamp field. This must be a valid ISO-8601 date/time format.

last_updated_to: str¶

The latest date/time the review could be last updated.

This is compared against the comment’s timestamp field. This must be a valid ISO-8601 date/time format.

review_id: str¶

The ID of the review that file attachment comments must belong to.

review_request_id: str¶

The ID of the review request that file attachment comments must belong to.

user: str¶

The username of the user that the reviews must be owned by.

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

Bases: BaseCommentItemResource

Item resource for file attachment comments.

This corresponds to Review Board’s Review File Attachment Comment Resource.

Added in version 6.0.

__firstlineno__ = 26¶

__static_attributes__ = ()¶

get_diff_against_file_attachment(**kwargs: Unpack[BaseGetParams]) → FileAttachmentItemResource[source]¶

Get the original (left-hand) file when the comment was on a diff.

Parameters:

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

Returns:

The file attachment item resource.

Return type:

rbtools.api.resource.FileAttachmentItemResource

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_file_attachment(**kwargs: Unpack[BaseGetParams]) → FileAttachmentItemResource[source]¶

Get the file that the comment was on.

Parameters:

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

Returns:

The file attachment item resource.

Return type:

rbtools.api.resource.FileAttachmentItemResource

Raises:

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

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

link_text: str¶

The text used to describe a link to the file.

review_url: str¶

The URL to the review UI for the comment on this file attachment.

thumbnail_url: str¶

The HTML representing a thumbnail, if any, for this comment.

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

Bases: ListResource[FileAttachmentCommentItemResource]

List resource for file attachment comments.

This corresponds to Review Board’s Review File Attachment Comment List Resource.

Added in version 6.0.

__firstlineno__ = 140¶

__static_attributes__ = ()¶