Класс Chat

Граф наследования:Chat:

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

Поля данных
	$chatFields
const	MUTE_MESSAGE = true

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

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

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

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

__construct()

__construct	(	Call	$call,
			$entityId )

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

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

Методы

canExtendChat()

canExtendChat

(

)

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

canStartCall()

canStartCall

(

int

$userId

)

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

Аргументы

int

$userId

Возвращает

bool

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

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

checkAccess()

checkAccess

(

int

$userId

)

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

Аргументы

int

$userId

Возвращает

bool

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

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

getAvatar()

getAvatar

(

$currentUserId

)

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

getAvatarColor()

getAvatarColor

(

$currentUserId

)

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

getCallDuration()

getCallDuration

(

)

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

getChatId()

getChatId

(

)

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

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

getEntityId()

getEntityId

(

$currentUserId = 0

)

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

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

getEntityType()

getEntityType

(

)

Returns associated entity type.

Возвращает

string

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

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

getManagerIds()

getManagerIds

(

)

Returns list of the chat managers.

Возвращает

int[]

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

getName()

getName

(

$currentUserId

)

Returns associated entity name.

Аргументы

int

$currentUserId

Id of the user.

Возвращает

string|false

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

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

getOwnerId()

getOwnerId

(

)

Returns chat owner id.

Возвращает

int|null

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

getUsers()

getUsers

(

)

Returns list of users in the chat

Возвращает

array

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

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

isBroadcast()

isBroadcast

(

)

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

isPrivateChat()

isPrivateChat

(

)

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

onCallCreate()

onCallCreate

(

)

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

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

onExistingUsersInvite()

onExistingUsersInvite

(

$userIds

)

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

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

onStateChange()

onStateChange	(		$state,
			$prevState )

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

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

onUserAdd()

onUserAdd

(

$userId

)

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

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

sendMessage()

sendMessage	(		$message,
			$muted = false,
			$skipCounterInc = false,
			$componentParams = [] )

См. также

\Bitrix\Call\NotifyService::MESSAGE_COMPONENT_ID

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

sendMessageDeferred()

sendMessageDeferred	(		$message,
			$muted = false,
			$skipCounterInc = false,
			$componentParams = [] )

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

sendMessagesCallStart()

sendMessagesCallStart

(

)

См. также

\Bitrix\Call\NotifyService::MESSAGE_TYPE_START

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

toArray()

toArray

(

$initiatorId = 0

)

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

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

Поля

$chatFields

$chatFields

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

$chatId

$chatId

protected

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

$chatUsers

$chatUsers = []

protected

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

MUTE_MESSAGE

const MUTE_MESSAGE = true

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

---

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

• C:/bitrix/modules/im/lib/call/integration/chat.php