Module: GroupMe::Members

Included in:
Client
Defined in:
lib/groupme/members.rb

Instance Method Summary collapse

Instance Method Details

#add_member(id, member) ⇒ Boolean

Add member to a group

Parameters:

  • id (String, Integer) —

    Id of the group

  • member (Hash) —

    Member to be added

Options Hash (member):

  • :nickname (String)
  • :user_id (String) —

    Existing user id

  • :phone_number (String)
  • :email (String)
  • :guid (String)

Returns:

  • (Boolean) —

    Success/Failure

See Also:



29
30
31
 
# 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) ⇒ Boolean

Add members to a group

Parameters:

  • id (String, Integer) —

    Id of the group

  • members (Array<Hash>) —

    Members to be added

Options Hash (members):

  • :nickname (String)
  • :user_id (String) —

    Existing user id

  • :phone_number (String)
  • :email (String)
  • :guid (String)

Returns:

  • (Boolean) —

    Success/Failure

See Also:



14
15
16
 
# 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) ⇒ Array<Hashie::Mash>

Get the membership results from an add call

Parameters:

  • group_id (String, Integer) —

    Id of the group

  • results_id (String, Integer) —

    Id of the results set

Returns:

  • (Array<Hashie::Mash>) —

    Array of hashes representing members

See Also:



49
50
51
 
# 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) ⇒ Boolean

Remove a member from a group

Parameters:

  • group_id (String, Integer) —

    Id of the group

  • member_id (String, Integer) —

    Id of the member

Returns:

  • (Boolean) —

    Success/Failure

See Also:



39
40
41
 
# 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