Class: Files::Priority

Inherits:
Object
  • Object
show all
Defined in:
lib/files.com/models/priority.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}, options = {}) ⇒ Priority

Returns a new instance of Priority.



7
8
9
10
 
# File 'lib/files.com/models/priority.rb', line 7

def initialize(attributes = {}, options = {})
  @attributes = attributes || {}
  @options = options || {}
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



5
6
7
 
# File 'lib/files.com/models/priority.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/files.com/models/priority.rb', line 5

def options
  @options
end

Class Method Details

.all(path, params = {}, options = {}) ⇒ Object 



39
40
41
 
# File 'lib/files.com/models/priority.rb', line 39

def self.all(path, params = {}, options = {})
  list(path, params, options)
end

.list(path, params = {}, options = {}) ⇒ Object

Parameters:

cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
path (required) - string - The path to query for priorities

Raises:



26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/files.com/models/priority.rb', line 26

def self.list(path, params = {}, options = {})
  params ||= {}
  params[:path] = path
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
  raise MissingParameterError.new("Parameter missing: path") unless params[:path]

  List.new(Priority, params) do
    Api.send_request("/priorities", :get, params, options)
  end
end

Instance Method Details

#color ⇒ Object

string - The priority color



18
19
20
 
# File 'lib/files.com/models/priority.rb', line 18

def color
  @attributes[:color]
end

#path ⇒ Object

string - The path corresponding to the priority color. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.



13
14
15
 
# File 'lib/files.com/models/priority.rb', line 13

def path
  @attributes[:path]
end