Класс Message

Открытые члены
	__construct (Sender\Base $sender=null)
	setType (string $type)
	getType ()
	checkFields ()
	send ()
	sendDirectly ()
	getFrom ()
	setFrom ($from)
	getBody ()
	setBody ($body)
	getTo ()
	setTo ($to)
	getSender ()
	setSender (Sender\Base $sender)
	setHeaders (array $headers)
	getHeaders ()
	setAuthorId (int $authorId)
	getAuthorId ()
	getError ()
	setError (Error $error)
	getStatusId ()
	update (array $fields)
	updateWithSendResult (Result\SendMessage $result, DateTime $nextExec)
	updateStatusByExternalStatus (string $externalStatus)
	updateStatus (int $newStatusId)
	setCheckRestrictions (bool $checkRestrictions)

Открытые статические члены
static	loadById (int $id)
static	loadByExternalId (string $senderId, string $externalId, ?string $from=null)
static	createFromFields (array $fields, Sender\Base $sender=null)
static	getFieldsById ($messageId)

Поля данных
const	EVENT_MESSAGE_UPDATED = 'messageUpdated'

Защищенные данные
	$id
	$sender
	$type
	$authorId = 0
	$from
	$to
	$headers = array()
	$body
	$statusId
	$externalStatus
Error	$error = null
bool	$checkRestrictions = false

Подробное описание

См. определение в файле message.php строка 17

Конструктор(ы)

__construct()

__construct

(

Sender\Base

$sender = null

)

Message constructor.

Аргументы

Sender\Base | null

$sender

См. определение в файле message.php строка 50

Методы

checkFields()

checkFields

(

)

См. определение в файле message.php строка 127

createFromFields()

createFromFields ( array $fields, Sender\Base $sender = null )

static

Аргументы

array	$fields
Sender\Base | null	$sender

Возвращает

Message

См. определение в файле message.php строка 89

getAuthorId()

getAuthorId

(

)

Возвращает

int

См. определение в файле message.php строка 394

getBody()

getBody

(

)

Возвращает

mixed

См. определение в файле message.php строка 312

getError()

getError

(

)

Возвращает

Error|null

См. определение в файле message.php строка 402

getFieldsById()

getFieldsById ( $messageId )

static

См. определение в файле message.php строка 97

getFrom()

getFrom

(

)

Возвращает

mixed

См. определение в файле message.php строка 294

getHeaders()

getHeaders

(

)

Возвращает

array

См. определение в файле message.php строка 376

getSender()

getSender

(

)

Возвращает

Sender\Base|null

См. определение в файле message.php строка 348

getStatusId()

getStatusId

(

)

См. определение в файле message.php строка 418

getTo()

getTo

(

)

Возвращает

mixed

См. определение в файле message.php строка 330

getType()

getType

(

)

Возвращает

string

См. определение в файле message.php строка 122

loadByExternalId()

loadByExternalId ( string $senderId, string $externalId, ?string $from = null )

static

См. определение в файле message.php строка 71

loadById()

loadById ( int $id )

static

См. определение в файле message.php строка 58

send()

send

(

)

Возвращает

AddResult Created Message result.

См. определение в файле message.php строка 157

sendDirectly()

sendDirectly

(

)

См. определение в файле message.php строка 207

setAuthorId()

setAuthorId

(

int

$authorId

)

Аргументы

int

$authorId

Возвращает

Message

См. определение в файле message.php строка 385

setBody()

setBody

(

$body

)

Аргументы

mixed

$body

Возвращает

$this

См. определение в файле message.php строка 321

setCheckRestrictions()

setCheckRestrictions

(

bool

$checkRestrictions

)

Аргументы

bool

$checkRestrictions

См. определение в файле message.php строка 610

setError()

setError

(

Error

$error

)

Аргументы

Error

$error

Возвращает

Message

См. определение в файле message.php строка 411

setFrom()

setFrom

(

$from

)

Аргументы

mixed

$from

Возвращает

$this

См. определение в файле message.php строка 303

setHeaders()

setHeaders

(

array

$headers

)

Аргументы

array

$headers

Возвращает

Message

См. определение в файле message.php строка 367

setSender()

setSender

(

Sender\Base

$sender

)

Аргументы

Sender\Base

$sender

Возвращает

$this

См. определение в файле message.php строка 357

setTo()

setTo

(

$to

)

Аргументы

mixed

$to

Возвращает

$this

См. определение в файле message.php строка 339

setType()

setType

(

string

$type

)

Аргументы

string

$type

Возвращает

Message

Исключения

ArgumentTypeException

См. определение в файле message.php строка 108

update()

update

(

array

$fields

)

См. определение в файле message.php строка 423

updateStatus()

updateStatus

(

int

$newStatusId

)

См. определение в файле message.php строка 524

updateStatusByExternalStatus()

updateStatusByExternalStatus

(

string

$externalStatus

)

См. определение в файле message.php строка 494

updateWithSendResult()

updateWithSendResult	(	Result\SendMessage	$result,
		DateTime	$nextExec )

См. определение в файле message.php строка 445

Поля

$authorId

$authorId = 0

protected

См. определение в файле message.php строка 29

$body

$body

protected

См. определение в файле message.php строка 37

$checkRestrictions

bool $checkRestrictions = false

protected

См. определение в файле message.php строка 44

$error

Error $error = null

protected

См. определение в файле message.php строка 42

$externalStatus

$externalStatus

protected

См. определение в файле message.php строка 40

$from

$from

protected

См. определение в файле message.php строка 31

$headers

$headers = array()

protected

См. определение в файле message.php строка 35

$id

$id

protected

См. определение в файле message.php строка 21

$sender

$sender

protected

См. определение в файле message.php строка 24

$statusId

$statusId

protected

См. определение в файле message.php строка 39

$to

$to

protected

См. определение в файле message.php строка 33

$type

$type

protected

См. определение в файле message.php строка 27

EVENT_MESSAGE_UPDATED

const EVENT_MESSAGE_UPDATED = 'messageUpdated'

См. определение в файле message.php строка 19

---

Объявления и описания членов классов находятся в файлах:

• C:/bitrix/modules/messageservice/lib/message.php
• C:/bitrix/modules/calendar/lib/core/queue/message/message.php