Class: ActionKitApi::Page
- Inherits:
-
ApiDataModel
- Object
- ApiDataModel
- ActionKitApi::Page
- Includes:
- Searchable
- Defined in:
- lib/action_kit_api/page.rb
Overview
Please note that this class should almost never be directly called every ‘real’ page is a specific sub-page type that should extend this class. Please refer to the ActionKit API documentation for more information about pages
Direct Known Subclasses
Instance Attribute Summary collapse
-
#goal ⇒ Object
Other/Active.
-
#goal_type ⇒ Object
Other/Active.
-
#id ⇒ Object
Required.
-
#lang ⇒ Object
Other/Active.
-
#list ⇒ Object
Other/Active.
-
#name ⇒ Object
Required.
-
#required_fields ⇒ Object
Other/Active.
-
#status ⇒ Object
Other/Active.
-
#tags ⇒ Object
Other/Active.
-
#title ⇒ Object
Required.
-
#type ⇒ Object
Required.
-
#url ⇒ Object
Other/Active.
Instance Method Summary collapse
-
#initialize(*args) ⇒ Page
constructor
A new instance of Page.
Methods included from Searchable
Methods inherited from ApiDataModel
#save, #to_hash, #update, #valid?
Constructor Details
#initialize(*args) ⇒ Page
Returns a new instance of Page.
18 19 20 21 |
# File 'lib/action_kit_api/page.rb', line 18 def initialize(*args) @required_attrs = [:name, :title, :type] super end |
Instance Attribute Details
#goal ⇒ Object
Other/Active
15 16 17 |
# File 'lib/action_kit_api/page.rb', line 15 def goal @goal end |
#goal_type ⇒ Object
Other/Active
15 16 17 |
# File 'lib/action_kit_api/page.rb', line 15 def goal_type @goal_type end |
#id ⇒ Object
Required
12 13 14 |
# File 'lib/action_kit_api/page.rb', line 12 def id @id end |
#lang ⇒ Object
Other/Active
15 16 17 |
# File 'lib/action_kit_api/page.rb', line 15 def lang @lang end |
#list ⇒ Object
Other/Active
15 16 17 |
# File 'lib/action_kit_api/page.rb', line 15 def list @list end |
#name ⇒ Object
Required
12 13 14 |
# File 'lib/action_kit_api/page.rb', line 12 def name @name end |
#required_fields ⇒ Object
Other/Active
15 16 17 |
# File 'lib/action_kit_api/page.rb', line 15 def required_fields @required_fields end |
#status ⇒ Object
Other/Active
15 16 17 |
# File 'lib/action_kit_api/page.rb', line 15 def status @status end |
#tags ⇒ Object
Other/Active
15 16 17 |
# File 'lib/action_kit_api/page.rb', line 15 def @tags end |
#title ⇒ Object
Required
12 13 14 |
# File 'lib/action_kit_api/page.rb', line 12 def title @title end |
#type ⇒ Object
Required
12 13 14 |
# File 'lib/action_kit_api/page.rb', line 12 def type @type end |
#url ⇒ Object
Other/Active
15 16 17 |
# File 'lib/action_kit_api/page.rb', line 15 def url @url end |