messageparam.php

См. документацию.

<?php declare(strict_types=1);
 
namespace Bitrix\Im\Services;

class MessageParam
{
    private $isEnabled;
 
    public function __construct()
    {
        $this->isEnabled = \Bitrix\Main\Loader::includeModule('im');
    }

    public function getParams(int $messageId, bool $withDefault = false): ?array
    {
        if ($this->isEnabled)
        {
            return \CIMMessageParam::Get($messageId, false, $withDefault) ?: null;
        }
 
        return null;
    }

    public function getParam(int $messageId, string $name, bool $withDefault = false)
    {
        if ($this->isEnabled)
        {
            return \CIMMessageParam::Get($messageId, $name, $withDefault) ?: null;
        }
 
        return null;
    }

    public function setParams(int $messageId, array $values, bool $sendPull = true): bool
    {
        if ($this->isEnabled)
        {
            if ($sendPull)
            {
                return
                    \CIMMessageParam::Set($messageId, $values)
                    && \CIMMessageParam::SendPull($messageId, array_keys($values))
                ;
            }
            else
            {
                return \CIMMessageParam::Set($messageId, $values);
            }
        }
 
        return false;
    }

    public function setParam(int $messageId, string $name, $value, bool $sendPull = true): bool
    {
        if ($this->isEnabled)
        {
            if ($sendPull)
            {
                return
                    \CIMMessageParam::Set($messageId, [$name => $value])
                    && \CIMMessageParam::SendPull($messageId, [$name])
                ;
            }
            else
            {
                return \CIMMessageParam::Set($messageId, [$name => $value]);
            }
        }
 
        return false;
    }
}