Bitrix API

MessageTrait

The MessageTrait is a common implementation of the Message interface

Table of Contents

Methods

getBody()  : mixed
getCorrelationId()  : string|null
getHeader()  : mixed
getHeaders()  : array<string|int, mixed>
getMessageId()  : string|null
getProperties()  : array<string|int, mixed>
getProperty()  : mixed
getReplyTo()  : string|null
getTimestamp()  : int|null
isRedelivered()  : bool
setBody()  : self
setCorrelationId()  : self
setHeader()  : self
setHeaders()  : self
setMessageId()  : self
setProperties()  : self
setProperty()  : self
setRedelivered()  : self
setReplyTo()  : self
setTimestamp()  : self

Methods

getCorrelationId()

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

getHeader()

public getHeader(string $name[, mixed $default = null ]) : mixed
Parameters
$name : string
$default : mixed = null

getHeaders()

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

getMessageId()

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

getProperties()

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

getProperty()

public getProperty(string $name[, mixed $default = null ]) : mixed
Parameters
$name : string
$default : mixed = null

getReplyTo()

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

getTimestamp()

public getTimestamp() : int|null
Return values
int|null

isRedelivered()

public isRedelivered() : bool
Return values
bool

setBody()

public setBody(mixed $body) : self
Parameters
$body : mixed
Return values
self

setCorrelationId()

public setCorrelationId([string $correlationId = null ]) : self
Parameters
$correlationId : string = null
Return values
self

setHeader()

public setHeader(string $name, mixed $value) : self
Parameters
$name : string
$value : mixed
Return values
self

setHeaders()

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

setMessageId()

public setMessageId([string $messageId = null ]) : self
Parameters
$messageId : string = null
Return values
self

setProperties()

public setProperties(array<string|int, mixed> $properties) : self
Parameters
$properties : array<string|int, mixed>
Return values
self

setProperty()

public setProperty(string $name, mixed $value) : self
Parameters
$name : string
$value : mixed
Return values
self

setRedelivered()

public setRedelivered(bool $redelivered) : self
Parameters
$redelivered : bool
Return values
self

setReplyTo()

public setReplyTo([string $replyTo = null ]) : self
Parameters
$replyTo : string = null
Return values
self

setTimestamp()

public setTimestamp([int $timestamp = null ]) : self
Parameters
$timestamp : int = null
Return values
self

        
On this page

Search results