files.com
Version:
Files.com SDK for JavaScript
119 lines (82 loc) • 2.32 kB
Markdown
# MessageComment
## Example MessageComment Object
```
{
"id": 1,
"body": "What a great idea, thank you!",
"reactions": [
{
"id": 1,
"emoji": "👍"
}
]
}
```
* `id` (int64): Message Comment ID
* `body` (string): Comment body.
* `reactions` (array(object)): Reactions to this comment.
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
## List Message Comments
```
await MessageComment.list({
'user_id': 1,
'message_id': 1,
})
```
### Parameters
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
* `message_id` (int64): Required - Message comment to return comments for.
## Show Message Comment
```
await MessageComment.find(id)
```
### Parameters
* `id` (int64): Required - Message Comment ID.
## Create Message Comment
```
await MessageComment.create({
'user_id': 1,
'body': "body",
})
```
### Parameters
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
* `body` (string): Required - Comment body.
## Update Message Comment
```
const message_comment = await MessageComment.find(id)
await message_comment.update({
'body': "body",
})
```
### Parameters
* `id` (int64): Required - Message Comment ID.
* `body` (string): Required - Comment body.
### Example Response
```json
{
"id": 1,
"body": "What a great idea, thank you!",
"reactions": [
{
"id": 1,
"emoji": "👍"
}
]
}
```
## Delete Message Comment
```
const message_comment = await MessageComment.find(id)
await message_comment.delete()
```
### Parameters
* `id` (int64): Required - Message Comment ID.