class Vonage::Conversations::Members

Public Instance Methods

create(conversation_id, params) click to toggle source

Create a member.

@option params [String] :action

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

@option params [required, String] :user_id

User ID.

@option params [String] :member_id

Member ID.

@option params [required, Hash] :channel

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

@option params [Hash] :media

Media Object.

@option params [String] :knocking_id

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

@option params [String] :member_id_inviting

Member ID of the member that sends the invitation.

@param [String] conversation_id @param [Hash] params

@return [Response]

@see developer.nexmo.com/api/conversation#createMember

# 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) click to toggle source

Delete a member.

@param [String] conversation_id @param [String] member_id

@return [Response]

@see developer.nexmo.com/api/conversation#deleteMember

# 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) click to toggle source

Retrieve a member.

@param [String] conversation_id @param [String] member_id

@return [Response]

@see developer.nexmo.com/api/conversation#getMember

# 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) click to toggle source

List members.

@param [String] conversation_id

@option params [Boolean] :auto_advance

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

@return [Response]

@see developer.nexmo.com/api/conversation#getMembers

# 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) click to toggle source

Update a member.

@option params [String] :action

Invite or join a member to a conversation.

@option params [Hash] :channel

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

@param [String] conversation_id @param [String] member_id @param [Hash] params

@return [Response]

@see developer.nexmo.com/api/conversation#updateMember

# 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