Contents

module TheCity

  class GroupExport < ApiObject

    tc_attr_accessor :id, 
                     :group_id,
                     :user_type,
                     :state,
                     :authenticated_s3_url,
                     :created_at


    # Loads the group export by the specified ID.
    #
    # @param group_export_id The ID of the group export to load.
    # @param options A hash of options for requesting data from the server.
    #                :: group_id is required    
    #                :: user_type is optional. It can be "Users" or "OfflineUsers"
    #
    # Returns a new {GroupExport} object.
    def self.load_by_id(group_export_id, options = {})
      group_reader = GroupExportReader.new(group_export_id, options)
      self.new(group_reader.load_feed)
    rescue
      nil        
    end     


    # Constructor.
    #
    # @param json_data (optional) JSON data of the group export.
    def initialize(json_data = nil)
      @writer_object = GroupExportWriter
      initialize_from_json_object(json_data) unless json_data.nil?
    end
    
  end

end

Version data entries

12 entries across 12 versions & 1 rubygems

Version	Path
the-city-admin-0.7.1	lib/api/group_export.rb
the-city-admin-0.7.0	lib/api/group_export.rb
the-city-admin-0.6.9	lib/api/group_export.rb
the-city-admin-0.6.8	lib/api/group_export.rb
the-city-admin-0.6.7	lib/api/group_export.rb
the-city-admin-0.6.6	lib/api/group_export.rb
the-city-admin-0.6.5	lib/api/group_export.rb
the-city-admin-0.6.4	lib/api/group_export.rb
the-city-admin-0.6.3	lib/api/group_export.rb
the-city-admin-0.6.2	lib/api/group_export.rb
the-city-admin-0.6.1	lib/api/group_export.rb
the-city-admin-0.6.0	lib/api/group_export.rb