com.twilio.rest.chat.v2.service.channel

Class MessageReader

java.lang.Object

com.twilio.base.Reader<Message>

com.twilio.rest.chat.v2.service.channel.MessageReader

public class MessageReader
extends Reader<Message>

Constructor Summary

Constructors

Constructor and Description
MessageReader(String pathServiceSid, String pathChannelSid) Construct a new MessageReader.

Method Summary

Modifier and Type	Method and Description
Page<Message>	firstPage(TwilioRestClient client) Make the request to the Twilio API to perform the read.
Page<Message>	getPage(String targetUrl, TwilioRestClient client) Retrieve the target page from the Twilio API.
Page<Message>	nextPage(Page<Message> page, TwilioRestClient client) Retrieve the next page from the Twilio API.
Page<Message>	previousPage(Page<Message> page, TwilioRestClient client) Retrieve the previous page from the Twilio API.
ResourceSet<Message>	read(TwilioRestClient client) Make the request to the Twilio API to perform the read.
MessageReader	setOrder(Message.OrderType order) The sort order of the returned messages.

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

MessageReader

public MessageReader(String pathServiceSid,
                     String pathChannelSid)

Construct a new MessageReader.

Parameters:

pathServiceSid - The SID of the Service to read the resources from

pathChannelSid - The SID of the Channel the message to read belongs to

Method Detail

setOrder

public MessageReader setOrder(Message.OrderType order)

The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending) with `asc` as the default..

Parameters:

order - The sort order of the returned messages

Returns:

this

read

public ResourceSet<Message> read(TwilioRestClient client)

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

Specified by:

read in class Reader<Message>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Message ResourceSet

firstPage

public Page<Message> firstPage(TwilioRestClient client)

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

Specified by:

firstPage in class Reader<Message>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Message ResourceSet

getPage

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

Retrieve the target page from the Twilio API.

Specified by:

getPage in class Reader<Message>

Parameters:

targetUrl - API-generated URL for the requested results page

client - TwilioRestClient with which to make the request

Returns:

Message ResourceSet

nextPage

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

Retrieve the next page from the Twilio API.

Specified by:

nextPage in class Reader<Message>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Next Page

previousPage

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

Retrieve the previous page from the Twilio API.

Specified by:

previousPage in class Reader<Message>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Previous Page