Package com.vonage.client.conversations

Class UpdateMemberRequest

java.lang.Object

com.vonage.client.conversations.UpdateMemberRequest

All Implemented Interfaces:

Jsonable

public final class UpdateMemberRequest
extends Object
implements Jsonable

Options for updating a membership using ConversationsClient.updateMember(UpdateMemberRequest).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UpdateMemberRequest.Builder	Builder for constructing an UpdateMemberRequest.

Method Summary

Modifier and Type	Method	Description
static UpdateMemberRequest.Builder	builder()	Entry point for constructing an instance of this class.
String	getCode()	Reason code for leaving.
String	getConversationId()	Unique Conversation identifier.
String	getFrom()	TODO document this.
String	getMemberId()	Unique Member identifier.
MemberState	getState()	State to transition the member into.
String	getText()	Reason text for leaving.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Method Details

getState

public MemberState getState()

State to transition the member into.

Returns:

The updated state as an enum.

getFrom

public String getFrom()

TODO document this.

Returns:

The from, or null if unspecified.

getCode

public String getCode()

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

Returns:

The reason code, or null if unspecified / not applicable.

getText

public String getText()

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

Returns:

The reason text, or null if unspecified / not applicable.

getConversationId

public String getConversationId()

Unique Conversation identifier.

Returns:

The conversation ID.

getMemberId

public String getMemberId()

Unique Member identifier.

Returns:

The member ID.

builder

public static UpdateMemberRequest.Builder builder()

Entry point for constructing an instance of this class.

Returns:

A new Builder.