Interface ICommentCreationBuilder

An interface that defines all the steps necessary to build a CommentCreation object.

Namespace: Unity.Cloud.Annotation.Runtime

Syntax

public interface ICommentCreationBuilder

Examples

public async Task<IComment> CreateCommentOnTopic(ITopic topic,
    string commentText)
{
    ICommentCreationBuilder commentCreationBuilder = new CommentCreationBuilder();
    commentCreationBuilder.SetText(commentText);

    ICommentCreation commentCreation = commentCreationBuilder.GetCommentCreation();
    IComment createdComment = await topic.CreateCommentAsync(commentCreation);

    return createdComment;
}

Methods

GetCommentCreation()

Returns the instance of the CommentCreation that is being built.

Declaration

ICommentCreation GetCommentCreation()

Returns

Type	Description
ICommentCreation	The instance of the CommentCreation that is being built.

Examples

public ICommentCreation GetCommentCreation(string commentText)
{
    ICommentCreationBuilder commentCreationBuilder = new CommentCreationBuilder();

    commentCreationBuilder.SetText(commentText);

    return commentCreationBuilder.GetCommentCreation();
}

SetText(String)

Assigns a value to the Text property of the CommentCreation that is being built.

Declaration

ICommentCreationBuilder SetText(string text)

Parameters

Type	Name	Description
String	text	The new Text value.

Returns

Type	Description
ICommentCreationBuilder	The current instance of the ICommentCreationBuilder interface.

Examples

public async Task<IComment> CreateCommentOnTopic(ITopic topic,
    string commentText)
{
    ICommentCreationBuilder commentCreationBuilder = new CommentCreationBuilder();
    commentCreationBuilder.SetText(commentText);

    ICommentCreation commentCreation = commentCreationBuilder.GetCommentCreation();
    IComment createdComment = await topic.CreateCommentAsync(commentCreation);

    return createdComment;
}