1C-Bitrix 25.700.0
Загрузка...
Поиск...
Не найдено
Класс Message
Граф наследования:Message:
BaseController

Открытые члены

 getPrimaryAutoWiredParameter ()
 getAutoWiredParameters ()
 configureActions ()
 readAction (MessageCollection $messages)
 tailViewersAction (\Bitrix\Im\V2\Message $message, array $filter=[], array $order=[], int $limit=50)
 markAction (\Bitrix\Im\V2\Message $message)
 listAction (Chat $chat, int $limit=self::MESSAGE_ON_PAGE_COUNT, string $ignoreMark='N')
 getContextAction (\Bitrix\Im\V2\Message $message, int $range=self::MESSAGE_ON_PAGE_COUNT)
 tailAction (Chat $chat, array $filter=[], array $order=[], int $limit=50)
 searchAction (Chat $chat, array $filter=[], array $order=[], int $limit=50)
 pinAction (\Bitrix\Im\V2\Message $message)
 unpinAction (\Bitrix\Im\V2\Message $message)
 deleteAction (\Bitrix\Im\V2\MessageCollection $messages)
 disappearAction (\Bitrix\Im\V2\Message $message, int $hours)
 sendAction (Chat $chat, ?\CRestServer $restServer=null, array $fields=[], ?MessageCollection $forwardMessages=null)
 updateAction (\Bitrix\Im\V2\Message $message, ?\CRestServer $restServer=null, array $fields=[], string $urlPreview='Y', int $botId=0)
 informAction (\Bitrix\Im\V2\Message $message)
 deleteRichUrlAction (\Bitrix\Im\V2\Message $message, CurrentUser $user)

Защищенные члены

 prepareParamsForTail (Chat $chat, array $filter, array $order)
 prepareParamsForSearch (Chat $chat, array $filter, array $order)
 getMessages (array $filter, array $order, int $limit)
Защищенные члены унаследованные от BaseController
 getDefaultPreFilters ()
 getLimit (int $limit)
 toRestFormat (RestConvertible ... $entities)
 load (\Bitrix\Im\V2\Chat $chat, int $messageLimit, int $pinLimit, bool $ignoreMark=false, ?Message $targetMessage=null)
 toRestFormatWithPaginationData (array $entities, int $needCount, int $realCount)
 checkWhiteList (array $fields, array $whiteList)
 getChatByPostId (int $postId, bool $createIfNotExists)
 getMessagesByIds (array $ids)
 convertCharToBool (string $char, bool $default=false)
 getRawValue (string $key)
 prepareFields (array $fields, array $whiteList)

Защищенные данные

const MAX_MESSAGES_COUNT = 100
const MESSAGE_ON_PAGE_COUNT = 50
Защищенные данные унаследованные от BaseController
const MAX_LIMIT = 200
const DEFAULT_LIMIT = 50
const MAX_MESSAGES_COUNT = 100

Дополнительные унаследованные члены

Открытые статические члены унаследованные от BaseController
static recursiveWhiteList ($fields, $whiteList, bool $sanitizeOnly=false)

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

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

Методы

◆ configureActions()

configureActions ( )

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

◆ deleteAction()

deleteAction ( \Bitrix\Im\V2\MessageCollection $messages)

@restMethod im.v2.Chat.Message.delete

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

◆ deleteRichUrlAction()

deleteRichUrlAction ( \Bitrix\Im\V2\Message $message,
CurrentUser $user )

@restMethod im.v2.Chat.Message.deleteRichUrl

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

◆ disappearAction()

disappearAction ( \Bitrix\Im\V2\Message $message,
int $hours )

@restMethod im.v2.Chat.Message.disappear

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

◆ getAutoWiredParameters()

getAutoWiredParameters ( )

Переопределяет метод предка BaseController.

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

◆ getContextAction()

getContextAction ( \Bitrix\Im\V2\Message $message,
int $range = self::MESSAGE_ON_PAGE_COUNT )

@restMethod im.v2.Chat.Message.getContext

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

◆ getMessages()

getMessages ( array $filter,
array $order,
int $limit )
protected

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

◆ getPrimaryAutoWiredParameter()

getPrimaryAutoWiredParameter ( )

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

◆ informAction()

informAction ( \Bitrix\Im\V2\Message $message)

@restMethod im.v2.Chat.Message.inform

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

◆ listAction()

listAction ( Chat $chat,
int $limit = self::MESSAGE_ON_PAGE_COUNT,
string $ignoreMark = 'N' )

@restMethod im.v2.Chat.Message.list

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

◆ markAction()

markAction ( \Bitrix\Im\V2\Message $message)

@restMethod im.v2.Chat.Message.mark

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

◆ pinAction()

pinAction ( \Bitrix\Im\V2\Message $message)

@restMethod im.v2.Chat.Message.pin

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

◆ prepareParamsForSearch()

prepareParamsForSearch ( Chat $chat,
array $filter,
array $order )
protected

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

◆ prepareParamsForTail()

prepareParamsForTail ( Chat $chat,
array $filter,
array $order )
protected

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

◆ readAction()

readAction ( MessageCollection $messages)

@restMethod im.v2.Chat.Message.read

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

◆ searchAction()

searchAction ( Chat $chat,
array $filter = [],
array $order = [],
int $limit = 50 )

@restMethod im.v2.Chat.Message.search

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

◆ sendAction()

sendAction ( Chat $chat,
?\CRestServer $restServer = null,
array $fields = [],
?MessageCollection $forwardMessages = null )

@restMethod im.v2.Chat.Message.send

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

◆ tailAction()

tailAction ( Chat $chat,
array $filter = [],
array $order = [],
int $limit = 50 )

@restMethod im.v2.Chat.Message.tail

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

◆ tailViewersAction()

tailViewersAction ( \Bitrix\Im\V2\Message $message,
array $filter = [],
array $order = [],
int $limit = 50 )

@restMethod im.v2.Chat.Message.tailViewers

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

◆ unpinAction()

unpinAction ( \Bitrix\Im\V2\Message $message)

@restMethod im.v2.Chat.Message.unpin

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

◆ updateAction()

updateAction ( \Bitrix\Im\V2\Message $message,
?\CRestServer $restServer = null,
array $fields = [],
string $urlPreview = 'Y',
int $botId = 0 )

@restMethod im.v2.Chat.Message.update

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

Поля

◆ MAX_MESSAGES_COUNT

const MAX_MESSAGES_COUNT = 100
protected

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

◆ MESSAGE_ON_PAGE_COUNT

const MESSAGE_ON_PAGE_COUNT = 50
protected

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

Объявления и описания членов класса находятся в файле:
  • C:/bitrix/modules/im/lib/V2/Controller/Chat/Message.php