module GroupMe::Members

Public Instance Methods

add_member(id, member) click to toggle source

Add member to a group

@return [Boolean] Success/Failure @see dev.groupme.com/docs/v3#members_add @param id [String, Integer] Id of the group @param member [Hash] Member to be added @option member [String] :nickname @option member [String] :user_id Existing user id @option member [String] :phone_number @option member [String] :email @option member [String] :guid

# File lib/groupme/members.rb, line 29
def add_member(id, member)
  post("/groups/#{id}/members/add", [member]).status == 202
end
add_members(id, members) click to toggle source

Add members to a group

@return [Boolean] Success/Failure @see dev.groupme.com/docs/v3#members_add @param id [String, Integer] Id of the group @param members [Array<Hash>] Members to be added @option members [String] :nickname @option members [String] :user_id Existing user id @option members [String] :phone_number @option members [String] :email @option members [String] :guid

# File lib/groupme/members.rb, line 14
def add_members(id, members)
  post("/groups/#{id}/members/add", members).status == 202
end
membership_results(group_id, results_id) click to toggle source

Get the membership results from an add call

@return [Array<Hashie::Mash>] Array of hashes representing members @see dev.groupme.com/docs/v3#members_results @param group_id [String, Integer] Id of the group @param results_id [String, Integer] Id of the results set

# File lib/groupme/members.rb, line 49
def membership_results(group_id, results_id)
  get("/groups/#{group_id}/members/results/#{results_id}").members
end
remove_member(group_id, member_id) click to toggle source

Remove a member from a group

@return [Boolean] Success/Failure @see dev.groupme.com/docs/v3#members_remove @param group_id [String, Integer] Id of the group @param member_id [String, Integer] Id of the member

# File lib/groupme/members.rb, line 39
def remove_member(group_id, member_id)
  post("/groups/#{group_id}/members/#{member_id}/remove").status == 200
end