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)
```

### 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).
* `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

4 entries across 4 versions & 1 rubygems

Version	Path
files.com-1.1.188	docs/file_comment.md
files.com-1.1.187	docs/file_comment.md
files.com-1.1.186	docs/file_comment.md
files.com-1.1.185	docs/file_comment.md