\Clx\Xms\ApiBatchDeliveryReportStatus

Aggregated statistics for a given batch.

Summary

Methods
Properties
Constants
getCode()
setCode()
getStatus()
setStatus()
getCount()
setCount()
getRecipients()
setRecipients()
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

getCode()

getCode() : integer

Get the delivery status code for this recipient bucket.

Returns

integer —

delivery status code

setCode()

setCode(integer  $code) : void

Set the delivery status code for this recipient bucket.

Parameters

integer $code

delivery status code

getStatus()

getStatus() : string

Get the delivery status for this recipient bucket.

Returns

string —

delivery status

setStatus()

setStatus(string  $status) : void

Set the delivery status for this recipient bucket.

Parameters

string $status

delivery status

getCount()

getCount() : integer

Get the number of recipients belonging to this bucket.

Returns

integer —

number of recipients

setCount()

setCount(integer  $count) : void

Set the number of recipients belonging to this bucket.

Parameters

integer $count

number of recipients

getRecipients()

getRecipients() : array<mixed,string>

Get the recipients having this status.

Note, this is non-empty only if a full delivery report has been requested.

Returns

array<mixed,string> —

individual recipients

setRecipients()

setRecipients(array<mixed,string>  $recipients) : void

Set the recipients having this status.

Parameters

array<mixed,string> $recipients

individual recipients