Text Comment

Create a text comment by passing a reference target and text body to the comment repository. To create a reply, pass the parent comment ID with the same reference target.

Parameters

Parameter	Required	Description
`referenceId`	Yes	ID of the post, story, or custom content item being commented on
`referenceType`	Yes	Use `post`, `story`, or `content`
`text`	Yes	Text body of the comment
`parentId`	No	Existing comment ID when creating a reply
`metadata`	No	Custom metadata attached to the comment
`mentionees` / mention builder	No	User mention payloads
`links`	No	Link metadata on TypeScript, iOS, and Android

The current Flutter public comment creation builder exposes metadata(...) and mentionUsers(...), but it does not expose a links(...) method.

Create a Text Comment

Create a top-level text comment with the reference target and text body.

import { CommentRepository } from "@amityco/ts-sdk";

const { data: comment } = await CommentRepository.createComment({
  referenceId: postId,
  referenceType: "post",
  data: {
    text: "Hello world!",
  },
});

renderResults(comment);

let options = AmityCommentCreateOptions(
    referenceId: "post-id",
    referenceType: .post,
    text: "Hello world!"
)

let comment = try await commentRepository.createComment(with: options)
showSuccessMessage(comment.commentId)

AmitySocialClient.newCommentRepository()
    .createComment()
    .post(postId = postId)
    .with()
    .text(text = "Hello world!")
    .build()
    .send()
    .subscribe(
        { comment -> showSuccessMessage(comment.getCommentId()) },
        { error -> handleGeneralError(error) }
    )

final comment = await AmitySocialClient.newCommentRepository()
    .createComment()
    .post(postId)
    .create()
    .text('Hello world!')
    .send();

final commentId = comment.commentId;

Reply to a Comment

Replies use the same creation API with parentId set to the comment being replied to.

import { CommentRepository } from "@amityco/ts-sdk";

const { data: reply } = await CommentRepository.createComment({
  referenceId: postId,
  referenceType: "post",
  parentId: commentId,
  data: {
    text: "Replying to this comment",
  },
});

renderResults(reply);

let options = AmityCommentCreateOptions(
    referenceId: "post-id",
    referenceType: .post,
    text: "Replying to this comment",
    parentId: "parent-comment-id"
)

let reply = try await commentRepository.createComment(with: options)
showSuccessMessage(reply.commentId)

AmitySocialClient.newCommentRepository()
    .createComment()
    .post(postId = postId)
    .parentId(parentId = commentId)
    .with()
    .text(text = "Replying to this comment")
    .build()
    .send()
    .subscribe(
        { reply -> showSuccessMessage(reply.getCommentId()) },
        { error -> handleGeneralError(error) }
    )

final reply = await AmitySocialClient.newCommentRepository()
    .createComment()
    .post(postId)
    .parentId(commentId)
    .create()
    .text('Replying to this comment')
    .send();

final replyId = reply.commentId;

Notes

Keep the same referenceId and referenceType as the thread you are replying in.
Use query APIs or live collections to display creation and sync state in the UI.
Validate your product’s text limits and moderation rules before calling the SDK.
Build mention payloads from the user IDs your mention picker returns.

Image Comment

Create comments with uploaded image attachments.

Query Comments

Query top-level comments and reply threads.

Powered by

Getting Started

Fundamentals

Social

Chat

Video

Release Notes

Migration Guides

Support

Parameters

Create a Text Comment

Reply to a Comment

Notes

Image Comment

Query Comments

​Parameters

​Create a Text Comment

​Reply to a Comment

​Notes

​Related Topics

Image Comment

Query Comments

Parameters

Create a Text Comment

Reply to a Comment

Notes

Related Topics