Comments Overview

Use the comment repository when you need discussions on posts, stories, or custom content. Comment creation supports text, optional image attachments, metadata, user mentions, and replies through parentId.

A reply is a normal comment with parentId set to another comment ID. There is no separate reply API in the SDK.

Comment Targets

Reference type	Use it for	SDK value
Post	Comments on Social posts	`post` / `.post` / `POST`
Story	Comments on story content	`story` / `.story` / `STORY`
Content	Comments on your own external content IDs	`content` / `.content` / `CONTENT`

Comment Shape

The exact property names vary by platform, but the SDK model centers on the same fields.

Concept	TypeScript	iOS	Android	Flutter
Comment ID	`comment.commentId`	`comment.commentId`	`comment.getCommentId()`	`comment.commentId`
Parent comment	`comment.parentId`	`comment.parentId`	`comment.getParentId()`	`comment.parentId`
Reference	`referenceId`, `referenceType`	`referenceId`, `referenceType`	`comment.getReference()`	`referenceId`, `referenceType`
Text data	`comment.data.text`	`comment.data` text value	`comment.getData()`	`comment.data`
Image attachments	`comment.attachments`	`comment.attachments`	`comment.getAttachments()`	`comment.attachments`
Reply count	`childrenNumber`	`childrenNumber`	`getChildCount()`	`childrenNumber`
Reactions	`reactions`, `myReactions`	reaction properties on comment	`getReactionCount()`, `getMyReactions()`	`reactionCount`, `myReactions`
Moderation	`isDeleted`, flags	`isDeleted`, flags	`isDeleted()`, flags	`isDeleted`, flags

Creation APIs

Platform	Repository entry point	Text comment	Image comment
TypeScript	`CommentRepository.createComment(...)`	`data: { text }`	`attachments: [{ type: "image", fileId }]`
iOS	`AmityCommentRepository().createComment(with:)`	`AmityCommentCreateOptions(text:)`	`attachments: [.image(fileId:)]`
Android	`commentRepository.createComment()`	`.with().text(...).build().send()`	`.with().attachments(...).build().send()`
Flutter	`AmitySocialClient.newCommentRepository().createComment()`	`.create().text(...).send()`	`.create().attachments(...).send()`

Upload image files first, then pass the uploaded image file IDs to the comment creation API. Comment creation does not upload local files by itself.

Powered by

Getting Started

Fundamentals

Social

Chat

Video

Release Notes

Migration Guides

Support

Comment Targets

Comment Shape

Creation APIs

Text Comment

Image Comment

Query Comments

Comment Actions

​Comment Targets

​Comment Shape

​Creation APIs

​Related Topics

Text Comment

Image Comment

Query Comments

Comment Actions

Comment Targets

Comment Shape

Creation APIs

Related Topics