REST API SDK for SMS
\
Clx
Xms
Api

\Clx\Xms\ApiMtBatchDryRunResult

A batch dry run report.

Summary

Methods
Properties
Constants
getNumberOfRecipients()
setNumberOfRecipients()
getNumberOfMessages()
setNumberOfMessages()
getPerRecipient()
setPerRecipient()
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

getNumberOfRecipients()

getNumberOfRecipients() : integer

Get the number of recipients that would receive the batch message.

Returns

integer —

the number of batch recipients

setNumberOfRecipients()

setNumberOfRecipients(integer  $numberOfRecipients) : void

Set the number of recipients that would receive the batch message.

Parameters

integer $numberOfRecipients

the number of batch recipients

getNumberOfMessages()

getNumberOfMessages() : integer

Get the number of messages that would be sent in the batch.

Returns

integer —

the number of messages that would be sent

setNumberOfMessages()

setNumberOfMessages(integer  $numberOfMessages) : void

Set the number of messages that would be sent in the batch.

Parameters

integer $numberOfMessages

the number of messages that would be sent

getPerRecipient()

getPerRecipient() : array<mixed,\Clx\Xms\Api\DryRunPerRecipient>

Get the per-recipient dry-run results.

Returns

array<mixed,\Clx\Xms\Api\DryRunPerRecipient> —

the per-recipient dry-run result

setPerRecipient()

setPerRecipient(array<mixed,\Clx\Xms\Api\DryRunPerRecipient>  $perRecipient) : void

Set the per-recipient dry-run results.

Parameters

array<mixed,\Clx\Xms\Api\DryRunPerRecipient> $perRecipient

the per-recipient results