\Clx\Xms\ApiMoBinarySms

An SMS mobile originated message with binary content.

Holds fields that are common to both the textual and binary MO classes.

Summary

Methods
Properties
Constants
getMessageId()
setMessageId()
getRecipient()
setRecipient()
getSender()
setSender()
getOperator()
setOperator()
getSentAt()
setSentAt()
getReceivedAt()
setReceivedAt()
getBody()
setBody()
getUdh()
setUdh()
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

getMessageId()

getMessageId() : string

Get the message identifier.

Returns

string —

message identifier

setMessageId()

setMessageId(string  $messageId) : void

Set the message identifier.

Parameters

string $messageId

message identifier

getRecipient()

getRecipient() : string

Get the message recipient.

Returns

string —

a short code or long number

setRecipient()

setRecipient(string  $recipient) : void

Set the message recipient.

Parameters

string $recipient

a short code or long number

getSender()

getSender() : string

Get the message sender.

Returns

string —

an MSISDN

setSender()

setSender(string  $sender) : void

Set the message sender.

Parameters

string $sender

an MSISDN

getOperator()

getOperator() : string|null

Get the MCCMNC of the originating operator, if available.

Returns

string|null —

an MCCMNC or null if none is available

setOperator()

setOperator(string|null  $operator) : void

Set the MCCMNC of the originating operator.

Parameters

string|null $operator

an MCCMNC or null if none is available

getSentAt()

getSentAt() : \DateTime|null

Get the time when this message was sent, if available.

Returns

\DateTime|null —

the send date and time

setSentAt()

setSentAt(\DateTime|null  $sentAt) : void

Set the time when this message was sent.

Parameters

\DateTime|null $sentAt

the send date and time

getReceivedAt()

getReceivedAt() : \DateTime

Get the time when the messaging system received this message.

Returns

\DateTime —

the time of receiving the message

setReceivedAt()

setReceivedAt(\DateTime  $receivedAt) : void

Set the time when the messaging system received this message.

Parameters

\DateTime $receivedAt

the time of receiving the message

getBody()

getBody() : string

Get the binary message body.

Returns

string —

binary string

setBody()

setBody(string  $body) : void

Set the binary message body.

Parameters

string $body

binary string

getUdh()

getUdh() : string

Get the user data header.

Returns

string —

user data header

setUdh()

setUdh(string  $udh) : void

Set the user data header.

Parameters

string $udh

user data header