Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Класс Chat
+ Граф наследования:Chat:

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

 __construct (Call $call, $entityId)
 
 getEntityType ()
 
 getEntityId ($currentUserId=0)
 
 getChatId ()
 
 getUsers ()
 
 checkAccess (int $userId)
 
 canStartCall (int $userId)
 
 getName ($currentUserId)
 
 getAvatar ($currentUserId)
 
 getAvatarColor ($currentUserId)
 
 isPrivateChat ()
 
 onUserAdd ($userId)
 
 onExistingUserInvite ($userId)
 
 onStateChange ($state, $prevState)
 
 onCallCreate ()
 
 sendMessagesCallStart ()
 
 sendMessageDeferred ($message, $muted=false)
 
 isBroadcast ()
 
 sendMessage ($message, $muted=false)
 
 toArray ($currentUserId=0)
 
 canExtendChat ()
 
- Открытые члены унаследованные от AbstractEntity
 getCall ()
 
 setCall (Call $call)
 

Открытые атрибуты

 $chatFields
 
const MUTE_MESSAGE = true
 

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

 $chatId
 
 $chatUsers = []
 
- Защищенные данные унаследованные от AbstractEntity
 $entityId
 
 $initiatorId
 
 $call
 

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

- Защищенные члены унаследованные от AbstractEntity
 getCurrentUserId ()
 

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

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

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

◆ __construct()

__construct ( Call $call,
$entityId )

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

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

Методы

◆ canExtendChat()

canExtendChat ( )

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

◆ canStartCall()

canStartCall ( int $userId)

Returns true is user can call users in the associated chat and false otherwise.

Аргументы
int$userId
Возвращает
bool

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

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

◆ checkAccess()

checkAccess ( int $userId)

Returns true is user has access to the associated chat and false otherwise.

Аргументы
int$userId
Возвращает
bool

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

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

◆ getAvatar()

getAvatar ( $currentUserId)

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

◆ getAvatarColor()

getAvatarColor ( $currentUserId)

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

◆ getChatId()

getChatId ( )

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

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

◆ getEntityId()

getEntityId ( $currentUserId = 0)

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

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

◆ getEntityType()

getEntityType ( )

Returns associated entity type.

Возвращает
string

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

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

◆ getName()

getName ( $currentUserId)

Returns associated entity name.

Аргументы
int$currentUserIdId of the user.
Возвращает
string|false

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

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

◆ getUsers()

getUsers ( )

Returns list of users in the chat

Возвращает
array

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

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

◆ isBroadcast()

isBroadcast ( )

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

◆ isPrivateChat()

isPrivateChat ( )

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

◆ onCallCreate()

onCallCreate ( )

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

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

◆ onExistingUserInvite()

onExistingUserInvite ( $userId)

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

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

◆ onStateChange()

onStateChange ( $state,
$prevState )

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

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

◆ onUserAdd()

onUserAdd ( $userId)

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

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

◆ sendMessage()

sendMessage ( $message,
$muted = false )

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

◆ sendMessageDeferred()

sendMessageDeferred ( $message,
$muted = false )

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

◆ sendMessagesCallStart()

sendMessagesCallStart ( )

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

◆ toArray()

toArray ( $currentUserId = 0)

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

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

Данные класса

◆ $chatFields

$chatFields

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

◆ $chatId

$chatId
protected

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

◆ $chatUsers

$chatUsers = []
protected

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

◆ MUTE_MESSAGE

const MUTE_MESSAGE = true

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