Class: ActsAsIcontact::Campaign

Inherits:
Resource
  • Object
show all
Defined in:
lib/acts_as_icontact/resources/campaign.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Resource

#==, all, #connection, #error, #errors, find, find_by_id, first, #id, #inspect, #method_missing, #new_record?, #property_names, #save, #save!

Constructor Details

#initialize(properties = {}) ⇒ Campaign

Defaults forwardToFriend to 0; subscriptionManagement, clickTrackMode to true; and useAccountAddress, archiveByDefault to false



5
6
7
8
9
10
11
 
# File 'lib/acts_as_icontact/resources/campaign.rb', line 5

def initialize(properties={})
  super({:forwardToFriend => 0,
         :clickTrackMode => true,
         :subscriptionManagement => true,
         :useAccountAddress => false,
         :archiveByDefault => false}.merge(properties))
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ActsAsIcontact::Resource

Class Method Details

.boolean_fields ⇒ Object

The following can be set with true or false: subscriptionManagement, clickTrackMode, useAccountAddress, archiveByDefault



19
20
21
 
# File 'lib/acts_as_icontact/resources/campaign.rb', line 19

def self.boolean_fields
  super + %w(subscriptionManagement clickTrackMode useAccountAddress archiveByDefault)
end

.required_on_create ⇒ Object

Requires name, fromName, fromEmail, forwardToFriend, subscriptionManagement, clickTrackMode, useAccountAddress, and archiveByDefault



14
15
16
 
# File 'lib/acts_as_icontact/resources/campaign.rb', line 14

def self.required_on_create
  super + %w(name fromName fromEmail forwardToFriend subscriptionManagement clickTrackMode useAccountAddress archiveByDefault)
end

Instance Method Details

#messages(options = {}) ⇒ Object

Returns a collection of all Message resources matching this campaignId. Additional search options can be passed to further restrict the result set.



24
25
26
27
 
# File 'lib/acts_as_icontact/resources/campaign.rb', line 24

def messages(options={})
  search = {:campaignId => id}.merge(options)
  Message.all(search)
end