1C-Bitrix 25.700.0
Загрузка...
Поиск...
Не найдено
Класс CIMChat

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

 __construct ($user_id=null, $arParams=Array())
 GetMessage ($ID)
 GetLastMessage ($toChatId, $fromUserId=false, $loadExtraData=false, $bTimeZone=true, $limit=true)
 GetLastMessageLimit ($chatId, $messageStartId, $messageEndId=0, $loadExtraData=false, $bTimeZone=true, $order='DESC')
 GetLastSendMessage ($arParams)
 GetPersonalChat (?int $userId=null)
 SetReadMessage ($chatId, $lastId=null, $byEvent=false)
 SetUnReadMessage ($chatId, $lastId)
 GetUnreadMessage ($arParams=Array())
 SetOwner ($chatId, $userId, $checkPermission=true)
 SetDescription ($chatId, $description)
 SetManager ($chatId, $userId, $isManager=true, $checkPermission=true)
 SetManagers ($chatId, $users, $checkPermission=true)
 SetColor ($chatId, $color)
 SetAvatarId ($chatId, $fileId)
 Rename ($chatId, $title, $checkPermission=true, $sendMessage=true)
 Add ($arParams)
 Join ($chatId)
 JoinParent ($chatId, $messageId)
 AddUser ($chatId, $userId, $hideHistory=null, $skipMessage=false, $skipRecent=false, $skipRelation=false)
 MuteNotify ($chatId, $mute=true)
 DeleteUser ( $chatId, $userId, $checkPermission=true, $skipMessage=false, $skipRecent=false, $withoutRead=false, $additionalParams=[])

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

static getChatType ($chatData)
static GetRelationById ($ID, $userId=false, $timezone=true, $withCounter=true, bool $raw=false)
static GetPrivateRelation ($fromUserId, $toUserId)
static GetGeneralChatId ()
static InstallGeneralChat ($agentMode=false)
static GetGeneralChatAutoMessageStatus ($type)
static CanSendMessageToGeneralChat ($userId=null)
static SetAccessToGeneralChat ($allowAll=true, $allowCodes=Array())
static CanJoinGeneralChatId ($userId)
static linkGeneralChatId ($chatId)
static UnlinkGeneralChatId ()
static AddGeneralMessage ($arFields)
static GetChatData ($arParams=Array())
static GetOpenChatData ($arParams=Array())
static SetChatParams ($chatId, $params)
static AddMessage ($arFields)
static GetAvatarImage ($id, $size=200, $addBlankPicture=true)
static AddSystemMessage ($params)
static CheckRestriction ($chatId, $action)
static GetChatOptions ()
static GetSonetGroupChatId ($groupId)
static GetCrmChatId ($code)
static GetUserCount ($chatId)
static GetEntityChat ($entityType, $entityId)
static DeleteEntityChat ($entityType, $entityId)
static deleteChat (array $chatData)
static hide ($chatId)
static index ($chatId)
static addChatIndex (int $chatId, string $chatTitle)
static updateChatIndex ($chatId)
static fillChatIndexWithUserFullNames (\Bitrix\Im\Internals\ChatIndex $index)
static getNextConferenceDefaultTitle ()
static isNewChat (string $type, ?DateTime $dateCreate)
static canDo (array $chatData, array $relations, IM\V2\Permission\Action $action, mixed $target=null)
static initChatByArray (array $chatData)
static getGroupTypes ()
static getGroupTypesExtra ()
static implodeTypesForQuery (array $types)

Поля данных

const CHAT_ALL = 'all'
const GENERAL_MESSAGE_TYPE_JOIN = IM\V2\Chat\GeneralChat::GENERAL_MESSAGE_TYPE_JOIN
const GENERAL_MESSAGE_TYPE_LEAVE = IM\V2\Chat\GeneralChat::GENERAL_MESSAGE_TYPE_LEAVE
 $lastAvatarId = 0

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

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

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

◆ __construct()

__construct ( $user_id = null,
$arParams = Array() )

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

Методы

◆ Add()

Add ( $arParams)
Аргументы
$arParams
Возвращает
array|false|int
Исключения
Exception
См. также
Bitrix\Im\V2\Chat\ChatFactory::addChat()

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

◆ addChatIndex()

addChatIndex ( int $chatId,
string $chatTitle )
static

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

◆ AddGeneralMessage()

AddGeneralMessage ( $arFields)
static

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

◆ AddMessage()

AddMessage ( $arFields)
static

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

◆ AddSystemMessage()

AddSystemMessage ( $params)
static

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

◆ AddUser()

AddUser ( $chatId,
$userId,
$hideHistory = null,
$skipMessage = false,
$skipRecent = false,
$skipRelation = false )

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

◆ canDo()

canDo ( array $chatData,
array $relations,
IM\V2\Permission\Action $action,
mixed $target = null )
static

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

◆ CanJoinGeneralChatId()

CanJoinGeneralChatId ( $userId)
static

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

◆ CanSendMessageToGeneralChat()

CanSendMessageToGeneralChat ( $userId = null)
static

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

◆ CheckRestriction()

CheckRestriction ( $chatId,
$action )
static

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

◆ deleteChat()

deleteChat ( array $chatData)
static

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

◆ DeleteEntityChat()

DeleteEntityChat ( $entityType,
$entityId )
static

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

◆ DeleteUser()

DeleteUser ( $chatId,
$userId,
$checkPermission = true,
$skipMessage = false,
$skipRecent = false,
$withoutRead = false,
$additionalParams = [] )

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

◆ fillChatIndexWithUserFullNames()

fillChatIndexWithUserFullNames ( \Bitrix\Im\Internals\ChatIndex $index)
static

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

◆ GetAvatarImage()

GetAvatarImage ( $id,
$size = 200,
$addBlankPicture = true )
static

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

◆ GetChatData()

GetChatData ( $arParams = Array())
static

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

◆ GetChatOptions()

GetChatOptions ( )
static

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

◆ getChatType()

getChatType ( $chatData)
static

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

◆ GetCrmChatId()

GetCrmChatId ( $code)
static

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

◆ GetEntityChat()

GetEntityChat ( $entityType,
$entityId )
static

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

◆ GetGeneralChatAutoMessageStatus()

GetGeneralChatAutoMessageStatus ( $type)
static

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

◆ GetGeneralChatId()

GetGeneralChatId ( )
static

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

◆ getGroupTypes()

getGroupTypes ( )
static

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

◆ getGroupTypesExtra()

getGroupTypesExtra ( )
static

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

◆ GetLastMessage()

GetLastMessage ( $toChatId,
$fromUserId = false,
$loadExtraData = false,
$bTimeZone = true,
$limit = true )
Аргументы
$toChatId
bool$fromUserId
bool$loadExtraData
bool$bTimeZone
bool$limit
Возвращает
array|bool

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

◆ GetLastMessageLimit()

GetLastMessageLimit ( $chatId,
$messageStartId,
$messageEndId = 0,
$loadExtraData = false,
$bTimeZone = true,
$order = 'DESC' )

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

◆ GetLastSendMessage()

GetLastSendMessage ( $arParams)

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

◆ GetMessage()

GetMessage ( $ID)

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

◆ getNextConferenceDefaultTitle()

getNextConferenceDefaultTitle ( )
static

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

◆ GetOpenChatData()

GetOpenChatData ( $arParams = Array())
static

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

◆ GetPersonalChat()

GetPersonalChat ( ?int $userId = null)

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

◆ GetPrivateRelation()

GetPrivateRelation ( $fromUserId,
$toUserId )
static
Аргументы
$fromUserId
$toUserId
Возвращает
array

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

◆ GetRelationById()

GetRelationById ( $ID,
$userId = false,
$timezone = true,
$withCounter = true,
bool $raw = false )
static

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

◆ GetSonetGroupChatId()

GetSonetGroupChatId ( $groupId)
static

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

◆ GetUnreadMessage()

GetUnreadMessage ( $arParams = Array())
Аргументы
$arParams
Возвращает
array

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

◆ GetUserCount()

GetUserCount ( $chatId)
static

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

◆ hide()

hide ( $chatId)
static

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

◆ implodeTypesForQuery()

implodeTypesForQuery ( array $types)
static

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

◆ index()

index ( $chatId)
static

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

◆ initChatByArray()

initChatByArray ( array $chatData)
static

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

◆ InstallGeneralChat()

InstallGeneralChat ( $agentMode = false)
static

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

◆ isNewChat()

isNewChat ( string $type,
?DateTime $dateCreate )
static

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

◆ Join()

Join ( $chatId)

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

◆ JoinParent()

JoinParent ( $chatId,
$messageId )

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

◆ linkGeneralChatId()

linkGeneralChatId ( $chatId)
static

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

◆ MuteNotify()

MuteNotify ( $chatId,
$mute = true )

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

◆ Rename()

Rename ( $chatId,
$title,
$checkPermission = true,
$sendMessage = true )

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

◆ SetAccessToGeneralChat()

SetAccessToGeneralChat ( $allowAll = true,
$allowCodes = Array() )
static

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

◆ SetAvatarId()

SetAvatarId ( $chatId,
$fileId )

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

◆ SetChatParams()

SetChatParams ( $chatId,
$params )
static

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

◆ SetColor()

SetColor ( $chatId,
$color )

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

◆ SetDescription()

SetDescription ( $chatId,
$description )

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

◆ SetManager()

SetManager ( $chatId,
$userId,
$isManager = true,
$checkPermission = true )

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

◆ SetManagers()

SetManagers ( $chatId,
$users,
$checkPermission = true )

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

◆ SetOwner()

SetOwner ( $chatId,
$userId,
$checkPermission = true )

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

◆ SetReadMessage()

SetReadMessage ( $chatId,
$lastId = null,
$byEvent = false )

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

◆ SetUnReadMessage()

SetUnReadMessage ( $chatId,
$lastId )

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

◆ UnlinkGeneralChatId()

UnlinkGeneralChatId ( )
static

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

◆ updateChatIndex()

updateChatIndex ( $chatId)
static

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

Поля

◆ $lastAvatarId

$lastAvatarId = 0

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

◆ CHAT_ALL

const CHAT_ALL = 'all'

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

◆ GENERAL_MESSAGE_TYPE_JOIN

const GENERAL_MESSAGE_TYPE_JOIN = IM\V2\Chat\GeneralChat::GENERAL_MESSAGE_TYPE_JOIN

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

◆ GENERAL_MESSAGE_TYPE_LEAVE

const GENERAL_MESSAGE_TYPE_LEAVE = IM\V2\Chat\GeneralChat::GENERAL_MESSAGE_TYPE_LEAVE

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

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