Bitrix API

MessageData implements JsonSerializable, Arrayable

FinalYes

Table of Contents

Interfaces

JsonSerializable
Arrayable

Constants

INTEGRITY_STATE_FAIL  = 'fail'
INTEGRITY_STATE_SUCCESS  = 'success'
STATUS_DELIVERED  = 'delivered'
STATUS_ERROR  = 'error'
STATUS_SENT  = 'sent'

Methods

createFromArray()  : self
getAuthor()  : string|null
getChannel()  : Channel
getDescription()  : string|null
Error message / delivery time / etc.
getError()  : Error|null
getGoskeyOrderId()  : string|null
getIntegrityState()  : string|null
getProviderName()  : string|null
getRecipient()  : Signer
getSesSign()  : string|null
getSesUsername()  : string|null
getStatus()  : string
getSubject()  : string|null
isStatusDelivered()  : bool
isStatusError()  : bool
isStatusSent()  : bool
jsonSerialize()  : array<string|int, mixed>
setAuthor()  : MessageData
setDescription()  : self
setError()  : MessageData
setGoskeyOrderId()  : static
setIntegrityState()  : MessageData
setProviderName()  : MessageData
setSesSign()  : MessageData
setSesUsername()  : MessageData
setStatus()  : self
setSubject()  : MessageData
toArray()  : array<string|int, mixed>

Constants

INTEGRITY_STATE_FAIL

public mixed INTEGRITY_STATE_FAIL = 'fail'

INTEGRITY_STATE_SUCCESS

public mixed INTEGRITY_STATE_SUCCESS = 'success'

STATUS_DELIVERED

public mixed STATUS_DELIVERED = 'delivered'

Methods

createFromArray()

public static createFromArray(array<string|int, mixed> $data) : self
Parameters
$data : array<string|int, mixed>
Return values
self

getAuthor()

public getAuthor() : string|null
Return values
string|null

getDescription()

Error message / delivery time / etc.

public getDescription() : string|null
Return values
string|null

getError()

public getError() : Error|null
Return values
Error|null

getGoskeyOrderId()

public getGoskeyOrderId() : string|null
Return values
string|null

getIntegrityState()

public getIntegrityState() : string|null
Return values
string|null

getProviderName()

public getProviderName() : string|null
Return values
string|null

getSesSign()

public getSesSign() : string|null
Return values
string|null

getSesUsername()

public getSesUsername() : string|null
Return values
string|null

getStatus()

public getStatus() : string
Return values
string

getSubject()

public getSubject() : string|null
Return values
string|null

isStatusDelivered()

public isStatusDelivered() : bool
Return values
bool

isStatusError()

public isStatusError() : bool
Return values
bool

isStatusSent()

public isStatusSent() : bool
Return values
bool

jsonSerialize()

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

setDescription()

public setDescription(string|null $description) : self
Parameters
$description : string|null
Return values
self

setGoskeyOrderId()

public setGoskeyOrderId(string|null $id) : static
Parameters
$id : string|null
Return values
static

setStatus()

public setStatus(string $status) : self
Parameters
$status : string
Return values
self

toArray()

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

        
On this page

Search results