Package com.vonage.client.conversations

Class Conversation

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.conversations.BaseConversation

com.vonage.client.conversations.Conversation

All Implemented Interfaces:

Jsonable

Direct Known Subclasses:

UserConversation

public class Conversation
extends BaseConversation

Represents a Conversation (request and response).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Conversation.Builder	Builder for creating or updating a Conversation.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Conversation()

Method Summary

Modifier and Type	Method	Description
static Conversation.Builder	builder()	Entry point for constructing an instance of this class.
Callback	getCallback()	Specifies callback parameters for webhooks.
Collection<? extends Channel>	getNumbers()	Channels containing the contact numbers for this conversation.
ConversationProperties	getProperties()	Properties for this conversation.
Integer	getSequenceNumber()	The last Event ID in this conversation.
ConversationStatus	getState()	The state the conversation is in.

Methods inherited from class com.vonage.client.conversations.BaseConversation

getDisplayName, getId, getImageUrl, getName, getTimestamp

Methods inherited from class com.vonage.client.JsonableBaseObject

createJsonObjectMapper, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Constructor Details

Conversation

protected Conversation()

Method Details

getState

public ConversationStatus getState()

The state the conversation is in.

Returns:

The conversation state as an enum, or null if unknown.

getSequenceNumber

public Integer getSequenceNumber()

The last Event ID in this conversation. This ID can be used to retrieve a specific event.

Returns:

The last event ID as an integer, or null if unknown.

getProperties

public ConversationProperties getProperties()

Properties for this conversation.

Returns:

The conversation properties object, or null if not applicable.

getNumbers

public Collection<? extends Channel> getNumbers()

Channels containing the contact numbers for this conversation. Currently, only Pstn (Phone) type is supported.

Returns:

The channels associated with this conversation, or null if unspecified.

getCallback

public Callback getCallback()

Specifies callback parameters for webhooks.

Returns:

The callback properties, or null if unspecified.

builder

public static Conversation.Builder builder()

Entry point for constructing an instance of this class.

Returns:

A new Builder.