Comments#

class frameioclient.Comment(client)#
create(asset_id, text=None, timestamp=None, annotation=None, **kwargs)#

Create a comment.

Parameters:

  • asset_id (Union[str, UUID]) – The asset id.

  • text (Optional[str]) – The comment text.

  • timestamp (Optional[int]) – The timestamp of the comment.

  • annotation (Optional[str]) – The serialized contents of the annotation.

Keyword Arguments:

(optional) kwargs: additional request parameters.

Example:

client.comments.create(
  asset_id="123abc",
  text="Hello world",
  timestamp=10
)
delete(comment_id)#

Delete a comment.

Parameters:

comment_id (Union[str, UUID]) – The comment id.

get(comment_id, **kwargs)#

Get a comment.

Parameters:

comment_id (Union[str, UUID]) – The comment id.

list(asset_id, **kwargs)#

Get an asset’s comments.

Parameters:

asset_id (Union[str, UUID]) – The asset id.

reply(comment_id, **kwargs)#

Reply to an existing comment.

Parameters:

comment_id (string) – The comment id.

Keyword Arguments:

(optional) kwargs: additional request parameters.

Example:

client.comments.reply(
  comment_id="123abc",
  text="Hello world"
)
update(comment_id, text=None, timestamp=None, annotation=None, **kwargs)#

Update a comment.

Parameters:

  • comment_id (Union[str, UUID]) – The comment id.

  • text (Optional[str]) – The comment text.

  • timestamp (Optional[int]) – The timestamp of the comment.

  • annotation (Optional[str]) – The serialized contents of the annotation.

Keyword Arguments:

(optional) kwargs: additional request parameters.

Example:

client.comments.update(
  comment_id="123abc",
  text="Hello world",
  timestamp=10
)