Class: Uploadcare::Rails::Api::Rest::FileMetadataApi

Inherits:

Base

• Object
• Base
• Uploadcare::Rails::Api::Rest::FileMetadataApi

Defined in:

lib/uploadcare/rails/api/rest/file_metadata_api.rb

Overview

A class that contains FileMetadata related methods for Uploadcare REST API

Class Method Summary

• .delete_file_metadata(uuid, key) ⇒ Object

  Delete a file’s metadata key.

• .file_metadata(uuid) ⇒ Object

  Get file’s metadata keys and values.

• .file_metadata_value(uuid, key) ⇒ Object

  Get the value of a single metadata key.

• .update_file_metadata(uuid, key, value) ⇒ Object

  Update the value of a single metadata key.

Class Method Details

.delete_file_metadata(uuid, key) ⇒ Object

Delete a file’s metadata key

See Also:

• https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/deleteFileMetadataKey

# File 'lib/uploadcare/rails/api/rest/file_metadata_api.rb', line 32

def delete_file_metadata(uuid, key)
  Uploadcare::FileMetadata.delete(uuid, key)
end

.file_metadata(uuid) ⇒ Object

Get file’s metadata keys and values

See Also:

• https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/fileMetadata

# File 'lib/uploadcare/rails/api/rest/file_metadata_api.rb', line 14

def file_metadata(uuid)
  Uploadcare::FileMetadata.index(uuid)
end

.file_metadata_value(uuid, key) ⇒ Object

Get the value of a single metadata key

See Also:

• https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/fileMetadataKey

# File 'lib/uploadcare/rails/api/rest/file_metadata_api.rb', line 20

def file_metadata_value(uuid, key)
  Uploadcare::FileMetadata.show(uuid, key)
end

.update_file_metadata(uuid, key, value) ⇒ Object

Update the value of a single metadata key. If the key does not exist, it will be created

See Also:

• https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/updateFileMetadataKey

# File 'lib/uploadcare/rails/api/rest/file_metadata_api.rb', line 26

def update_file_metadata(uuid, key, value)
  Uploadcare::FileMetadata.update(uuid, key, value)
end