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

Открытые члены
	getId ()
	getType ()
	getScheme ()
	getProvider ()
	getInitiatorId ()
	getActionUserId ()
	addErrors (array $errors)
	getErrors ()
	addError (Error $error)
	hasErrors ()
	setActionUserId (int $byUserId)
	getUser ($userId)
	getUsers ()
	getCallUsers ()
	getUserData ()
	prepareUserData (array $users)
	getUserRoles (array $users=[])
	hasUser ($userId)
	addUser ($newUserId)
	removeUser ($userId)
	hasActiveUsers (bool $strict=true)
	getSignaling ()
	getAssociatedEntity ()
	setAssociatedEntity ($entityType, $entityId)
	checkAccess ($userId)
	getState ()
	getParentId ()
	getParentUuid ()
	getChatId ()
	getUuid ()
	getSecretKey ()
	getEndpoint ()
	getStartDate ()
	getEndDate ()
	getDuration ()
	autoStartRecording ()
	getUserCount ()
	isAudioRecordEnabled ()
	enableAudioRecord ()
	disableAudioRecord ()
	isAiAnalyzeEnabled ()
	enableAiAnalyze ()
	disableAiAnalyze ()
	inviteUsers (int $senderId, array $toUserIds, $isLegacyMobile, $video=false, $sendPush=true)
	sendInviteUsers (int $senderId, array $toUserIds, $isLegacyMobile, $video=false, $sendPush=true, string $sendMode=Signaling::MODE_ALL)
	updateState ($state)
	setLogUrl (string $logUrl)
	setEndpoint ($endpoint)
	finish ()
	getConnectionData (int $userId)
	toArray ($currentUserId=0, $withSecrets=false)
	save ()
	makeClone ($newProvider=null)
	createChildCall (string $newUuid, string $entityId, string $newProvider=null, int $scheme=null, int $newInitiator=null,)
	getMaxUsers ()
	getLogToken (int $userId=0, int $ttl=3600)

Открытые статические члены
static	isFeedbackAllowed ()
static	getLogService ()
static	getMaxParticipants ()
static	getMaxCallServerParticipants ()
static	getMaxCallLimit ()
static	createWithEntity (int $type, string $provider, string $entityType, string $entityId, int $initiatorId, ?string $callUuid, ?int $scheme=null)
static	createWithArray (array $fields)
static	createCallInstance (array $fields)
static	loadWithId ($id)
static	loadWithUuid ($uuid)
static	isCallServerEnabled ()
static	getTurnServer ()
static	isBitrixCallEnabled ()
static	isIosBetaEnabled ()
static	onVoximplantConferenceFinished (Event $event)

Поля данных
const	STATE_NEW = 'new'
const	STATE_INVITING = 'inviting'
const	STATE_ANSWERED = 'answered'
const	STATE_FINISHED = 'finished'
const	TYPE_INSTANT = 1
const	TYPE_PERMANENT = 2
const	TYPE_LANGE = 3
const	SCHEME_CLASSIC = 1
const	SCHEME_JWT = 2
const	PROVIDER_PLAIN = 'Plain'
const	PROVIDER_BITRIX = 'Bitrix'
const	PROVIDER_VOXIMPLANT = 'Voximplant'

Защищенные члены
	__construct ()
	fireCallStartedEvent ()
	fireCallFinishedEvent ()
	loadUsers ()
	saveStat ()
	initCall ()
	getCurrentUserId ()

Защищенные статические члены
static	sendCreateCallEvent (Call $instance)

Защищенные данные
	$id
	$type
int	$scheme
	$initiatorId
int	$actionUserId = null
	$isPublic = false
	$publicId
	$provider
	$entityType
	$entityId
	$parentId
	$parentUuid
	$state
	$startDate
	$endDate
	$logUrl
	$chatId
	$uuid
	$secretKey
	$endpoint
bool	$enableAudioRecord = false
bool	$enableAiAnalyze = false
Integration AbstractEntity	$associatedEntity = null
	$users
	$userData
Signaling	$signaling = null
ErrorCollection	$errorCollection = null

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

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

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

◆ __construct()

__construct ( )

protected

Use one of the named constructors

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

Методы

◆ addError()

addError ( Error $error )

Upends stack of errors.

Аргументы

Error $error Error message object.

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

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

◆ addErrors()

addErrors ( array $errors )

Add multiple errors

Аргументы

Error[] $errors

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

◆ addUser()

addUser ( $newUserId )

Adds new user to the call.

Аргументы

int $newUserId

Возвращает: CallUser|null

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

◆ autoStartRecording()

autoStartRecording ( )

Do need to record call.

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

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

◆ checkAccess()

checkAccess ( $userId )

Returns true if specified user has access to the call.

Аргументы

int $userId Id of the user.

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

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

◆ createCallInstance()

createCallInstance ( array $fields )

static

Creates new instance of the Call with values from the database.

Аргументы

array $fields Call fields

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

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

◆ createChildCall()

createChildCall	(	string	$newUuid,
		string	$entityId,
		string	$newProvider = null,
		int	$scheme = null,
		int	$newInitiator = null )

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

◆ createWithArray()

createWithArray ( array $fields )

static

Creates new instance of the Call with values from the database.

Аргументы

array $fields Call fields

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

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

◆ createWithEntity()

createWithEntity	(	int	$type,
		string	$provider,
		string	$entityType,
		string	$entityId,
		int	$initiatorId,
		?string	$callUuid,
		?int	$scheme = null )

static

Use this constructor only for creating new calls

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

◆ disableAiAnalyze()

disableAiAnalyze ( )

Disable AI analyze.

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

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

◆ disableAudioRecord()

disableAudioRecord ( )

Disable record call.

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

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

◆ enableAiAnalyze()

enableAiAnalyze ( )

Do AI analyze.

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

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

◆ enableAudioRecord()

enableAudioRecord ( )

Do need to record call.

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

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

◆ finish()

finish ( )

Переопределяется в BitrixCall и PlainCall.

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

◆ fireCallFinishedEvent()

fireCallFinishedEvent ( )

protected

@event call:onCallFinished

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

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

◆ fireCallStartedEvent()

fireCallStartedEvent ( )

protected

@event call:onCallStarted

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

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

◆ getActionUserId()

getActionUserId ( )

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

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

◆ getAssociatedEntity()

getAssociatedEntity ( )

Возвращает: Integration\AbstractEntity|Integration\Chat|null

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

◆ getCallUsers()

getCallUsers ( )

Returns arrays of the users, currently participating in the call.

Возвращает: CallUser[]

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

◆ getChatId()

getChatId ( )

Returns id of the chat, associated with the call.

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

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

◆ getConnectionData()

getConnectionData ( int $userId )

Переопределяется в BitrixCall.

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

◆ getCurrentUserId()

getCurrentUserId ( )

protected

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

◆ getDuration()

getDuration ( )

Returns call duration.

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

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

◆ getEndDate()

getEndDate ( )

Returns date of the call end (if there is one).

Возвращает: DateTime|null

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

◆ getEndpoint()

getEndpoint ( )

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

◆ getErrors()

getErrors ( )

Возвращает: Error[]

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

◆ getId()

getId ( )

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

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

◆ getInitiatorId()

getInitiatorId ( )

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

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

◆ getLogService()

getLogService ( )

static

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

◆ getLogToken()

getLogToken	(	int	$userId = 0,
		int	$ttl = 3600 )

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

◆ getMaxCallLimit()

getMaxCallLimit ( )

static

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

◆ getMaxCallServerParticipants()

getMaxCallServerParticipants ( )

static

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

◆ getMaxParticipants()

getMaxParticipants ( )

static

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

◆ getMaxUsers()

getMaxUsers ( )

Переопределяется в BitrixCall и PlainCall.

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

◆ getParentId()

getParentId ( )

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

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

◆ getParentUuid()

getParentUuid ( )

Возвращает: string|null

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

◆ getProvider()

getProvider ( )

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

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

◆ getScheme()

getScheme ( )

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

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

◆ getSecretKey()

getSecretKey ( )

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

◆ getSignaling()

getSignaling ( )

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

◆ getStartDate()

getStartDate ( )

Returns date of the call start.

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

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

◆ getState()

getState ( )

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

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

◆ getTurnServer()

getTurnServer ( )

static

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

◆ getType()

getType ( )

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

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

◆ getUser()

getUser ( $userId )

Аргументы

int $userId

Возвращает: CallUser|null

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

◆ getUserCount()

getUserCount ( )

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

◆ getUserData()

getUserData ( )

Returns arrays of information about the users currently participating in the call.

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

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

◆ getUserRoles()

getUserRoles ( array $users = [] )

Returns user's roles in the call.

Аргументы

int[] $users

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

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

◆ getUsers()

getUsers ( )

Returns arrays of ids of the users, currently participating in the call.

Возвращает: int[]

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

◆ getUuid()

getUuid ( )

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

◆ hasActiveUsers()

hasActiveUsers ( bool $strict = true )

Call is considered active if it has at least:

one user in ready state
another user in ready or calling state
Возвращает
bool

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

◆ hasErrors()

hasErrors ( )

Tells true if error have happened.

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

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

◆ hasUser()

hasUser ( $userId )

Return true if a user is the part of the call.

Аргументы

int $userId Id of the user.

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

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

◆ initCall()

initCall ( )

protected

Переопределяется в BitrixCall и PlainCall.

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

◆ inviteUsers()

inviteUsers	(	int	$senderId,
		array	$toUserIds,
			$isLegacyMobile,
			$video = false,
			$sendPush = true )

Переопределяется в BitrixCall.

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

◆ isAiAnalyzeEnabled()

isAiAnalyzeEnabled ( )

Analyze call with AI enabled.

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

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

◆ isAudioRecordEnabled()

isAudioRecordEnabled ( )

Record call.

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

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

◆ isBitrixCallEnabled()

isBitrixCallEnabled ( )

static

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

◆ isCallServerEnabled()

isCallServerEnabled ( )

static

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

◆ isFeedbackAllowed()

isFeedbackAllowed ( )

static

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

◆ isIosBetaEnabled()

isIosBetaEnabled ( )

static

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

◆ loadUsers()

loadUsers ( )

protected

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

◆ loadWithId()

loadWithId ( $id )

static

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

◆ loadWithUuid()

loadWithUuid ( $uuid )

static

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

◆ makeClone()

makeClone ( $newProvider = null )

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

◆ onVoximplantConferenceFinished()

onVoximplantConferenceFinished ( Event $event )

static

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

◆ prepareUserData()

prepareUserData ( array $users )

Аргументы

int[] $users

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

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

◆ removeUser()

removeUser ( $userId )

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

◆ save()

save ( )

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

◆ saveStat()

saveStat ( )

protected

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

◆ sendCreateCallEvent()

sendCreateCallEvent ( Call $instance )

staticprotected

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

◆ sendInviteUsers()

sendInviteUsers	(	int	$senderId,
		array	$toUserIds,
			$isLegacyMobile,
			$video = false,
			$sendPush = true,
		string	$sendMode = Signaling::MODE_ALL )

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

◆ setActionUserId()

setActionUserId ( int $byUserId )

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

◆ setAssociatedEntity()

setAssociatedEntity	(		$entityType,
			$entityId )

Аргументы

string	$entityType
int	$entityId

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

Исключения

ArgumentException

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

◆ setEndpoint()

setEndpoint ( $endpoint )

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

◆ setLogUrl()

setLogUrl ( string $logUrl )

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

◆ toArray()

toArray	(		$currentUserId = 0,
			$withSecrets = false )

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

◆ updateState()

updateState ( $state )

Аргументы

string $state

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

Поля

◆ $actionUserId

int $actionUserId = null

protected

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

◆ $associatedEntity

Integration AbstractEntity $associatedEntity = null

protected

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

◆ $chatId

$chatId

protected

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

◆ $enableAiAnalyze

bool $enableAiAnalyze = false

protected

Record will be analyzed with AI

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

◆ $enableAudioRecord

bool $enableAudioRecord = false

protected

Current record status

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

◆ $endDate

$endDate

protected

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

◆ $endpoint

$endpoint

protected

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

◆ $entityId

$entityId

protected

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

◆ $entityType

$entityType

protected

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

◆ $errorCollection

ErrorCollection $errorCollection = null

protected

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

◆ $id

$id

protected

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

◆ $initiatorId

$initiatorId

protected

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

◆ $isPublic

$isPublic = false

protected

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

◆ $logUrl

$logUrl

protected

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

◆ $parentId

$parentId

protected

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

◆ $parentUuid

$parentUuid

protected

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

◆ $provider

$provider

protected

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

◆ $publicId

$publicId

protected

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

◆ $scheme

int $scheme

protected

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

◆ $secretKey

$secretKey

protected

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

◆ $signaling

Signaling $signaling = null

protected

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

◆ $startDate

$startDate

protected

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

◆ $state

$state

protected

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

◆ $type

$type

protected

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

◆ $userData

$userData

protected

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

◆ $users

$users

protected

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

◆ $uuid

$uuid

protected

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

◆ PROVIDER_BITRIX

const PROVIDER_BITRIX = 'Bitrix'

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

◆ PROVIDER_PLAIN

const PROVIDER_PLAIN = 'Plain'

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

◆ PROVIDER_VOXIMPLANT

const PROVIDER_VOXIMPLANT = 'Voximplant'

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

◆ SCHEME_CLASSIC

const SCHEME_CLASSIC = 1

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

◆ SCHEME_JWT

const SCHEME_JWT = 2

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

◆ STATE_ANSWERED

const STATE_ANSWERED = 'answered'

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

◆ STATE_FINISHED

const STATE_FINISHED = 'finished'

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

◆ STATE_INVITING

const STATE_INVITING = 'inviting'

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

◆ STATE_NEW

const STATE_NEW = 'new'

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

◆ TYPE_INSTANT

const TYPE_INSTANT = 1

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

◆ TYPE_LANGE

const TYPE_LANGE = 3

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

◆ TYPE_PERMANENT

const TYPE_PERMANENT = 2

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

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

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

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

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

Поля данных

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

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

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

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

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

◆ __construct()

Методы

◆ addError()

◆ addErrors()

◆ addUser()

◆ autoStartRecording()

◆ checkAccess()

◆ createCallInstance()

◆ createChildCall()

◆ createWithArray()

◆ createWithEntity()

◆ disableAiAnalyze()

◆ disableAudioRecord()

◆ enableAiAnalyze()

◆ enableAudioRecord()

◆ finish()

◆ fireCallFinishedEvent()

◆ fireCallStartedEvent()

◆ getActionUserId()

◆ getAssociatedEntity()

◆ getCallUsers()

◆ getChatId()

◆ getConnectionData()

◆ getCurrentUserId()

◆ getDuration()

◆ getEndDate()

◆ getEndpoint()

◆ getErrors()

◆ getId()

◆ getInitiatorId()

◆ getLogService()

◆ getLogToken()

◆ getMaxCallLimit()

◆ getMaxCallServerParticipants()

◆ getMaxParticipants()

◆ getMaxUsers()

◆ getParentId()

◆ getParentUuid()

◆ getProvider()

◆ getScheme()

◆ getSecretKey()

◆ getSignaling()

◆ getStartDate()

◆ getState()

◆ getTurnServer()

◆ getType()

◆ getUser()

◆ getUserCount()

◆ getUserData()

◆ getUserRoles()

◆ getUsers()

◆ getUuid()

◆ hasActiveUsers()

◆ hasErrors()

◆ hasUser()

◆ initCall()

◆ inviteUsers()

◆ isAiAnalyzeEnabled()

◆ isAudioRecordEnabled()

◆ isBitrixCallEnabled()

◆ isCallServerEnabled()

◆ isFeedbackAllowed()

◆ isIosBetaEnabled()

◆ loadUsers()

◆ loadWithId()

◆ loadWithUuid()

◆ makeClone()

◆ onVoximplantConferenceFinished()

◆ prepareUserData()

◆ removeUser()

◆ save()

◆ saveStat()