Package com.vonage.client.conversations

Class UpdateMemberRequest.Builder

java.lang.Object

com.vonage.client.conversations.UpdateMemberRequest.Builder

Enclosing class:

UpdateMemberRequest

public static final class UpdateMemberRequest.Builder
extends Object

Builder for constructing an UpdateMemberRequest. Note the mandatory parameters.

Method Summary

Modifier and Type	Method	Description
UpdateMemberRequest	build()	Builds the UpdateMemberRequest.
UpdateMemberRequest.Builder	code(String code)	Reason code for leaving.
UpdateMemberRequest.Builder	conversationId(String conversationId)	(REQUIRED) Unique conversation identifier.
UpdateMemberRequest.Builder	from(String from)	TODO document this
UpdateMemberRequest.Builder	memberId(String memberId)	(REQUIRED) Unique member identifier.
UpdateMemberRequest.Builder	state(MemberState state)	(REQUIRED) State to transition the member into.
UpdateMemberRequest.Builder	text(String text)	Reason text for leaving.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

conversationId

public UpdateMemberRequest.Builder conversationId(String conversationId)

(REQUIRED) Unique conversation identifier.

Parameters:

conversationId - The conversation ID.

Returns:

This builder.

memberId

public UpdateMemberRequest.Builder memberId(String memberId)

(REQUIRED) Unique member identifier.

Parameters:

memberId - The member ID.

Returns:

This builder.

state

public UpdateMemberRequest.Builder state(MemberState state)

(REQUIRED) State to transition the member into.

Parameters:

state - The updated state as an enum.

Returns:

This builder.

from

public UpdateMemberRequest.Builder from(String from)

TODO document this

Parameters:

from - The from (??)

Returns:

This builder.

code

public UpdateMemberRequest.Builder code(String code)

Reason code for leaving. Only applicable when state(MemberState) is MemberState.LEFT.

Parameters:

code - The reason code as a string.

Returns:

This builder.

text

public UpdateMemberRequest.Builder text(String text)

Reason text for leaving. Only applicable when state(MemberState) is MemberState.LEFT.

Parameters:

text - The reason text.

Returns:

This builder.

build

public UpdateMemberRequest build()

Builds the UpdateMemberRequest.

Returns:

An instance of UpdateMemberRequest, populated with all fields from this builder.