Bitrix API

Params extends Registry

Tags

implements

Table of Contents

Constants

ATTACH  = 'ATTACH'

AVATAR  = 'AVATAR'

BETA  = 'BETA'

CALL_ID  = 'CALL_ID'

CAN_ANSWER  = 'CAN_ANSWER'

CHAT_ID  = 'CHAT_ID'

CHAT_LAST_DATE  = 'CHAT_LAST_DATE'

CHAT_MESSAGE  = 'CHAT_MESSAGE'

CHAT_USER  = 'CHAT_USER'

CODE  = 'CODE'

COMPONENT_ID  = 'COMPONENT_ID'

COMPONENT_PARAMS  = 'COMPONENT_PARAMS'

COPILOT_PROMPT_CODE  = 'COPILOT_PROMPT_CODE'

COPILOT_ROLE  = 'COPILOT_ROLE'

CRM_FORM_FILLED  = 'CRM_FORM_FILLED'

CRM_FORM_ID  = 'CRM_FORM_ID'

CRM_FORM_SEC  = 'CRM_FORM_SEC'

DATE_TEXT  = 'DATE_TEXT'

DATE_TS  = 'DATE_TS'

EVENT_MESSAGE_PARAM_TYPE_INIT  = 'OnMessageParamTypesInit'

FAVORITE  = 'FAVORITE'

FILE_ID  = 'FILE_ID'

FORWARD_CHAT_TITLE  = 'FORWARD_CHAT_TITLE'

FORWARD_CONTEXT_ID  = 'FORWARD_CONTEXT_ID'

FORWARD_ID  = 'FORWARD_ID'

FORWARD_USER_ID  = 'FORWARD_USER_ID'

IS_DELETED  = 'IS_DELETED'

IS_DELIVERED  = 'IS_DELIVERED'

IS_EDITED  = 'IS_EDITED'

IS_ERROR  = 'IS_ERROR'

IS_PINNED  = 'IS_PINNED'

IS_ROBOT_MESSAGE  = 'IS_ROBOT_MESSAGE'

KEYBOARD  = 'KEYBOARD'

KEYBOARD_ACTION  = 'KEYBOARD_ACTION'

KEYBOARD_UID  = 'KEYBOARD_UID'

LARGE_FONT  = 'LARGE_FONT'

LIKE  = 'LIKE'

LINK_ACTIVE  = 'LINK_ACTIVE'

MENU  = 'MENU'

NAME  = 'NAME'

NOTIFY  = 'NOTIFY'

REPLY_ID  = 'REPLY_ID'

SENDING  = 'SENDING'

SENDING_TS  = 'SENDING_TS'

STYLE_CLASS  = 'CLASS'

TYPE  = 'TYPE'

URL_ID  = 'URL_ID'

URL_ONLY  = 'URL_ONLY'

USER_ID  = 'USER_ID'

USERS  = 'USERS'

Methods

__clone()  : mixed

add()  : self

addType()  : void

Add new message parameter description.

create()  : MessageParameter

Returns instance of Parameter.

delete()  : Result

Drops all message params.

fill()  : self

filter()  : $this

get()  : MessageParameter

getAny()  : T|null

getMessageId()  : int|null

getType()  : array<string|int, mixed>

Returns message parameter description.

initTypes()  : void

Loads specific modules message parameter types from .settings.php.

isLoaded()  : bool

Tells true if paraams have been loaded from DB.

isSet()  : bool

isValid()  : Result

load()  : Result

loadByMessage()  : Result

loadByMessageId()  : Result

merge()  : static

offsetExists()  : bool

offsetGet()  : MessageParameter

offsetSet()  : void

Alias to add method.

offsetUnset()  : void

remove()  : self

save()  : Result

Saves changes.

set()  : self

setMessageId()  : $this

toArray()  : mixed

toPullFormat()  : array<string|int, mixed>

toRestFormat()  : array<string, string|array<string|int, mixed>>

unsetByKeys()  : void