Class: Files::App

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of App.



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

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

Class Method Details

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



130
131
132
 
# File 'lib/files.com/models/app.rb', line 130

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

.list(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).
sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name` and `app_type`.
filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.

Raises:



118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/files.com/models/app.rb', line 118

def self.list(params = {}, options = {})
  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: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)

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

Instance Method Details

#app_type ⇒ Object

string - The type of the App



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

def app_type
  @attributes[:app_type]
end

#documentation_links ⇒ Object

object - Collection of named links to documentation



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

def documentation_links
  @attributes[:documentation_links]
end

#extended_description ⇒ Object

string - Long description for the in-App landing page



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

def extended_description
  @attributes[:extended_description]
end

#extended_description_for_marketing_site ⇒ Object

string - Long form description of the App



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

def extended_description_for_marketing_site
  @attributes[:extended_description_for_marketing_site]
end

#external_homepage_url ⇒ Object

string - Link to external homepage



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

def external_homepage_url
  @attributes[:external_homepage_url]
end

#featured ⇒ Object

boolean - Is featured on the App listing?



38
39
40
 
# File 'lib/files.com/models/app.rb', line 38

def featured
  @attributes[:featured]
end

#folder_behavior_type ⇒ Object

string - Associated Folder Behavior type, if any



43
44
45
 
# File 'lib/files.com/models/app.rb', line 43

def folder_behavior_type
  @attributes[:folder_behavior_type]
end

#icon_url ⇒ Object

string - App icon



48
49
50
 
# File 'lib/files.com/models/app.rb', line 48

def icon_url
  @attributes[:icon_url]
end

#logo_thumbnail_url ⇒ Object

string - Logo thumbnail for the App



53
54
55
 
# File 'lib/files.com/models/app.rb', line 53

def logo_thumbnail_url
  @attributes[:logo_thumbnail_url]
end

#logo_url ⇒ Object

string - Full size logo for the App



58
59
60
 
# File 'lib/files.com/models/app.rb', line 58

def logo_url
  @attributes[:logo_url]
end

#marketing_intro ⇒ Object

string - Marketing introdution of the App



63
64
65
 
# File 'lib/files.com/models/app.rb', line 63

def marketing_intro
  @attributes[:marketing_intro]
end

#marketing_youtube_url ⇒ Object

string - Marketing video page



68
69
70
 
# File 'lib/files.com/models/app.rb', line 68

def marketing_youtube_url
  @attributes[:marketing_youtube_url]
end

#name ⇒ Object

string - Name of the App



73
74
75
 
# File 'lib/files.com/models/app.rb', line 73

def name
  @attributes[:name]
end

#package_manager_install_command ⇒ Object

string - Package manager install command



78
79
80
 
# File 'lib/files.com/models/app.rb', line 78

def package_manager_install_command
  @attributes[:package_manager_install_command]
end

#remote_server_type ⇒ Object

string - Associated Remote Server type, if any



83
84
85
 
# File 'lib/files.com/models/app.rb', line 83

def remote_server_type
  @attributes[:remote_server_type]
end

#screenshot_list_urls ⇒ Object

array(string) - Screenshots of the App



88
89
90
 
# File 'lib/files.com/models/app.rb', line 88

def screenshot_list_urls
  @attributes[:screenshot_list_urls]
end

#sdk_installation_instructions_link ⇒ Object

string - Link to SDK installation instructions



93
94
95
 
# File 'lib/files.com/models/app.rb', line 93

def sdk_installation_instructions_link
  @attributes[:sdk_installation_instructions_link]
end

#short_description ⇒ Object

string - Short description of the App



98
99
100
 
# File 'lib/files.com/models/app.rb', line 98

def short_description
  @attributes[:short_description]
end

#sso_strategy_type ⇒ Object

string - Associated SSO Strategy type, if any



103
104
105
 
# File 'lib/files.com/models/app.rb', line 103

def sso_strategy_type
  @attributes[:sso_strategy_type]
end

#tutorial_youtube_url ⇒ Object

string - Tutorial video page



108
109
110
 
# File 'lib/files.com/models/app.rb', line 108

def tutorial_youtube_url
  @attributes[:tutorial_youtube_url]
end