com.plivo.api.models.base

Class MessagingBrandLister<T extends BaseResource>

java.lang.Object

com.plivo.api.models.base.BaseRequest<T>

com.plivo.api.models.base.MessagingBrandLister<T>

Type Parameters:

T - The type of the resource.

All Implemented Interfaces:

java.lang.Iterable<T>

Direct Known Subclasses:

BrandLister

public abstract class MessagingBrandLister<T extends BaseResource>
extends BaseRequest<T>
implements java.lang.Iterable<T>

Lists instances of a resource, possibly filtered.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Integer	limit
protected java.lang.Integer	offset

Fields inherited from class com.plivo.api.models.base.BaseRequest

plivoClient

Constructor Summary

Constructors

Constructor and Description
MessagingBrandLister()

Method Summary

Modifier and Type	Method and Description
MessagingBrandLister<T>	client(PlivoClient plivoClient)
java.util.Iterator<T>	iterator()
java.lang.Integer	limit()
MessagingBrandLister<T>	limit(java.lang.Integer limit)
ListResponse<T>	list() Actually list instances of the resource.
protected abstract retrofit2.Call<ListResponse<T>>	obtainCall()
java.lang.Integer	offset()
MessagingBrandLister<T>	offset(java.lang.Integer offset)
protected java.util.Map<java.lang.String,java.lang.Object>	toMap()

Methods inherited from class com.plivo.api.models.base.BaseRequest

client, handleResponse, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

limit

protected java.lang.Integer limit

offset

protected java.lang.Integer offset

Constructor Detail

MessagingBrandLister

public MessagingBrandLister()

Method Detail

client

public MessagingBrandLister<T> client(PlivoClient plivoClient)

Overrides:

client in class BaseRequest<T extends BaseResource>

limit

public java.lang.Integer limit()

Returns:

Used to display the number of results per page. The maximum number of results that can be fetched is 20.

offset

public java.lang.Integer offset()

Returns:

Denotes the number of value items by which the results should be offset.

limit

public MessagingBrandLister<T> limit(java.lang.Integer limit)

Parameters:

limit - Used to display the number of results per page. The maximum number of results that can be fetched is 20.

offset

public MessagingBrandLister<T> offset(java.lang.Integer offset)

Parameters:

offset - Denotes the number of value items by which the results should be offset.

obtainCall

protected abstract retrofit2.Call<ListResponse<T>> obtainCall()
                                                       throws PlivoValidationException

Throws:

PlivoValidationException

list

public ListResponse<T> list()
                     throws java.io.IOException,
                            PlivoRestException,
                            PlivoValidationException

Actually list instances of the resource.

Throws:

java.io.IOException

PlivoRestException

PlivoValidationException

toMap

protected java.util.Map<java.lang.String,java.lang.Object> toMap()

iterator

public java.util.Iterator<T> iterator()
                               throws IterableError

Specified by:

iterator in interface java.lang.Iterable<T extends BaseResource>

Throws:

IterableError