rbtools.api.resource.file_attachment¶

Resource definitions for file attachments.

Classes

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

Bases: ItemResource

Item resource for file attachments.

This corresponds to Review Board’s File Attachment Resource.

Added in version 6.0.

__firstlineno__ = 31¶

__static_attributes__ = ()¶

absolute_url: str¶

The absolute URL of the file, for downloading purposes.

attachment_history_id: int¶

The ID of the file attachment history.

caption: str¶

The file’s descriptive caption.

extra_data: ResourceExtraDataField¶

Extra data as part of the file attachment.

filename: str¶

The name of the file.

get_file_attachment_comments(**kwargs: Unpack[BaseGetListParams]) → FileAttachmentCommentListResource[source]¶

Get the comments on this file attachment.

Parameters:

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

Returns:

The file_attachment comment list resource.

Return type:

rbtools.api.resource.FileAttachmentCommentListResource

Raises:

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

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

icon_url: str¶

The URL to a 24x24 icon representing the file.

The use of these icons is deprecated and this property may be removed in a future version of Review Board.

id: int¶

The numeric ID of the file.

mimetype: str¶

The mimetype for the file.

review_url: str¶

The URL to a review UI for this file.

revision: int¶

The revision of the file attachment.

thumbnail: str¶

A thumbnail representing this file.

url: str¶

The URL of the file, for downloading purposes.

This is deprecated in favor of the absolute_url attribute.

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

Bases: AttachmentUploadMixin, ListResource[FileAttachmentItemResource]

List resource for file attachments.

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

__annotations_cache__ = {}¶

__firstlineno__ = 112¶

__static_attributes__ = ()¶