EmailCallback extends Callback
Defines the properties needed to create a batch url callback
Table of Contents
- CALLBACK_SUBTYPE_ACKNOWLEDGE = 4
- ACKNOWLEDGE callback sent on a downlink acknowledged message (available for SERVICE callbacks)
- CALLBACK_SUBTYPE_BIDIR = 3
- BIDIR callback for a bidirectional message (available for DATA callbacks)
- CALLBACK_SUBTYPE_DATA_ADVANCED = 6
- DATA_ADVANCED callback sent on a message that can be geolocated (available for SERVICE callbacks)
- CALLBACK_SUBTYPE_GEOLOC = 1
- GEOLOC callback is deprecated and can no be longer be created or edited. This callback is in a read only state to allow for migration to a DATA_ADVANCED callback
- CALLBACK_SUBTYPE_REPEATER = 5
- REPEATER callback triggered when a repeater sends an OOB (available for SERVICE callbacks)
- CALLBACK_SUBTYPE_STATUS = 0
- STATUS callback sending information about the status of a device (available for SERVICE callbacks)
- CALLBACK_SUBTYPE_UPLINK = 2
- UPLINK callback for an uplink message (available for DATA callbacks)
- CALLBACK_TYPE_DATA = 0
- DATA callback delivering uplink messages to a customer platform.
- CALLBACK_TYPE_ERROR = 2
- ERROR callback to ease troubleshooting in case of communication failure.
- CALLBACK_TYPE_SERVICE = 1
- SERVICE callback to enable additional services (see subtypes).
- $callbackSubtype : int|null
- The callback's subtype. The subtype must be valid against its type.
- $callbackType : int|null
- The callback's type.
- $channel : string|null
- The callback's channel.
- $dead : bool|null
- True if last use of the callback fails, otherwise false
- $enabled : bool|null
- True to enable the callback, otherwise false
- $id : string|null
- The callback's identifier
- $message : string|null
- the content of the message.
- $payloadConfig : string|null
- The custom payload configuration. Only for DATA callbacks. This field can be unset when updating.
- $recipient : string|null
- The recipient of the email.
- $subject : string|null
- The subject of the email.
- from() : static
- Initializing a model from an array
- getCallbackSubtype() : int
- Getter for callbackSubtype
- getCallbackType() : int
- Getter for callbackType
- getChannel() : string
- Getter for channel
- getDead() : bool
- Getter for dead
- getEnabled() : bool
- Getter for enabled
- getId() : string
- Getter for id
- getMessage() : string
- Getter for message
- getPayloadConfig() : string
- Getter for payloadConfig
- getRecipient() : string
- Getter for recipient
- getSubject() : string
- Getter for subject
- jsonSerialize() : array<string|int, mixed>
- setCallbackSubtype() : static
- Setter for callbackSubtype
- setCallbackType() : static
- Setter for callbackType
- setChannel() : static
- Setter for channel
- setDead() : static
- Setter for dead
- setEnabled() : static
- Setter for enabled
- setId() : static
- Setter for id
- setMessage() : static
- Setter for message
- setPayloadConfig() : static
- Setter for payloadConfig
- setRecipient() : static
- Setter for recipient
- setSubject() : static
- Setter for subject
Constants
CALLBACK_SUBTYPE_ACKNOWLEDGE
ACKNOWLEDGE callback sent on a downlink acknowledged message (available for SERVICE callbacks)
public
mixed
CALLBACK_SUBTYPE_ACKNOWLEDGE
= 4
CALLBACK_SUBTYPE_BIDIR
BIDIR callback for a bidirectional message (available for DATA callbacks)
public
mixed
CALLBACK_SUBTYPE_BIDIR
= 3
CALLBACK_SUBTYPE_DATA_ADVANCED
DATA_ADVANCED callback sent on a message that can be geolocated (available for SERVICE callbacks)
public
mixed
CALLBACK_SUBTYPE_DATA_ADVANCED
= 6
CALLBACK_SUBTYPE_GEOLOC
GEOLOC callback is deprecated and can no be longer be created or edited. This callback is in a read only state to allow for migration to a DATA_ADVANCED callback
public
mixed
CALLBACK_SUBTYPE_GEOLOC
= 1
CALLBACK_SUBTYPE_REPEATER
REPEATER callback triggered when a repeater sends an OOB (available for SERVICE callbacks)
public
mixed
CALLBACK_SUBTYPE_REPEATER
= 5
CALLBACK_SUBTYPE_STATUS
STATUS callback sending information about the status of a device (available for SERVICE callbacks)
public
mixed
CALLBACK_SUBTYPE_STATUS
= 0
CALLBACK_SUBTYPE_UPLINK
UPLINK callback for an uplink message (available for DATA callbacks)
public
mixed
CALLBACK_SUBTYPE_UPLINK
= 2
CALLBACK_TYPE_DATA
DATA callback delivering uplink messages to a customer platform.
public
mixed
CALLBACK_TYPE_DATA
= 0
CALLBACK_TYPE_ERROR
ERROR callback to ease troubleshooting in case of communication failure.
public
mixed
CALLBACK_TYPE_ERROR
= 2
CALLBACK_TYPE_SERVICE
SERVICE callback to enable additional services (see subtypes).
public
mixed
CALLBACK_TYPE_SERVICE
= 1
Properties
$callbackSubtype
The callback's subtype. The subtype must be valid against its type.
protected
int|null
$callbackSubtype
= null
$callbackType
The callback's type.
protected
int|null
$callbackType
= null
$channel
The callback's channel.
protected
string|null
$channel
= null
- URL
- BATCH_URL
$dead
True if last use of the callback fails, otherwise false
protected
bool|null
$dead
= null
$enabled
True to enable the callback, otherwise false
protected
bool|null
$enabled
= null
$id
The callback's identifier
protected
string|null
$id
= null
$message
the content of the message.
protected
string|null
$message
= null
$payloadConfig
The custom payload configuration. Only for DATA callbacks. This field can be unset when updating.
protected
string|null
$payloadConfig
= null
$recipient
The recipient of the email.
protected
string|null
$recipient
= null
$subject
The subject of the email.
protected
string|null
$subject
= null
Methods
from()
Initializing a model from an array
public
static from(array<string|int, mixed> $params) : static
Parameters
- $params : array<string|int, mixed>
-
Pass this parameter if you want to initial property value from an array. See API reference for all property names and types
Tags
Return values
static —getCallbackSubtype()
Getter for callbackSubtype
public
getCallbackSubtype() : int
Return values
int —The callback's subtype. The subtype must be valid against its type.
getCallbackType()
Getter for callbackType
public
getCallbackType() : int
Return values
int —The callback's type.
getChannel()
Getter for channel
public
getChannel() : string
Return values
string —The callback's channel.
- URL
- BATCH_URL
getDead()
Getter for dead
public
getDead() : bool
Return values
bool —True if last use of the callback fails, otherwise false
getEnabled()
Getter for enabled
public
getEnabled() : bool
Return values
bool —True to enable the callback, otherwise false
getId()
Getter for id
public
getId() : string
Return values
string —The callback's identifier
getMessage()
Getter for message
public
getMessage() : string
Return values
string —the content of the message.
getPayloadConfig()
Getter for payloadConfig
public
getPayloadConfig() : string
Return values
string —The custom payload configuration. Only for DATA callbacks. This field can be unset when updating.
getRecipient()
Getter for recipient
public
getRecipient() : string
Return values
string —The recipient of the email.
getSubject()
Getter for subject
public
getSubject() : string
Return values
string —The subject of the email.
jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —setCallbackSubtype()
Setter for callbackSubtype
public
setCallbackSubtype(int $callbackSubtype) : static
Parameters
- $callbackSubtype : int
-
The callback's subtype. The subtype must be valid against its type.
Return values
static —To use in method chains
setCallbackType()
Setter for callbackType
public
setCallbackType(int $callbackType) : static
Parameters
- $callbackType : int
-
The callback's type.
Return values
static —To use in method chains
setChannel()
Setter for channel
public
setChannel(string $channel) : static
Parameters
- $channel : string
-
The callback's channel.
- URL
- BATCH_URL
Return values
static —To use in method chains
setDead()
Setter for dead
public
setDead(bool $dead) : static
Parameters
- $dead : bool
-
True if last use of the callback fails, otherwise false
Return values
static —To use in method chains
setEnabled()
Setter for enabled
public
setEnabled(bool $enabled) : static
Parameters
- $enabled : bool
-
True to enable the callback, otherwise false
Return values
static —To use in method chains
setId()
Setter for id
public
setId(string $id) : static
Parameters
- $id : string
-
The callback's identifier
Return values
static —To use in method chains
setMessage()
Setter for message
public
setMessage(string $message) : static
Parameters
- $message : string
-
the content of the message.
Return values
static —To use in method chains
setPayloadConfig()
Setter for payloadConfig
public
setPayloadConfig(string $payloadConfig) : static
Parameters
- $payloadConfig : string
-
The custom payload configuration. Only for DATA callbacks. This field can be unset when updating.
Return values
static —To use in method chains
setRecipient()
Setter for recipient
public
setRecipient(string $recipient) : static
Parameters
- $recipient : string
-
The recipient of the email.
Return values
static —To use in method chains
setSubject()
Setter for subject
public
setSubject(string $subject) : static
Parameters
- $subject : string
-
The subject of the email.
Return values
static —To use in method chains