Class: Files::Inbox

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Inbox.



7
8
9
10
 
# File 'lib/files.com/models/inbox.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/inbox.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

Class Method Details

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



50
51
52
 
# File 'lib/files.com/models/inbox.rb', line 50

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

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

Parameters:

page - integer - Current page number.
per_page - integer - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.

Raises:



41
42
43
44
45
46
47
48
 
# File 'lib/files.com/models/inbox.rb', line 41

def self.list(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)

  response, options = Api.send_request("/inboxes", :get, params, options)
  response.data.map { |object| Inbox.new(object, options) }
end

Instance Method Details

#description ⇒ Object

string - User description



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

def description
  @attributes[:description]
end

#help_text ⇒ Object

string - Text that will be shown to the users on the Inbox. Use this field to provide custom instructions.



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

def help_text
  @attributes[:help_text]
end

#key ⇒ Object

string - Unique key for inbox



23
24
25
 
# File 'lib/files.com/models/inbox.rb', line 23

def key
  @attributes[:key]
end

#show_on_login_page ⇒ Object

boolean - Show this inbox on site login page?



28
29
30
 
# File 'lib/files.com/models/inbox.rb', line 28

def 
  @attributes[:show_on_login_page]
end

#title ⇒ Object

string - Inbox title



33
34
35
 
# File 'lib/files.com/models/inbox.rb', line 33

def title
  @attributes[:title]
end