PHP Sigfox Client

CreateUrlCallback extends CreateCallback

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.
$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
$payloadConfig  : string|null
The custom payload configuration. Only for DATA and DATA_ADVANCED 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
getEnabled()  : bool
Getter for enabled
getHeaders()  : array<string|int, mixed>
Getter for headers
getHttpMethod()  : string
Getter for httpMethod
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
setEnabled()  : static
Setter for enabled
setHeaders()  : static
Setter for headers
setHttpMethod()  : static
Setter for httpMethod
setPayloadConfig()  : static
Setter for payloadConfig
setSendSni()  : static
Setter for sendSni
setUrl()  : static
Setter for url

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

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

$bodyTemplate

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.

protected string|null $bodyTemplate = null

$channel

The callback's channel.

protected string|null $channel = null
  • URL
  • BATCH_URL
  • EMAIL

$contentType

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

protected string|null $contentType = null

$enabled

True to enable the callback, otherwise false

protected bool|null $enabled = null

$headers

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

protected array<string|int, mixed>|null $headers = null

$httpMethod

The http method used to send a callback

protected string|null $httpMethod = null

$payloadConfig

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

protected string|null $payloadConfig = null

$sendSni

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

protected bool|null $sendSni = 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
throws
DeserializeException

If provided an invalid type to a property

Return values
static

getBodyTemplate()

Getter for bodyTemplate

public getBodyTemplate() : string
Return values
string

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.

getChannel()

Getter for channel

public getChannel() : string
Return values
string

The callback's channel.

  • URL
  • BATCH_URL
  • EMAIL

getContentType()

Getter for contentType

public getContentType() : string
Return values
string

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

getEnabled()

Getter for enabled

public getEnabled() : bool
Return values
bool

True to enable the callback, otherwise false

getHeaders()

Getter for headers

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

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

getHttpMethod()

Getter for httpMethod

public getHttpMethod() : string
Return values
string

The http method used to send a callback

getPayloadConfig()

Getter for payloadConfig

public getPayloadConfig() : string
Return values
string

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

getSendSni()

Getter for sendSni

public getSendSni() : bool
Return values
bool

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

getUrl()

Getter for url

public getUrl() : string
Return values
string

The callback's url

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Tags
inheritdoc
Return values
array<string|int, mixed>

setBodyTemplate()

Setter for bodyTemplate

public setBodyTemplate(string $bodyTemplate) : static
Parameters
$bodyTemplate : string

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.

Return values
static

To use in method chains

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

setChannel()

Setter for channel

public setChannel(string $channel) : static
Parameters
$channel : string

The callback's channel.

  • URL
  • BATCH_URL
  • EMAIL
Return values
static

To use in method chains

setContentType()

Setter for contentType

public setContentType(string $contentType) : static
Parameters
$contentType : string

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

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

setHeaders()

Setter for headers

public setHeaders(array<string|int, mixed> $headers) : static
Parameters
$headers : array<string|int, mixed>

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

Return values
static

To use in method chains

setHttpMethod()

Setter for httpMethod

public setHttpMethod(string $httpMethod) : static
Parameters
$httpMethod : string

The http method used to send a callback

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 and DATA_ADVANCED callbacks. This field can be unset when updating.

Return values
static

To use in method chains

setSendSni()

Setter for sendSni

public setSendSni(bool $sendSni) : static
Parameters
$sendSni : bool

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

Return values
static

To use in method chains

setUrl()

Setter for url

public setUrl(string $url) : static
Parameters
$url : string

The callback's url

Return values
static

To use in method chains

Search results