Bitrix API

Message

Table of Contents

Methods

getContent()  : string
getMeta()  : mixed
getRole()  : string|null
retrieveFromArray()  : self|null
Transforms incoming message array to Message instance.
retrieveFromArrays()  : array<string|int, self>
Transforms incoming messages arrays to array of Message instance.
toArray()  : array<string|int, mixed>

Methods

getContent()

public getContent() : string
Return values
string

getMeta()

public getMeta([string|null $key = null ]) : mixed
Parameters
$key : string|null = null

getRole()

public getRole([string|null $defaultRole = null ]) : string|null
Parameters
$defaultRole : string|null = null
Return values
string|null

retrieveFromArray()

Transforms incoming message array to Message instance.

public static retrieveFromArray(array<string|int, mixed> $message) : self|null
Parameters
$message : array<string|int, mixed>

Row message array.

Return values
self|null

retrieveFromArrays()

Transforms incoming messages arrays to array of Message instance.

public static retrieveFromArrays(array<string|int, mixed> $messages) : array<string|int, self>

Wrapper helper for retrieveFromArray.

Parameters
$messages : array<string|int, mixed>

Row message array.

Return values
array<string|int, self>

toArray()

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

        
On this page

Search results