Sha256: 1ccda327f9097d9b4af1b3874de896abd8d35156bffd0dc4530b73fb3fbe32f1
Contents?: true
Size: 1.9 KB
Versions: 10
Compression:
Stored size: 1.9 KB
Contents
# FileComment
## Example FileComment Object
```
{
"id": 1,
"body": "What a great file!",
"reactions": [
{
"id": 1,
"emoji": "👍"
}
]
}
```
* `id` (int64): File Comment ID
* `body` (string): Comment body.
* `reactions` (array(object)): Reactions to this comment.
* `path` (string): File path.
---
## List File Comments by path
```
Files::FileComment.list_for(path,
per_page: 1,
page: 1
)
```
### Parameters
* `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).
* `action` (string):
* `page` (int64):
* `path` (string): Required - Path to operate on.
---
## Create File Comment
```
Files::FileComment.create(
body: "body",
path: "path"
)
```
### Parameters
* `body` (string): Required - Comment body.
* `path` (string): Required - File path.
---
## Update File Comment
```
Files::FileComment.update(id,
body: "body"
)
```
### Parameters
* `id` (int64): Required - File Comment ID.
* `body` (string): Required - Comment body.
---
## Delete File Comment
```
Files::FileComment.delete(id)
```
### Parameters
* `id` (int64): Required - File Comment ID.
---
## Update File Comment
```
file_comment = Files::FileComment.list.first
file_comment.update(
body: "body"
)
```
### Parameters
* `id` (int64): Required - File Comment ID.
* `body` (string): Required - Comment body.
---
## Delete File Comment
```
file_comment = Files::FileComment.list.first
file_comment.delete
```
### Parameters
* `id` (int64): Required - File Comment ID.
Version data entries
10 entries across 10 versions & 1 rubygems