Class: Vonage::Conversations::Members

Inherits:
Namespace
  • Object
show all
Defined in:
lib/vonage/conversations/members.rb

Instance Method Summary collapse

Instance Method Details

#create(conversation_id, params) ⇒ Response

Create a member.

Parameters:

  • conversation_id (String)
  • params (Hash)

Options Hash (params):

  • :action (String) —

    Invite or join a member to a conversation. Must be one of: invite or join.

  • :user_id (required, String) —

    User ID.

  • :member_id (String) —

    Member ID.

  • :channel (required, Hash) —

    A user who joins a conversation as a member can have one channel per membership type.

  • :media (Hash) —

    Media Object.

  • :knocking_id (String) —

    Knocker ID. A knocker is a pre-member of a conversation who does not exist yet.

  • :member_id_inviting (String) —

    Member ID of the member that sends the invitation.

Returns:

See Also:



42
43
44
 
# File 'lib/vonage/conversations/members.rb', line 42

def create(conversation_id, params)
  request('/beta/conversations/' + conversation_id + '/members', params: params, type: Post)
end

#delete(conversation_id, member_id) ⇒ Response

Delete a member.

Parameters:

  • conversation_id (String)
  • member_id (String)

Returns:

See Also:



104
105
106
 
# File 'lib/vonage/conversations/members.rb', line 104

def delete(conversation_id, member_id)
  request('/beta/conversations/' + conversation_id + '/members/' + member_id, type: Delete)
end

#get(conversation_id, member_id) ⇒ Response

Retrieve a member.

Parameters:

  • conversation_id (String)
  • member_id (String)

Returns:

See Also:



71
72
73
 
# File 'lib/vonage/conversations/members.rb', line 71

def get(conversation_id, member_id)
  request('/beta/conversations/' + conversation_id + '/members/' + member_id)
end

#list(conversation_id, params = nil, auto_advance = true) ⇒ Response

List members.

Parameters:

  • conversation_id (String)
  • params (Hash) (defaults to: nil) —

    a customizable set of options

Options Hash (params):

  • :auto_advance (Boolean) —

    Set this to false to not auto-advance through all the pages in the record and collect all the data. The default is true.

Returns:

See Also:



58
59
60
 
# File 'lib/vonage/conversations/members.rb', line 58

def list(conversation_id, params = nil, auto_advance = true)
  request('/beta/conversations/' + conversation_id + '/members', params: params)
end

#update(conversation_id, member_id, params) ⇒ Response

Update a member.

Parameters:

  • conversation_id (String)
  • member_id (String)
  • params (Hash)

Options Hash (params):

  • :action (String) —

    Invite or join a member to a conversation.

  • :channel (Hash) —

    A user who joins a conversation as a member can have one channel per membership type.

Returns:

See Also:



91
92
93
 
# File 'lib/vonage/conversations/members.rb', line 91

def update(conversation_id, member_id, params)
  request('/beta/conversations/' + conversation_id + '/members/' + member_id, params: params, type: Put)
end