Class: Files::BlogPost
- Inherits:
-
Object
- Object
- Files::BlogPost
- Defined in:
- lib/files.com/models/blog_post.rb
Instance Attribute Summary collapse
-
#attributes ⇒ Object
readonly
Returns the value of attribute attributes.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
Class Method Summary collapse
- .all(params = {}, options = {}) ⇒ Object
-
.list(params = {}, options = {}) ⇒ Object
Parameters: page - integer - Current page number.
Instance Method Summary collapse
-
#content ⇒ Object
string - Blog Post’s Content.
-
#initialize(attributes = {}, options = {}) ⇒ BlogPost
constructor
A new instance of BlogPost.
-
#link ⇒ Object
date-time - Blog Post’s Permanent Link.
-
#published_at ⇒ Object
date-time - Blog Post’s Published Date.
-
#title ⇒ Object
string - Blog Post’s Title.
Constructor Details
#initialize(attributes = {}, options = {}) ⇒ BlogPost
Returns a new instance of BlogPost.
7 8 9 10 |
# File 'lib/files.com/models/blog_post.rb', line 7 def initialize(attributes = {}, = {}) @attributes = attributes || {} @options = || {} end |
Instance Attribute Details
#attributes ⇒ Object (readonly)
Returns the value of attribute attributes.
5 6 7 |
# File 'lib/files.com/models/blog_post.rb', line 5 def attributes @attributes end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
5 6 7 |
# File 'lib/files.com/models/blog_post.rb', line 5 def @options end |
Class Method Details
.all(params = {}, options = {}) ⇒ Object
45 46 47 |
# File 'lib/files.com/models/blog_post.rb', line 45 def self.all(params = {}, = {}) list(params, ) 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.
36 37 38 39 40 41 42 43 |
# File 'lib/files.com/models/blog_post.rb', line 36 def self.list(params = {}, = {}) 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, = Api.send_request("/blog_posts", :get, params, ) response.data.map { |object| BlogPost.new(object, ) } end |
Instance Method Details
#content ⇒ Object
string - Blog Post’s Content
13 14 15 |
# File 'lib/files.com/models/blog_post.rb', line 13 def content @attributes[:content] end |
#link ⇒ Object
date-time - Blog Post’s Permanent Link
18 19 20 |
# File 'lib/files.com/models/blog_post.rb', line 18 def link @attributes[:link] end |
#published_at ⇒ Object
date-time - Blog Post’s Published Date
23 24 25 |
# File 'lib/files.com/models/blog_post.rb', line 23 def published_at @attributes[:published_at] end |
#title ⇒ Object
string - Blog Post’s Title
28 29 30 |
# File 'lib/files.com/models/blog_post.rb', line 28 def title @attributes[:title] end |