\Clx\XmsBatchFilter

Filter to use when listing batches.

Summary

Methods
Properties
Constants
getPageSize()
setPageSize()
getSenders()
setSenders()
getTags()
setTags()
getStartDate()
setStartDate()
getEndDate()
setEndDate()
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

getPageSize()

getPageSize() : integer

Get the maximum number of batches to retrieve per page.

Returns

integer —

page size

setPageSize()

setPageSize(integer  $pageSize) : void

Set the maximum number of batches to retrieve per page.

Parameters

integer $pageSize

page size

getSenders()

getSenders() : array<mixed,string>

Get sender filter.

Returns

array<mixed,string> —

list of short codes and long numbers

setSenders()

setSenders(array<mixed,string>  $senders) : void

Set sender filter.

Only batches having one of these senders will be fetched.

Parameters

array<mixed,string> $senders

list of short codes and long numbers

getTags()

getTags() : array<mixed,string>

Get tag filter.

Returns

array<mixed,string> —

list of tags

setTags()

setTags(array<mixed,string>  $tags) : void

Set tag filter.

Only batches having one or more of these tags will be fetched.

Parameters

array<mixed,string> $tags

list of tags

getStartDate()

getStartDate() : \DateTime

Get start date filter.

Returns

\DateTime —

start date filter

setStartDate()

setStartDate(\DateTime  $startDate) : void

Set start date filter.

Only batches sent at or after this date will be fetched.

Parameters

\DateTime $startDate

start date filter

getEndDate()

getEndDate() : \DateTime

Get end date filter.

Returns

\DateTime —

end date filter

setEndDate()

setEndDate(\DateTime  $endDate) : void

Set end date filter.

Only batches sent before this date will be fetched.

Parameters

\DateTime $endDate

end date filter