com.twilio.rest.preview.studio.flow

Class Engagement

java.lang.Object

com.twilio.base.Resource

com.twilio.rest.preview.studio.flow.Engagement

All Implemented Interfaces:

Serializable

public class Engagement
extends Resource

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.

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 Account Sid..
PhoneNumber	getContactChannelAddress() Returns The The phone number, SIP address or Client identifier that triggered this Engagement..
String	getContactSid() Returns The Contact Sid..
Map<String,Object>	getContext() Returns The Nested resource URLs..
org.joda.time.DateTime	getDateCreated() Returns The The date this Engagement was created.
org.joda.time.DateTime	getDateUpdated() Returns The The date this Engagement was updated.
String	getFlowSid() Returns The Flow Sid..
Map<String,String>	getLinks() Returns The Nested resource URLs..
String	getSid() Returns The A string that uniquely identifies this Engagement..
Engagement.Status	getStatus() Returns The The Status of this Engagement.
URI	getUrl() Returns The The URL of this 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 - Flow Sid.

Returns:

EngagementReader capable of executing the read

fetcher

public static EngagementFetcher fetcher(String pathFlowSid,
                                        String pathSid)

Create a EngagementFetcher to execute fetch.

Parameters:

pathFlowSid - The flow_sid

pathSid - The sid

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 - Flow Sid.

to - The to

from - The from

Returns:

EngagementCreator capable of executing the create

deleter

public static EngagementDeleter deleter(String pathFlowSid,
                                        String pathSid)

Create a EngagementDeleter to execute delete.

Parameters:

pathFlowSid - Flow Sid.

pathSid - A string that uniquely identifies this Engagement.

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 A string that uniquely identifies this Engagement..

Returns:

A string that uniquely identifies this Engagement.

getAccountSid

public final String getAccountSid()

Returns The Account Sid..

Returns:

Account Sid.

getFlowSid

public final String getFlowSid()

Returns The Flow Sid..

Returns:

Flow Sid.

getContactSid

public final String getContactSid()

Returns The Contact Sid..

Returns:

Contact Sid.

getContactChannelAddress

public final PhoneNumber getContactChannelAddress()

Returns The 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.

getStatus

public final Engagement.Status getStatus()

Returns The The Status of this Engagement.

Returns:

The Status of this Engagement

getContext

public final Map<String,Object> getContext()

Returns The Nested resource URLs..

Returns:

Nested resource URLs.

getDateCreated

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

Returns The The date this Engagement was created.

Returns:

The date this Engagement was created

getDateUpdated

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

Returns The The date this Engagement was updated.

Returns:

The date this Engagement was updated

getUrl

public final URI getUrl()

Returns The The URL of this resource..

Returns:

The URL of this resource.

getLinks

public final Map<String,String> getLinks()

Returns The Nested resource URLs..

Returns:

Nested resource URLs.

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