rbtools.api.resource.base_comment¶

Base class for comment resources.

Classes

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

Bases: ItemResource

Base class for comment item resources.

Added in version 6.0.

__firstlineno__ = 23¶

__static_attributes__ = ()¶

extra_data: ResourceExtraDataField¶

Extra data as part of the comment.

get_user(**kwargs: Unpack[UserGetParams]) → UserItemResource[source]¶

Get the user who made the comment.

Parameters:

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

Returns:

The user item resource.

Return type:

rbtools.api.resource.UserItemResource

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 comment

issue_opened: bool¶

Whether or not the comment opens an issue.

issue_status: Literal['dropped', 'open', 'resolved', 'verifying-dropped', 'verifying-resolved'] | None¶

The status of the issue.

public: bool¶

Whether or not the comment is part of a public review.

text: str¶

The comment text.

text_type: TextType¶

The text type for the comment text.

timestamp: str¶

The date and time that the comment was made, in ISO-8601 format.