Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs #75

Merged
merged 3 commits into from
Mar 4, 2021
Merged

Update docs #75

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b8fb0ec
Improve documentation for deletion and filelink
oojewale Feb 28, 2021
2a74c74
Improve documentation for deletion and filelink
oojewale Feb 28, 2021
da32f31
Merge pull request #73 from oojewale/contrib/add-deletion-to-docs
Mar 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,19 @@ client = FilestackClient.new('YOUR_API_KEY', security: security)
### Using FilestackFilelinks
FilestackFilelink objects are representation of a file handle. You can download, get raw file content, delete and overwrite file handles directly. Security is required for overwrite and delete methods.

Initialize the filelink using the file handle, your API key, and security if required. The file handle is the string following the last slash `/` in the file URL.

```ruby
filelink = FilestackFilelink.new(handle, apikey: 'YOUR_API_KEY', security: security_object)
```

### Deletion
You can delete a file by simply calling `delete` on the filelink.

```ruby
filelink.delete
```

### Transformations
Transforms can be initiated one of two ways. The first, by calling ```transform``` on a filelink:

Expand Down