com.twilio.rest.studio.v1.flow

Class Engagement

java.lang.Object

com.twilio.base.Resource

com.twilio.rest.studio.v1.flow.Engagement

All Implemented Interfaces:

Serializable

public class Engagement
extends Resource

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Engagement.Status

Method Summary

Modifier and Type	Method and Description
static EngagementCreator	creator(String pathFlowSid, PhoneNumber to, PhoneNumber from) Create a EngagementCreator to execute create.
static EngagementDeleter	deleter(String pathFlowSid, String pathSid) Create a EngagementDeleter to execute delete.
boolean	equals(Object o)
static EngagementFetcher	fetcher(String pathFlowSid, String pathSid) Create a EngagementFetcher to execute fetch.
static Engagement	fromJson(InputStream json, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Converts a JSON InputStream into a Engagement object using the provided ObjectMapper.
static Engagement	fromJson(String json, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Converts a JSON String into a Engagement object using the provided ObjectMapper.
String	getAccountSid() Returns The SID of the Account that created the resource.
String	getContactChannelAddress() Returns The phone number, SIP address or Client identifier that triggered this Engagement.
String	getContactSid() Returns The SID of the Contact.
Map<String,Object>	getContext() Returns The current state of the execution flow.
org.joda.time.DateTime	getDateCreated() Returns The ISO 8601 date and time in GMT when the Engagement was created.
org.joda.time.DateTime	getDateUpdated() Returns The ISO 8601 date and time in GMT when the Engagement was last updated.
String	getFlowSid() Returns The SID of the Flow.
Map<String,String>	getLinks() Returns The URLs of the Engagement's nested resources.
String	getSid() Returns The unique string that identifies the resource.
Engagement.Status	getStatus() Returns The status of the Engagement.
URI	getUrl() Returns The absolute URL of the resource.
int	hashCode()
static EngagementReader	reader(String pathFlowSid) Create a EngagementReader to execute read.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

reader

public static EngagementReader reader(String pathFlowSid)

Create a EngagementReader to execute read.

Parameters:

pathFlowSid - The SID of the Flow to read Engagements from

Returns:

EngagementReader capable of executing the read

fetcher

public static EngagementFetcher fetcher(String pathFlowSid,
                                        String pathSid)

Create a EngagementFetcher to execute fetch.

Parameters:

pathFlowSid - Flow SID

pathSid - The SID of the Engagement resource to fetch

Returns:

EngagementFetcher capable of executing the fetch

creator

public static EngagementCreator creator(String pathFlowSid,
                                        PhoneNumber to,
                                        PhoneNumber from)

Create a EngagementCreator to execute create.

Parameters:

pathFlowSid - The SID of the Flow

to - The Contact phone number to start a Studio Flow Engagement

from - The Twilio phone number to send messages or initiate calls from during the Flow Engagement

Returns:

EngagementCreator capable of executing the create

deleter

public static EngagementDeleter deleter(String pathFlowSid,
                                        String pathSid)

Create a EngagementDeleter to execute delete.

Parameters:

pathFlowSid - The SID of the Flow to delete Engagements from

pathSid - The SID of the Engagement resource to delete

Returns:

EngagementDeleter capable of executing the delete

fromJson

public static Engagement fromJson(String json,
                                  com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Converts a JSON String into a Engagement object using the provided ObjectMapper.

Parameters:

json - Raw JSON String

objectMapper - Jackson ObjectMapper

Returns:

Engagement object represented by the provided JSON

fromJson

public static Engagement fromJson(InputStream json,
                                  com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Converts a JSON InputStream into a Engagement object using the provided ObjectMapper.

Parameters:

json - Raw JSON InputStream

objectMapper - Jackson ObjectMapper

Returns:

Engagement object represented by the provided JSON

getSid

public final String getSid()

Returns The unique string that identifies the resource.

Returns:

The unique string that identifies the resource

getAccountSid

public final String getAccountSid()

Returns The SID of the Account that created the resource.

Returns:

The SID of the Account that created the resource

getFlowSid

public final String getFlowSid()

Returns The SID of the Flow.

Returns:

The SID of the Flow

getContactSid

public final String getContactSid()

Returns The SID of the Contact.

Returns:

The SID of the Contact

getContactChannelAddress

public final String getContactChannelAddress()

Returns The phone number, SIP address or Client identifier that triggered this Engagement.

Returns:

The phone number, SIP address or Client identifier that triggered this Engagement

getContext

public final Map<String,Object> getContext()

Returns The current state of the execution flow.

Returns:

The current state of the execution flow

getStatus

public final Engagement.Status getStatus()

Returns The status of the Engagement.

Returns:

The status of the Engagement

getDateCreated

public final org.joda.time.DateTime getDateCreated()

Returns The ISO 8601 date and time in GMT when the Engagement was created.

Returns:

The ISO 8601 date and time in GMT when the Engagement was created

getDateUpdated

public final org.joda.time.DateTime getDateUpdated()

Returns The ISO 8601 date and time in GMT when the Engagement was last updated.

Returns:

The ISO 8601 date and time in GMT when the Engagement was last updated

getUrl

public final URI getUrl()

Returns The absolute URL of the resource.

Returns:

The absolute URL of the resource

getLinks

public final Map<String,String> getLinks()

Returns The URLs of the Engagement's nested resources.

Returns:

The URLs of the Engagement's nested resources

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object