com.twilio.rest.insights.v1.room

Class Participant

java.lang.Object

com.twilio.base.Resource

com.twilio.rest.insights.v1.room.Participant

All Implemented Interfaces:

Serializable

public class Participant
extends Resource

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Participant.Codec
static class	Participant.EdgeLocation
static class	Participant.RoomStatus
static class	Participant.TwilioRealm

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static ParticipantFetcher	fetcher(String pathRoomSid, String pathParticipantSid) Create a ParticipantFetcher to execute fetch.
static Participant	fromJson(InputStream json, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Converts a JSON InputStream into a Participant object using the provided ObjectMapper.
static Participant	fromJson(String json, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Converts a JSON String into a Participant object using the provided ObjectMapper.
String	getAccountSid() Returns Account SID associated with the room..
List<Participant.Codec>	getCodecs() Returns Codecs detected from the participant..
Long	getDurationSec() Returns Amount of time in seconds the participant was in the room..
Participant.EdgeLocation	getEdgeLocation() Returns Name of the edge location the participant connected to..
String	getEndReason() Returns Reason the participant left the room..
Integer	getErrorCode() Returns Errors encountered by the participant..
String	getErrorCodeUrl() Returns Twilio error code dictionary link..
ZonedDateTime	getJoinTime() Returns When the participant joined the room..
ZonedDateTime	getLeaveTime() Returns When the participant left the room.
Participant.TwilioRealm	getMediaRegion() Returns Twilio media region the participant connected to..
String	getParticipantIdentity() Returns The application-defined string that uniquely identifies the participant within a Room..
String	getParticipantSid() Returns Unique identifier for the participant..
Map<String,Object>	getProperties() Returns Object containing information about the participant's data from the room..
Map<String,Object>	getPublisherInfo() Returns Object containing information about the SDK name and version..
String	getRoomSid() Returns Unique identifier for the room..
Participant.RoomStatus	getStatus() Returns Status of the room..
URI	getUrl() Returns URL of the participant resource..
int	hashCode()
static ParticipantReader	reader(String pathRoomSid) Create a ParticipantReader to execute read.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

fetcher

public static ParticipantFetcher fetcher(String pathRoomSid,
                                         String pathParticipantSid)

Create a ParticipantFetcher to execute fetch.

Parameters:

pathRoomSid - The SID of the Room resource.

pathParticipantSid - The SID of the Participant resource.

Returns:

ParticipantFetcher capable of executing the fetch

reader

public static ParticipantReader reader(String pathRoomSid)

Create a ParticipantReader to execute read.

Parameters:

pathRoomSid - The SID of the Room resource.

Returns:

ParticipantReader capable of executing the read

fromJson

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

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

Parameters:

json - Raw JSON String

objectMapper - Jackson ObjectMapper

Returns:

Participant object represented by the provided JSON

fromJson

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

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

Parameters:

json - Raw JSON InputStream

objectMapper - Jackson ObjectMapper

Returns:

Participant object represented by the provided JSON

getParticipantSid

public final String getParticipantSid()

Returns Unique identifier for the participant..

Returns:

Unique identifier for the participant.

getParticipantIdentity

public final String getParticipantIdentity()

Returns The application-defined string that uniquely identifies the participant within a Room..

Returns:

The application-defined string that uniquely identifies the participant within a Room.

getJoinTime

public final ZonedDateTime getJoinTime()

Returns When the participant joined the room..

Returns:

When the participant joined the room.

getLeaveTime

public final ZonedDateTime getLeaveTime()

Returns When the participant left the room.

Returns:

When the participant left the room

getDurationSec

public final Long getDurationSec()

Returns Amount of time in seconds the participant was in the room..

Returns:

Amount of time in seconds the participant was in the room.

getAccountSid

public final String getAccountSid()

Returns Account SID associated with the room..

Returns:

Account SID associated with the room.

getRoomSid

public final String getRoomSid()

Returns Unique identifier for the room..

Returns:

Unique identifier for the room.

getStatus

public final Participant.RoomStatus getStatus()

Returns Status of the room..

Returns:

Status of the room.

getCodecs

public final List<Participant.Codec> getCodecs()

Returns Codecs detected from the participant..

Returns:

Codecs detected from the participant.

getEndReason

public final String getEndReason()

Returns Reason the participant left the room..

Returns:

Reason the participant left the room.

getErrorCode

public final Integer getErrorCode()

Returns Errors encountered by the participant..

Returns:

Errors encountered by the participant.

getErrorCodeUrl

public final String getErrorCodeUrl()

Returns Twilio error code dictionary link..

Returns:

Twilio error code dictionary link.

getMediaRegion

public final Participant.TwilioRealm getMediaRegion()

Returns Twilio media region the participant connected to..

Returns:

Twilio media region the participant connected to.

getProperties

public final Map<String,Object> getProperties()

Returns Object containing information about the participant's data from the room..

Returns:

Object containing information about the participant's data from the room.

getEdgeLocation

public final Participant.EdgeLocation getEdgeLocation()

Returns Name of the edge location the participant connected to..

Returns:

Name of the edge location the participant connected to.

getPublisherInfo

public final Map<String,Object> getPublisherInfo()

Returns Object containing information about the SDK name and version..

Returns:

Object containing information about the SDK name and version.

getUrl

public final URI getUrl()

Returns URL of the participant resource..

Returns:

URL of the participant resource.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object