Sha256: 10ba0d74009a8d491da1699c07265b3b66e00e03104649fe3960917c086da9f3
Contents?: true
Size: 1.64 KB
Versions: 6
Compression:
Stored size: 1.64 KB
Contents
# FileComment
## Example FileComment Object
```
{
"id": 1,
"body": "What a great file!",
"reactions": [
]
}
```
* `id` (int64): File Comment ID
* `body` (string): Comment body.
* `reactions` (array): Reactions to this comment.
* `path` (string): File path.
---
## List File Comments by path
```
Files::FileComment.list_for(path,
per_page: 1
)
```
### Parameters
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
* `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_for(path).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_for(path).first
file_comment.delete
```
### Parameters
* `id` (int64): Required - File Comment ID.
Version data entries
6 entries across 6 versions & 1 rubygems