PHP Sigfox Client

UrlCallback extends Callback

Defines the properties needed to create a 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).

$bodyTemplate  : string|null

The body template of the request. Only if httpMethpd is set to POST or PUT. It can contain predefined and custom variables. Mandatory for URL callbacks. This field can be unset when updating.

$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.

$contentType  : string|null

The body media type of the request, only if httpMethpd is set to POST or PUT. This field can be unset when updating.

$dead  : bool|null

True if last use of the callback fails, otherwise false

$downlinkHook  : bool|null

True if this callback is used for downlink, else false.

$enabled  : bool|null

True to enable the callback, otherwise false

$headers  : array<string|int, mixed>|null

The headers of the http request to send, as an object with key:value. This field can be unset when updating.

$httpMethod  : string|null

The http method used to send a callback

$id  : string|null

The callback's identifier

$payloadConfig  : string|null

The custom payload configuration. Only for DATA callbacks. This field can be unset when updating.

$sendSni  : bool|null

Send SNI (Server Name Indication) for SSL/TLS connections. Used by BATCH_URL and URL callbacks (optional).

$url  : string|null

The callback's url

from()  : static

Initializing a model from an array

getBodyTemplate()  : string

Getter for bodyTemplate

getCallbackSubtype()  : int

Getter for callbackSubtype

getCallbackType()  : int

Getter for callbackType

getChannel()  : string

Getter for channel

getContentType()  : string

Getter for contentType

getDead()  : bool

Getter for dead

getDownlinkHook()  : bool

Getter for downlinkHook

getEnabled()  : bool

Getter for enabled

getHeaders()  : array<string|int, mixed>

Getter for headers

getHttpMethod()  : string

Getter for httpMethod

getId()  : string

Getter for id

getPayloadConfig()  : string

Getter for payloadConfig

getSendSni()  : bool

Getter for sendSni

getUrl()  : string

Getter for url

jsonSerialize()  : array<string|int, mixed>

setBodyTemplate()  : static

Setter for bodyTemplate

setCallbackSubtype()  : static

Setter for callbackSubtype

setCallbackType()  : static

Setter for callbackType

setChannel()  : static

Setter for channel

setContentType()  : static

Setter for contentType

setDead()  : static

Setter for dead

setDownlinkHook()  : static

Setter for downlinkHook

setEnabled()  : static

Setter for enabled

setHeaders()  : static

Setter for headers

setHttpMethod()  : static

Setter for httpMethod

setId()  : static

Setter for id

setPayloadConfig()  : static

Setter for payloadConfig

setSendSni()  : static

Setter for sendSni

setUrl()  : static

Setter for url