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

EventCreatePage, EventSignupPage, PetitionPage, SignupPage, UnsubscribePage

Instance Attribute Summary

• #canonical_url ⇒ Object

  Other/Active.

• #custom_fields ⇒ Object

  Other/Active.

• #goal ⇒ Object

  Other/Active.

• #goal_type ⇒ Object

  Other/Active.

• #hidden ⇒ Object

  Other/Active.

• #hosted_with ⇒ Object

  Other/Active.

• #id ⇒ Object

  Required.

• #lang ⇒ Object

  Other/Active.

• #list ⇒ Object

  Other/Active.

• #multilingual_campaign ⇒ 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.

Attributes inherited from ApiDataModel

#created_at, #updated_at

Instance Method Summary

• #initialize(*args) ⇒ Page constructor

  A new instance of Page.

Methods included from Searchable

included

Methods inherited from ApiDataModel

#safe_hash, #save, #to_hash, #update, #valid?

Constructor Details

#initialize(*args) ⇒ Page

Returns a new instance of Page.

# File 'lib/action_kit_api/page.rb', line 19

def initialize(*args)
  @required_attrs ||= []
  @required_attrs.concat([:name, :title, :type])

  @read_only_attrs ||= []
  @read_only_attrs.concat([:hosted_with])

  super
end

Instance Attribute Details

#canonical_url ⇒ Object

Other/Active

# File 'lib/action_kit_api/page.rb', line 15

def canonical_url
  @canonical_url
end

#custom_fields ⇒ Object

Other/Active

# File 'lib/action_kit_api/page.rb', line 15

def custom_fields
  @custom_fields
end

#goal ⇒ Object

Other/Active

# File 'lib/action_kit_api/page.rb', line 15

def goal
  @goal
end

#goal_type ⇒ Object

Other/Active

# File 'lib/action_kit_api/page.rb', line 15

def goal_type
  @goal_type
end

#hidden ⇒ Object

Other/Active

# File 'lib/action_kit_api/page.rb', line 15

def hidden
  @hidden
end

#hosted_with ⇒ Object

Other/Active

# File 'lib/action_kit_api/page.rb', line 15

def hosted_with
  @hosted_with
end

#id ⇒ Object

Required

# File 'lib/action_kit_api/page.rb', line 12

def id
  @id
end

#lang ⇒ Object

Other/Active

# File 'lib/action_kit_api/page.rb', line 15

def lang
  @lang
end

#list ⇒ Object

Other/Active

# File 'lib/action_kit_api/page.rb', line 15

def list
  @list
end

#multilingual_campaign ⇒ Object

Other/Active

# File 'lib/action_kit_api/page.rb', line 15

def multilingual_campaign
  @multilingual_campaign
end

#name ⇒ Object

Required

# File 'lib/action_kit_api/page.rb', line 12

def name
  @name
end

#required_fields ⇒ Object

Other/Active

# File 'lib/action_kit_api/page.rb', line 15

def required_fields
  @required_fields
end

#status ⇒ Object

Other/Active

# File 'lib/action_kit_api/page.rb', line 15

def status
  @status
end

#tags ⇒ Object

Other/Active

# File 'lib/action_kit_api/page.rb', line 15

def tags
  @tags
end

#title ⇒ Object

Required

# File 'lib/action_kit_api/page.rb', line 12

def title
  @title
end

#type ⇒ Object

Required

# File 'lib/action_kit_api/page.rb', line 12

def type
  @type
end

#url ⇒ Object

Other/Active

# File 'lib/action_kit_api/page.rb', line 15

def url
  @url
end