Post
VARIABLE | TYPE | DESCRIPTION | OPTIONAL |
---|---|---|---|
id | String | Unique ID of the post. | |
text | String | Text content of the post. | |
attachments | Attachment[] | List of attached medias in the post. Maximum size is 10. | ✔ |
communityId | Int | Unique ID of the community. | |
isLiked | Bool | true if the user has liked the post, false otherwise. | |
isEdited | Bool | true if the post was edited, false otherwise. | |
isPinned | Bool | true if the post is pinned, false otherwise. | |
userId | String | Unique ID of post creator. | |
uuid | String | Unique ID of post creator. creator. | |
likesCount | Int | Number of users that liked the post. | |
commentsCount | Int | Number of users that commented on the post. | |
isSaved | Bool | true if the user has saved the post, false otherwise. | |
menuItems | MenuItem[] | List of actions as menu items on the post. | |
replies | Comment[] | List of comments on the post. | ✔ |
createdAt | Int | Timestamp when the post was created. | |
updatedAt | Int | Timestamp when the post was last updated. | |
heading | String | Heading of the post. | ✔ |
tempId | String | Temporary ID of post. | ✔ |
topicIds | String[] | List of ids of the topics added in the post. | ✔ |
Attachment
VARIABLE | TYPE | DESCRIPTION | OPTIONAL |
---|---|---|---|
attachmentType | Int | Type of attachment. 1 - Image 2 - Video 3 - Document 4 - Link 6 - Poll | |
attachmentMeta | AttachmentMeta | Download url of attachment. |
AttachmentMeta
VARIABLE | TYPE | DESCRIPTION | OPTIONAL |
---|---|---|---|
name | String | Name of the attachment. | ✔ |
url | String | Download url of attachment. | ✔ |
format | String | Format of attachment (pdf, etc.). | ✔ |
size | Int | Size of attachment in bytes. | ✔ |
duration | Int | Duration of video attachment in seconds. | ✔ |
pageCount | Int | Number of pages in pdf attachment. | ✔ |
ogTags | OGTags | OGTags for link type attachment. | |
thumbnailUrl | String | Thumbnail url for the attached media. | ✔ |
attachmentUrl | String | URL of the attachment. | ✔ |
coverImageUrl | String | URL of the cover image. | ✔ |
title | String | Title of the attachment. | ✔ |
body | String | Body text of the attachment. | ✔ |
entityID | String | Unique identifier for the entity. | ✔ |
expiryTime | Int | Expiration time of the attachment. | ✔ |
pollOptions | [String] | List of options for a poll. | ✔ |
multiSelectState | String | State of multi-select for polls. Default: "exactly" | ✔ |
pollType | String | Type of poll. Default: "instant" | ✔ |
multSelectNo | Int | Number of options that can be selected. Default: 1 | ✔ |
isAnonymous | Bool | Whether the poll is anonymous. Default: false | ✔ |
allowAddOptions | Bool | Whether users can add options. Default: false | ✔ |
height | Int | Height of image/video. | ✔ |
width | Int | Width of image/video. | ✔ |
OGTags
VARIABLE | TYPE | DESCRIPTION | OPTIONAL |
---|---|---|---|
title | String | Link title. | ✔ |
image | String | Link image url. | ✔ |
description | String | Link description. | ✔ |
url | String | Link url. | ✔ |
MenuItem
VARIABLE | TYPE | DESCRIPTION | OPTIONAL |
---|---|---|---|
id | Int | ID of the menu item. | |
title | String | Title of the menu item. |