Class: ActsAsIcontact::Segment

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

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Resource

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

Constructor Details

This class inherits a constructor from ActsAsIcontact::Resource

Dynamic Method Handling

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

Class Method Details

.find_by_string(value) ⇒ Object

Searches on segment name.



20
21
22
 
# File 'lib/acts_as_icontact/resources/segment.rb', line 20

def self.find_by_string(value)
  first(:name => value)
end

.never_on_update ⇒ Object

Cannot pass listId when updating



15
16
17
 
# File 'lib/acts_as_icontact/resources/segment.rb', line 15

def self.never_on_update
  ['listId']
end

.required_on_create ⇒ Object

Name and listId are required



5
6
7
 
# File 'lib/acts_as_icontact/resources/segment.rb', line 5

def self.required_on_create
  super << 'listId' << 'name'
end

.required_on_update ⇒ Object

Name and listId are required



10
11
12
 
# File 'lib/acts_as_icontact/resources/segment.rb', line 10

def self.required_on_update
  super << 'name'
end

Instance Method Details

#criteria(options = {}) ⇒ Object

Returns a collection of SegmentCriteria resources for this segment. The usual iContact search options (limit, offset, search terms, etc.) can be passed.



31
32
33
 
# File 'lib/acts_as_icontact/resources/segment.rb', line 31

def criteria(options={})
  @criteria ||= ActsAsIcontact::SegmentCriteria.scoped_find(self, options)
end

#list ⇒ Object

Returns the list to which this segment is bound.



26
27
28
 
# File 'lib/acts_as_icontact/resources/segment.rb', line 26

def list
  @list ||= ActsAsIcontact::List.find(listId.to_i) if (listId.to_i) > 0
end