Class: Uploadcare::Client::FileTagsAccessor

Inherits:
Object
  • Object
show all
Defined in:
lib/uploadcare/client/file_tags_accessor.rb

Overview

Per-file tag operations scoped to a client instance.

Examples:

Replace and update tags

client.file_tags.replace(uuid: file.uuid, tags: %w[approved summer])
client.file_tags.update(uuid: file.uuid, add: ["featured"], delete: ["summer"])

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ FileTagsAccessor

Returns a new instance of FileTagsAccessor.

Parameters:



12
13
14
 
# File 'lib/uploadcare/client/file_tags_accessor.rb', line 12

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



9
10
11
 
# File 'lib/uploadcare/client/file_tags_accessor.rb', line 9

def client
  @client
end

Instance Method Details

#list(uuid:, request_options: {}) ⇒ Array<String> Also known as: index

Parameters:

  • uuid (String)
  • request_options (Hash) (defaults to: {})

Returns:

  • (Array<String>) 


19
20
21
 
# File 'lib/uploadcare/client/file_tags_accessor.rb', line 19

def list(uuid:, request_options: {})
  Uploadcare::Resources::FileTags.list(uuid: uuid, client: client, request_options: request_options)
end

#replace(uuid:, tags:, request_options: {}) ⇒ Uploadcare::Resources::FileTags

Parameters:

  • uuid (String)
  • tags (Array<String>)
  • request_options (Hash) (defaults to: {})

Returns:



28
29
30
31
32
 
# File 'lib/uploadcare/client/file_tags_accessor.rb', line 28

def replace(uuid:, tags:, request_options: {})
  Uploadcare::Resources::FileTags.replace(
    uuid: uuid, tags: tags, client: client, request_options: request_options
  )
end

#update(uuid:, add: [], delete: [], request_options: {}) ⇒ Uploadcare::Resources::FileTags

Parameters:

  • uuid (String)
  • add (Array<String>) (defaults to: [])
  • delete (Array<String>) (defaults to: [])
  • request_options (Hash) (defaults to: {})

Returns:



39
40
41
42
43
 
# File 'lib/uploadcare/client/file_tags_accessor.rb', line 39

def update(uuid:, add: [], delete: [], request_options: {})
  Uploadcare::Resources::FileTags.update(
    uuid: uuid, add: add, delete: delete, client: client, request_options: request_options
  )
end