Trait CommentsService 

pub trait CommentsService<I>
where
    I: Iterator<Item = Result<Bytes, Error>>,
{
    // Required methods
    fn get_conversation(
        &self,
        auth_: &BearerToken,
        resource_type: &ResourceType,
        resource_rid: &ResourceIdentifier,
    ) -> Result<Conversation, Error>;
    fn get_conversation_count(
        &self,
        auth_: &BearerToken,
        resource_type: &ResourceType,
        resource_rid: &ResourceIdentifier,
        include_deleted: Option<bool>,
    ) -> Result<i32, Error>;
    fn get_comment(
        &self,
        auth_: &BearerToken,
        comment_rid: &CommentRid,
    ) -> Result<Comment, Error>;
    fn create_comment(
        &self,
        auth_: &BearerToken,
        request: &CreateCommentRequest,
    ) -> Result<Comment, Error>;
    fn edit_comment(
        &self,
        auth_: &BearerToken,
        comment_rid: &CommentRid,
        request: &EditCommentRequest,
    ) -> Result<Comment, Error>;
    fn delete_comment(
        &self,
        auth_: &BearerToken,
        comment_rid: &CommentRid,
    ) -> Result<Comment, Error>;
    fn pin_comment(
        &self,
        auth_: &BearerToken,
        comment_rid: &CommentRid,
    ) -> Result<Comment, Error>;
    fn unpin_comment(
        &self,
        auth_: &BearerToken,
        comment_rid: &CommentRid,
    ) -> Result<Comment, Error>;
    fn add_reaction(
        &self,
        auth_: &BearerToken,
        comment_rid: &CommentRid,
        type_: &ReactionType,
    ) -> Result<Comment, Error>;
    fn remove_reaction(
        &self,
        auth_: &BearerToken,
        comment_rid: &CommentRid,
        type_: &ReactionType,
    ) -> Result<Comment, Error>;
}

Comments service manages conversations about resources.

Required Methods

fn get_conversation( &self, auth_: &BearerToken, resource_type: &ResourceType, resource_rid: &ResourceIdentifier, ) -> Result<Conversation, Error>

A conversation is a fully resolved comment tree. It includes all comments for the given resource and all the nested comments/replies to those comments.

fn get_conversation_count( &self, auth_: &BearerToken, resource_type: &ResourceType, resource_rid: &ResourceIdentifier, include_deleted: Option<bool>, ) -> Result<i32, Error>

Returns the number of comments in a conversation.

fn get_comment( &self, auth_: &BearerToken, comment_rid: &CommentRid, ) -> Result<Comment, Error>

Get a comment identified by its RID

fn create_comment( &self, auth_: &BearerToken, request: &CreateCommentRequest, ) -> Result<Comment, Error>

Create a comment on a resource

fn edit_comment( &self, auth_: &BearerToken, comment_rid: &CommentRid, request: &EditCommentRequest, ) -> Result<Comment, Error>

Edit an existing comment

fn delete_comment( &self, auth_: &BearerToken, comment_rid: &CommentRid, ) -> Result<Comment, Error>

Delete an existing comment

fn pin_comment( &self, auth_: &BearerToken, comment_rid: &CommentRid, ) -> Result<Comment, Error>

Pin a comment to the top of the conversation

fn unpin_comment( &self, auth_: &BearerToken, comment_rid: &CommentRid, ) -> Result<Comment, Error>

Unpin a comment from the top of the conversation

fn add_reaction( &self, auth_: &BearerToken, comment_rid: &CommentRid, type_: &ReactionType, ) -> Result<Comment, Error>

Create a reaction on a comment

fn remove_reaction( &self, auth_: &BearerToken, comment_rid: &CommentRid, type_: &ReactionType, ) -> Result<Comment, Error>

Create a reaction on a comment

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl<I, __C> CommentsService<I> for CommentsServiceClient<__C>

where I: Iterator<Item = Result<Bytes, Error>>, __C: Client<ResponseBody = I>,