Package com.twilio.rest.video.v1.room

Class ParticipantReader

java.lang.Object

com.twilio.base.Reader<Participant>

com.twilio.rest.video.v1.room.ParticipantReader

public class ParticipantReader
extends Reader<Participant>

Constructor Summary

Constructors

Constructor	Description
ParticipantReader(String pathRoomSid)	Construct a new ParticipantReader.

Method Summary

Modifier and Type	Method	Description
Page<Participant>	firstPage(TwilioRestClient client)	Make the request to the Twilio API to perform the read.
Page<Participant>	getPage(String targetUrl, TwilioRestClient client)	Retrieve the target page from the Twilio API.
Page<Participant>	nextPage(Page<Participant> page, TwilioRestClient client)	Retrieve the next page from the Twilio API.
Page<Participant>	previousPage(Page<Participant> page, TwilioRestClient client)	Retrieve the previous page from the Twilio API.
ResourceSet<Participant>	read(TwilioRestClient client)	Make the request to the Twilio API to perform the read.
ParticipantReader	setDateCreatedAfter(org.joda.time.DateTime dateCreatedAfter)	Only show Participants that started after this date, given as an [UTC ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC)..
ParticipantReader	setDateCreatedBefore(org.joda.time.DateTime dateCreatedBefore)	Only show Participants that started before this date, given as an [UTC ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC)..
ParticipantReader	setIdentity(String identity)	Only show Participants that connected to the Room using the provided Identity..
ParticipantReader	setStatus(Participant.Status status)	Only show Participants with the given Status.

Methods inherited from class com.twilio.base.Reader

firstPage, getLimit, getPage, getPageSize, limit, nextPage, pageSize, previousPage, read, readAsync, readAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

ParticipantReader

public ParticipantReader(String pathRoomSid)

Construct a new ParticipantReader.

Parameters:

pathRoomSid - A system-generated 34-character string that uniquely identifies this Room.

Method Detail

setStatus

public ParticipantReader setStatus(Participant.Status status)

Only show Participants with the given Status. For `in-progress` Rooms the default Status is `connected`, for `completed` Rooms only `disconnected` Participants are returned..

Parameters:

status - Only show Participants with the given Status.

Returns:

this

setIdentity

public ParticipantReader setIdentity(String identity)

Only show Participants that connected to the Room using the provided Identity..

Parameters:

identity - Only show Participants that connected to the Room using the provided Identity.

Returns:

this

setDateCreatedAfter

public ParticipantReader setDateCreatedAfter(org.joda.time.DateTime dateCreatedAfter)

Only show Participants that started after this date, given as an [UTC ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC)..

Parameters:

dateCreatedAfter - Only show Participants that started after this date, given as an UTC ISO 8601 Timestamp.

Returns:

this

setDateCreatedBefore

public ParticipantReader setDateCreatedBefore(org.joda.time.DateTime dateCreatedBefore)

Only show Participants that started before this date, given as an [UTC ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC)..

Parameters:

dateCreatedBefore - Only show Participants that started before this date, given as an UTC ISO 8601 Timestamp.

Returns:

this

read

public ResourceSet<Participant> read(TwilioRestClient client)

Make the request to the Twilio API to perform the read.

Specified by:

read in class Reader<Participant>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Participant ResourceSet

firstPage

public Page<Participant> firstPage(TwilioRestClient client)

Make the request to the Twilio API to perform the read.

Specified by:

firstPage in class Reader<Participant>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Participant ResourceSet

getPage

public Page<Participant> getPage(String targetUrl,
                                 TwilioRestClient client)

Retrieve the target page from the Twilio API.

Specified by:

getPage in class Reader<Participant>

Parameters:

targetUrl - API-generated URL for the requested results page

client - TwilioRestClient with which to make the request

Returns:

Participant ResourceSet

nextPage

public Page<Participant> nextPage(Page<Participant> page,
                                  TwilioRestClient client)

Retrieve the next page from the Twilio API.

Specified by:

nextPage in class Reader<Participant>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Next Page

previousPage

public Page<Participant> previousPage(Page<Participant> page,
                                      TwilioRestClient client)

Retrieve the previous page from the Twilio API.

Specified by:

previousPage in class Reader<Participant>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Previous Page