REST API SDK for SMS
\
Clx
Xms
Api

\Clx\Xms\ApiPage

A page of elements.

The element type depends on the type of page that has been retrieved. Typically it is one of MtSmsBatchResponse or GroupResponse.

Summary

Methods
Properties
Constants
getIterator()
getPage()
setPage()
getSize()
setSize()
getTotalSize()
setTotalSize()
getContent()
setContent()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

getIterator()

getIterator() : \Clx\Xms\Api\Traversable

Returns an iterator over the content of this page. For example, if the page is the result of a batch listing then this iterator will yield batch results.

Returns

\Clx\Xms\Api\Traversable —

the page iterator

getPage()

getPage() : integer

Get the page number, starting from zero.

Returns

integer —

this page's number

setPage()

setPage(integer  $page) : void

Set the page number, starting from zero.

Parameters

integer $page

this page's number

getSize()

getSize() : integer

Get the number of elements on this page.

Returns

integer —

the number of page elements

setSize()

setSize(integer  $size) : void

Set the number of elements on this page.

Parameters

integer $size

the number of page elements

getTotalSize()

getTotalSize() : integer

Get the total number of elements across all fetched pages.

Returns

integer —

the total number of elements

setTotalSize()

setTotalSize(integer  $totalSize) : void

Set the total number of elements across all fetched pages.

Parameters

integer $totalSize

the total number of elements

getContent()

getContent() : array<mixed,mixed>

Get the page elements.

Returns

array<mixed,mixed> —

the page elements

setContent()

setContent(array<mixed,mixed>  $content) : void

Set the page elements.

Parameters

array<mixed,mixed> $content

the page elements