Открытые статические члены
static	register (array $fields)
static	unRegister (array $bot)
static	update (array $bot, array $updateFields)
static	sendPullNotify ($botId, $messageType)
static	sendPullOpenDialog (int $botId, int $userId=null)
static	onMessageAdd ($messageId, $messageFields)
static	onMessageUpdate ($messageId, $messageFields)
static	onMessageDelete ($messageId, $messageFields)
static	onJoinChat ($dialogId, $joinFields)
static	onLeaveChat ($dialogId, $leaveFields)
static	onContextGet (\Bitrix\Im\V2\Chat $chat, array $params)
static	startWriting (array $bot, $dialogId, $userName='')
static	setChatBackgroundId (array $bot, $dialogId, string $backgroundId)
static	enableChatTextField (array $bot, $dialogId)
static	disableChatTextField (array $bot, $dialogId)
static	addMessage (array $bot, array $messageFields)
static	updateMessage (array $bot, array $messageFields)
static	deleteMessage (array $bot, $messageId)
static	likeMessage (array $bot, $messageId, $action='AUTO')
static	getDialogId ($messageFields)
static	getDialogIdByChat (\Bitrix\Im\V2\Chat $chat)
static	getCache ($botId)
static	clearCache ()
static	getListCache ($type=self::LIST_ALL)
static	getListForJs ()
static	getDefaultLanguage ()
static	deleteExpiredTokenAgent ()
static	setPlatformContext (string $context)

Поля данных
const	BACKGROUND_MARTA = 'martaAI'
const	BACKGROUND_COPILOT = 'copilot'
const	BACKGROUND_COLLAB = 'collab'
const	BACKGROUND_NONE = ''
const	INSTALL_TYPE_SYSTEM = 'system'
const	INSTALL_TYPE_USER = 'user'
const	INSTALL_TYPE_SILENT = 'silent'
const	LOGIN_START = 'bot_'
const	EXTERNAL_AUTH_ID = 'bot'
const	LIST_ALL = 'all'
const	LIST_OPENLINE = 'openline'
const	TYPE_HUMAN = 'H'
const	TYPE_BOT = 'B'
const	TYPE_SUPERVISOR = 'S'
const	TYPE_NETWORK = 'N'
const	TYPE_OPENLINE = 'O'
const	CACHE_TTL = 31536000
const	CACHE_PATH = '/bx/im/bot/old_cache_v1/'
const	PLATFORM_CONTEXT_MOBILE = 'mobile'
const	PLATFORM_CONTEXT_WEB = 'web'

Защищенные статические члены
static	addAdditionalParams (array $params)
static	resolvePlatformContext (string $context)
static	getPlatformContext ()

Статические защищенные данные
static string	$platformContext = null

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

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

Методы

◆ addAdditionalParams()

addAdditionalParams ( array $params )

staticprotected

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

◆ addMessage()

addMessage	(	array	$bot,
		array	$messageFields )

static

Аргументы

array

$bot

[
    (int) BOT_ID
    (string) MODULE_ID
    (string) APP_ID
]

array

$messageFields

[
    (int) MESSAGE_ID
    (int) FROM_USER_ID
    (int) TO_USER_ID
    (string|int) DIALOG_ID
    (array) PARAMS
    (array) ATTACH
    (array) KEYBOARD
    (array) MENU
    (string) MESSAGE
    (string) URL_PREVIEW - Y|N
    (string) SYSTEM - Y|N
    (string) SKIP_CONNECTOR - Y|N
    (string) EDIT_FLAG - Y|N
]

Возвращает: bool

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

◆ clearCache()

clearCache ( )

static

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

◆ deleteExpiredTokenAgent()

deleteExpiredTokenAgent ( )

static

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

◆ deleteMessage()

deleteMessage	(	array	$bot,
			$messageId )

static

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

◆ disableChatTextField()

disableChatTextField	(	array	$bot,
			$dialogId )

static

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

◆ enableChatTextField()

enableChatTextField	(	array	$bot,
			$dialogId )

static

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

◆ getCache()

getCache ( $botId )

static

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

◆ getDefaultLanguage()

getDefaultLanguage ( )

static

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

◆ getDialogId()

getDialogId ( $messageFields )

static

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

◆ getDialogIdByChat()

getDialogIdByChat ( \Bitrix\Im\V2\Chat $chat )

static

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

◆ getListCache()

getListCache ( $type = self::LIST_ALL )

static

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

◆ getListForJs()

getListForJs ( )

static

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

◆ getPlatformContext()

getPlatformContext ( )

staticprotected

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

◆ likeMessage()

likeMessage	(	array	$bot,
			$messageId,
			$action = 'AUTO' )

static

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

◆ onContextGet()

onContextGet	(	\Bitrix\Im\V2\Chat	$chat,
		array	$params )

static

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

◆ onJoinChat()

onJoinChat	(		$dialogId,
			$joinFields )

static

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

◆ onLeaveChat()

onLeaveChat	(		$dialogId,
			$leaveFields )

static

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

◆ onMessageAdd()

onMessageAdd	(		$messageId,
			$messageFields )

static

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

◆ onMessageDelete()

onMessageDelete	(		$messageId,
			$messageFields )

static

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

◆ onMessageUpdate()

onMessageUpdate	(		$messageId,
			$messageFields )

static

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

◆ register()

register ( array $fields )

static

Аргументы

array $fields

Возвращает: int|bool

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

◆ resolvePlatformContext()

resolvePlatformContext ( string $context )

staticprotected

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

◆ sendPullNotify()

sendPullNotify	(		$botId,
			$messageType )

static

Аргументы

int	$botId	Bot Id.
string	$messageType	Notify type - addBot\|updateBot\|deleteBot

Возвращает: bool

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

◆ sendPullOpenDialog()

sendPullOpenDialog	(	int	$botId,
		int	$userId = null )

static

Аргументы

int	$botId	Bot Id.
int \| null	$userId	User Id.

Возвращает: bool

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

◆ setChatBackgroundId()

setChatBackgroundId	(	array	$bot,
			$dialogId,
		string	$backgroundId )

static

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

◆ setPlatformContext()

setPlatformContext ( string $context )

static

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

◆ startWriting()

startWriting	(	array	$bot,
			$dialogId,
			$userName = '' )

static

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

◆ unRegister()

unRegister ( array $bot )

static

Аргументы

array $bot

Возвращает: bool

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

◆ update()

update	(	array	$bot,
		array	$updateFields )

static

Аргументы

array	$bot
array	$updateFields

Возвращает: bool

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

◆ updateMessage()

updateMessage	(	array	$bot,
		array	$messageFields )

static

Аргументы

array

$bot

[
    (int) BOT_ID
    (string) MODULE_ID
    (string) APP_ID
]

array

$messageFields

[
    (int) MESSAGE_ID
    (array) ATTACH
    (array) KEYBOARD
    (array) MENU
    (string) MESSAGE
    (string) URL_PREVIEW - Y|N
    (string) SKIP_CONNECTOR - Y|N
    (string) EDIT_FLAG - Y|N
]

Возвращает: bool

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

Поля

◆ $platformContext

string $platformContext = null

staticprotected

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

◆ BACKGROUND_COLLAB

const BACKGROUND_COLLAB = 'collab'

См. также: BackgroundId::Copilot

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

◆ BACKGROUND_COPILOT

const BACKGROUND_COPILOT = 'copilot'

См. также: BackgroundId::MartaAI

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

◆ BACKGROUND_MARTA

const BACKGROUND_MARTA = 'martaAI'

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

◆ BACKGROUND_NONE

const BACKGROUND_NONE = ''

См. также: BackgroundId::Collab

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

◆ CACHE_PATH

const CACHE_PATH = '/bx/im/bot/old_cache_v1/'

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

◆ CACHE_TTL

const CACHE_TTL = 31536000

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

◆ EXTERNAL_AUTH_ID

const EXTERNAL_AUTH_ID = 'bot'

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

◆ INSTALL_TYPE_SILENT

const INSTALL_TYPE_SILENT = 'silent'

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

◆ INSTALL_TYPE_SYSTEM

const INSTALL_TYPE_SYSTEM = 'system'

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

◆ INSTALL_TYPE_USER

const INSTALL_TYPE_USER = 'user'

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

◆ LIST_ALL

const LIST_ALL = 'all'

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

◆ LIST_OPENLINE

const LIST_OPENLINE = 'openline'

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

◆ LOGIN_START

const LOGIN_START = 'bot_'

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

◆ PLATFORM_CONTEXT_MOBILE

const PLATFORM_CONTEXT_MOBILE = 'mobile'

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

◆ PLATFORM_CONTEXT_WEB

const PLATFORM_CONTEXT_WEB = 'web'

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

◆ TYPE_BOT

const TYPE_BOT = 'B'

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

◆ TYPE_HUMAN

const TYPE_HUMAN = 'H'

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

◆ TYPE_NETWORK

const TYPE_NETWORK = 'N'

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

◆ TYPE_OPENLINE

const TYPE_OPENLINE = 'O'

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

◆ TYPE_SUPERVISOR

const TYPE_SUPERVISOR = 'S'

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

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

C:/bitrix/modules/im/lib/bot.php

Открытые статические члены

Поля данных

Защищенные статические члены

Статические защищенные данные

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

Методы

◆ addAdditionalParams()

◆ addMessage()

◆ clearCache()

◆ deleteExpiredTokenAgent()

◆ deleteMessage()

◆ disableChatTextField()

◆ enableChatTextField()

◆ getCache()

◆ getDefaultLanguage()

◆ getDialogId()

◆ getDialogIdByChat()

◆ getListCache()

◆ getListForJs()

◆ getPlatformContext()

◆ likeMessage()

◆ onContextGet()

◆ onJoinChat()

◆ onLeaveChat()

◆ onMessageAdd()

◆ onMessageDelete()

◆ onMessageUpdate()

◆ register()

◆ resolvePlatformContext()

◆ sendPullNotify()

◆ sendPullOpenDialog()

◆ setChatBackgroundId()

◆ setPlatformContext()

◆ startWriting()

◆ unRegister()

◆ update()

◆ updateMessage()

Поля

◆ $platformContext

◆ BACKGROUND_COLLAB

◆ BACKGROUND_COPILOT

◆ BACKGROUND_MARTA

◆ BACKGROUND_NONE

◆ CACHE_PATH

◆ CACHE_TTL

◆ EXTERNAL_AUTH_ID

◆ INSTALL_TYPE_SILENT

◆ INSTALL_TYPE_SYSTEM

◆ INSTALL_TYPE_USER

◆ LIST_ALL

◆ LIST_OPENLINE

◆ LOGIN_START

◆ PLATFORM_CONTEXT_MOBILE

◆ PLATFORM_CONTEXT_WEB

◆ TYPE_BOT

◆ TYPE_HUMAN

◆ TYPE_NETWORK

◆ TYPE_OPENLINE

◆ TYPE_SUPERVISOR