new MessageForward(userMessageId, messageId, mobileId, payloadRaw, payloadJson, mailboxTimeUtc, state, stateTimeUtc, mobileSleepSeconds, mobileWakeupPeriod, scheduledSendTimeUtc)
Represents a Forward (Mobile-Terminated) message
| Name | Type | Description |
|---|---|---|
userMessageId |
number |
optional
Optional user-assigned ID |
messageId |
number |
Network-assigned unique ID |
mobileId |
string |
The destination of the message |
payloadRaw |
Array.<number> |
optional
A decimal byte array payload |
payloadJson |
object |
optional
A JSON structured payload |
mailboxTimeUtc |
string |
ISO timestamp when submitted to the network |
state |
number |
A numeric code representing the delivery state |
stateTimeUtc |
string |
ISO timestamp of the state |
mobileSleepSeconds |
number |
The time the modem is configured to sleep |
mobileWakeupPeriod |
number |
Enumerated value for configurable wakeupPeriod |
scheduledSendTimeUtc |
string |
ISO timestamp for low power message delivery |
Methods
-
getStateName(){string}
infra/database/models/MessageForward.js, line 52 -
Returns a human-readable name for the message state
Returns:
Type Description string -
getStateReason(){string}
infra/database/models/MessageForward.js, line 70 -
Returns a human-readable definition of the errorId
Returns:
Type Description string -
submit(){object}
infra/database/models/MessageForward.js, line 97 -
Returns a cleaned-up message with minimum set of properties for submission via API submitForwardMessages
Returns:
Type Description object Subset of the message -
updateStatus(status)
infra/database/models/MessageForward.js, line 126 -
Updates the message based on a new status retrieved via the IDP API
Name Type Description statusObjet optional forward message object or status
-
wakeupPeriodEnum(){string}
infra/database/models/MessageForward.js, line 88 -
Returns a human-readable value of the wakeupPeriod
Returns:
Type Description string