\Clx\Xms\ApiBatchRecipientDeliveryReport

A delivery report for an individual batch recipient.

Summary

Methods
Properties
Constants
getBatchId()
setBatchId()
getRecipient()
setRecipient()
getCode()
setCode()
getStatus()
setStatus()
getStatusMessage()
setStatusMessage()
getOperator()
setOperator()
getStatusAt()
setStatusAt()
getOperatorStatusAt()
setOperatorStatusAt()
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

getBatchId()

getBatchId() : string

Get the batch identifier.

Returns

string —

the batch identifier

setBatchId()

setBatchId(string  $batchId) : void

Set the batch identifier.

Parameters

string $batchId

the batch identifier

getRecipient()

getRecipient() : string

Get the batch recipient address.

Returns

string —

recipient MSISDN

setRecipient()

setRecipient(string  $recipient) : void

Set the batch recipient address.

Parameters

string $recipient

recipient MSISDN

getCode()

getCode() : integer

Get the delivery code.

Returns

integer —

delivery code

setCode()

setCode(integer  $code) : void

Set the delivery code.

Parameters

integer $code

delivery code

getStatus()

getStatus() : string

Get the delivery status.

Returns

string —

delivery status

setStatus()

setStatus(string  $status) : void

Set the delivery status.

Parameters

string $status

delivery status

getStatusMessage()

getStatusMessage() : string|null

Get textual delivery status message, if available.

Returns

string|null —

the status message

setStatusMessage()

setStatusMessage(string|null  $statusMessage) : void

Set textual delivery status message.

Parameters

string|null $statusMessage

the status message

getOperator()

getOperator() : string|null

Get the recipient operator MCCMNC, if available.

Returns

string|null —

the recipient's operator

setOperator()

setOperator(string|null  $operator) : void

Set the recipient operator MCCMNC

Parameters

string|null $operator

the recipient's operator

getStatusAt()

getStatusAt() : \DateTime

Get time when the delivery reached its final state.

Returns

\DateTime —

the time at final state

setStatusAt()

setStatusAt(\DateTime  $statusAt) : void

Set time when the delivery reached its final state.

Parameters

\DateTime $statusAt

the time at final state

getOperatorStatusAt()

getOperatorStatusAt() : \DateTime|null

Get time when the delivery reached final state as reported by operator, if available.

Returns

\DateTime|null —

the time at operator final state

setOperatorStatusAt()

setOperatorStatusAt(\DateTime|null  $operatorStatusAt) : void

Set time when the delivery reached final state as reported by operator.

Parameters

\DateTime|null $operatorStatusAt

the time at operator final state