|
| __construct (public string readonly string $recipientnumber, public null|string readonly ?string $content, public string readonly string $component, public string readonly string $messagetype, public int|null readonly ?int $recipientuserid, public bool readonly bool $issensitive, public null|int readonly ?int $id=null, public message_status readonly message_status $status=message_status::UNKNOWN, public null|int readonly ?int $gatewayid=null, ?int $timecreated=null,) |
| Create a new message.
|
|
| get_region () |
| Get the region code for this messages.
|
|
| is_sent () |
| Check if the message has been sent.
|
|
| to_record () |
| Convert the message to a record.
|
|
| with (... $args) |
| Update the message properties.
|
|
|
int readonly int | $timecreated |
| The time that the message was created.
|
|
◆ __construct()
core_sms\message::__construct |
( |
public string readonly string | $recipientnumber, |
|
|
public null|string readonly ?string | $content, |
|
|
public string readonly string | $component, |
|
|
public string readonly string | $messagetype, |
|
|
public int|null readonly ?int | $recipientuserid, |
|
|
public bool readonly bool | $issensitive, |
|
|
public null|int readonly ?int | $id = null, |
|
|
public message_status readonly message_status | $status = message_status::UNKNOWN, |
|
|
public null|int readonly ?int | $gatewayid = null, |
|
|
?int | $timecreated = null ) |
Create a new message.
- Parameters
-
string | $recipientnumber | The phone number of the message recipient |
null | string | $content | The content of the message |
string | $component | The component that owns the message |
string | $messagetype | The type of message within the component |
int | null | $recipientuserid | The user id of the recipient if one exists |
bool | $issensitive | Whether this message contains sensitive information |
int | null | $id | The id of the message in the database |
message_status | $status | The status of the message |
int | null | $gatewayid | The id of the gateway that sent the message |
int | null | $timecreated | The time that the message was created |
- Parameters
-
$recipientnumber | The phone number of the message recipient |
$content | The content of the message |
$component | The component that owns the message |
$messagetype | The type of message within the component |
$recipientuserid | The user id of the recipient if one exists |
$issensitive | Whether this message contains sensitive information |
$id | The id of the message in the database |
$status | The status of the message |
$gatewayid | The id of the gateway that sent the message |
◆ get_region()
core_sms\message::get_region |
( |
| ) |
|
Get the region code for this messages.
- Return values
-
◆ is_sent()
core_sms\message::is_sent |
( |
| ) |
|
Check if the message has been sent.
- Return values
-
◆ to_record()
core_sms\message::to_record |
( |
| ) |
|
Convert the message to a record.
- Return values
-
◆ with()
core_sms\message::with |
( |
| ... | ) |
|
Update the message properties.
Note: The message is immutable. When setting the status a new object will be returned.
- Parameters
-
- Return values
-
The documentation for this class was generated from the following file: