Sha256: 6cd83676c2692c6e98146b4f2599e01b0ad13b0293bed7416fe817839d96ea4b

Contents?: true

Size: 1.14 KB

Versions: 9

Compression:

Stored size: 1.14 KB

Contents

# Preview

## Example Preview Object

```
{
  "status": "complete",
  "download_uri": "https://mysite.files.com/...",
  "id": 1,
  "type": "complete",
  "size": 1024
}
```

* `status` (string): Preview status.  Can be invalid, not_generated, generating, complete, or file_too_large
* `download_uri` (string): Link to download preview
* `id` (int64): Preview ID
* `type` (string): Preview status.  Can be invalid, not_generated, generating, complete, or file_too_large
* `size` (int64): Preview size


---

## Show many previews at once

```
Files::Preview.list(
  page: 1, 
  per_page: 1, 
  ids: "ids", 
  size: "large"
)
```

### Parameters

* `page` (int64): Current page number.
* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
* `ids` (string): Required - Preview IDs.  Comma delimited.
* `size` (string): Preview Size


---

## Show Preview

```
Files::Preview.find(id, 
  size: "large"
)
```

### Parameters

* `id` (int64): Required - Preview ID.
* `size` (string): Preview Size

Version data entries

9 entries across 9 versions & 1 rubygems

Version Path
files.com-1.0.15 docs/preview.md
files.com-1.0.14 docs/preview.md
files.com-1.0.13 docs/preview.md
files.com-1.0.12 docs/preview.md
files.com-1.0.11 docs/preview.md
files.com-1.0.10 docs/preview.md
files.com-1.0.9 docs/preview.md
files.com-1.0.8 docs/preview.md
files.com-1.0.7 docs/preview.md