Class: Mailchimp::Gallery

Inherits:

Object

• Object
• Mailchimp::Gallery

Defined in:

lib/mailchimp/api.rb

Instance Attribute Summary

• #master ⇒ Object

  Returns the value of attribute master.

Instance Method Summary

• #initialize(master) ⇒ Gallery constructor

  A new instance of Gallery.

• #list(opts = []) ⇒ Hash

  Return a section of the image gallery.

Constructor Details

#initialize(master) ⇒ Gallery

Returns a new instance of Gallery.

# File 'lib/mailchimp/api.rb', line 2101

def initialize(master)
    @master = master
end

Instance Attribute Details

#master ⇒ Object

Returns the value of attribute master.

# File 'lib/mailchimp/api.rb', line 2099

def master
  @master
end

Instance Method Details

#list(opts = []) ⇒ Hash

Return a section of the image gallery

Parameters:

• opts (Hash) (defaults to: []) —

  various options for controlling returned data

  • [String] type optional the gallery type to return - images or files - default to images
  • [Int] start optional for large data sets, the page number to start at - defaults to 1st page of data (page 0)
  • [Int] limit optional for large data sets, the number of results to return - defaults to 25, upper limit set at 100
  • [String] sort_by optional field to sort by - one of size, time, name - defaults to time
  • [String] sort_dir optional field to sort by - one of asc, desc - defaults to desc
  • [String] search_term optional a term to search for in names

Returns:

• (Hash) —

  the matching gallery items

  • [Int] total the total matching items
  • [Array] data structs for each item included in the set, including:

    - [String] name the file name
    - [String] time the creation date for the item
    - [Int] size the file size in bytes
    - [String] full the url to the actual item in the gallery
    - [String] thumb a url for a thumbnail that can be used to represent the item, generally an image thumbnail or an icon for a file type

# File 'lib/mailchimp/api.rb', line 2121

def list(opts=[])
    _params = {:opts => opts}
    return @master.call 'gallery/list', _params
end