Skip to content

Commit

Permalink
Merge pull request #73 from oojewale/contrib/add-deletion-to-docs
Browse files Browse the repository at this point in the history
Contrib/add deletion to docs
  • Loading branch information
Gabi Fijalkowska-Papier committed Mar 4, 2021
2 parents 7885cfd + 2a74c74 commit da32f31
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
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

0 comments on commit da32f31

Please sign in to comment.