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

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

 getId ()
 
 getProvider ()
 
 getInitiatorId ()
 
 getUser ($userId)
 
 getUsers ()
 
 hasUser ($userId)
 
 addUser ($newUserId)
 
 removeUser ($userId)
 
 hasActiveUsers (bool $strict=true)
 
 getSignaling ()
 
 getAssociatedEntity ()
 
 setAssociatedEntity ($entityType, $entityId)
 
 checkAccess ($userId)
 
 getState ()
 
 getParentId ()
 
 getChatId ()
 
 getUuid ()
 
 getSecretKey ()
 
 getEndpoint ()
 
 getStartDate ()
 
 getEndDate ()
 
 inviteUsers (int $senderId, array $toUserIds, $isLegacyMobile, $video=false, $sendPush=true)
 
 updateState ($state)
 
 setLogUrl (string $logUrl)
 
 setEndpoint ($endpoint)
 
 finish ()
 
 getConnectionData (int $userId)
 
 toArray ($currentUserId=0, $withSecrets=false)
 
 save ()
 
 makeClone ($newProvider=null)
 
 getMaxUsers ()
 
 getLogToken (int $userId=0, int $ttl=3600)
 

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

static isFeedbackAllowed ()
 
static getLogService ()
 
static getMaxParticipants ()
 
static getMaxCallServerParticipants ()
 
static createWithEntity ($type, $provider, $entityType, $entityId, $initiatorId)
 
static searchActive ($type, $provider, $entityType, $entityId, $currentUserId=0)
 
static searchActiveByUuid (string $uuid)
 
static createWithArray (array $fields)
 
static createWithPublicId ($publicId)
 
static loadWithId ($id)
 
static isCallServerEnabled ()
 
static isBitrixCallServerEnabled ()
 
static isBitrixCallEnabled ()
 
static isVoximplantCallServerEnabled ()
 
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 RECORD_TYPE_VIDEO = 'video'
 
const RECORD_TYPE_AUDIO = 'audio'
 
const PROVIDER_PLAIN = 'Plain'
 
const PROVIDER_BITRIX = 'Bitrix'
 
const PROVIDER_VOXIMPLANT = 'Voximplant'
 

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

 __construct ()
 
 loadUsers ()
 
 saveStat ()
 
 initCall ()
 
 getCurrentUserId ()
 

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

 $id
 
 $type
 
 $initiatorId
 
 $isPublic = false
 
 $publicId
 
 $provider
 
 $entityType
 
 $entityId
 
 $parentId
 
 $state
 
 $startDate
 
 $endDate
 
 $logUrl
 
 $chatId
 
 $uuid
 
 $secretKey
 
 $endpoint
 
 $associatedEntity = null
 
 $users
 
 $signaling
 

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

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

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

◆ __construct()

__construct ( )
protected

Use one of the named constructors

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

Методы

◆ addUser()

addUser ( $newUserId)

Adds new user to the call.

Аргументы
int$newUserId
Возвращает
CallUser|false

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

◆ checkAccess()

checkAccess ( $userId)

Returns true if specified user has access to the call.

Аргументы
int$userIdId of the user.
Возвращает
bool

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

◆ createWithArray()

static createWithArray ( array $fields)
static

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

Аргументы
array$fieldsCall fields
Возвращает
Call

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

◆ createWithEntity()

static createWithEntity ( $type,
$provider,
$entityType,
$entityId,
$initiatorId )
static

Use this constructor only for creating new calls

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

◆ createWithPublicId()

static createWithPublicId ( $publicId)
static

Loads instance of the Call from the database using call's public id.

Аргументы
string$publicId
Возвращает
Call|false
Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

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

◆ finish()

finish ( )

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

◆ getAssociatedEntity()

getAssociatedEntity ( )
Возвращает
Integration\AbstractEntity|null

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

◆ getChatId()

getChatId ( )

Returns id of the chat, associated with the call.

Возвращает
int

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

◆ getConnectionData()

getConnectionData ( int $userId)

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

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

◆ getCurrentUserId()

getCurrentUserId ( )
protected

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

◆ getEndDate()

getEndDate ( )

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

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

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

◆ getEndpoint()

getEndpoint ( )

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

◆ getId()

getId ( )
Возвращает
int

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

◆ getInitiatorId()

getInitiatorId ( )
Возвращает
int

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

◆ getLogService()

static getLogService ( )
static

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

◆ getLogToken()

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

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

◆ getMaxCallServerParticipants()

static getMaxCallServerParticipants ( )
static

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

◆ getMaxParticipants()

static getMaxParticipants ( )
static

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

◆ getMaxUsers()

getMaxUsers ( )

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

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

◆ getParentId()

getParentId ( )
Возвращает
int|false

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

◆ getProvider()

getProvider ( )
Возвращает
string

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

◆ getSecretKey()

getSecretKey ( )

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

◆ getSignaling()

getSignaling ( )

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

◆ getStartDate()

getStartDate ( )

Returns date of the call start.

Возвращает
DateTime

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

◆ getState()

getState ( )
Возвращает
string

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

◆ getUser()

getUser ( $userId)
Аргументы
$userId
Возвращает
CallUser|null

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

◆ getUsers()

getUsers ( )

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

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

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

◆ getUuid()

getUuid ( )

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

◆ 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 строка 178

◆ hasUser()

hasUser ( $userId)

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

Аргументы
int$userIdId of the user.
Возвращает
bool

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

◆ initCall()

initCall ( )
protected

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

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

◆ inviteUsers()

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

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

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

◆ isBitrixCallEnabled()

static isBitrixCallEnabled ( )
static

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

◆ isBitrixCallServerEnabled()

static isBitrixCallServerEnabled ( )
static

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

◆ isCallServerEnabled()

static isCallServerEnabled ( )
static

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

◆ isFeedbackAllowed()

static isFeedbackAllowed ( )
static

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

◆ isVoximplantCallServerEnabled()

static isVoximplantCallServerEnabled ( )
static

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

◆ loadUsers()

loadUsers ( )
protected

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

◆ loadWithId()

static loadWithId ( $id)
static

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

◆ makeClone()

makeClone ( $newProvider = null)

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

◆ onVoximplantConferenceFinished()

static onVoximplantConferenceFinished ( Event $event)
static

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

◆ removeUser()

removeUser ( $userId)

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

◆ save()

save ( )

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

◆ saveStat()

saveStat ( )
protected

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

◆ searchActive()

static searchActive ( $type,
$provider,
$entityType,
$entityId,
$currentUserId = 0 )
static
Аргументы
string$type
string$provider
string$entityType
string$entityId
int$currentUserId
Возвращает
Call|null
Исключения
ArgumentException

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

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

◆ searchActiveByUuid()

static searchActiveByUuid ( string $uuid)
static

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

◆ setAssociatedEntity()

setAssociatedEntity ( $entityType,
$entityId )

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

◆ setEndpoint()

setEndpoint ( $endpoint)

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

◆ setLogUrl()

setLogUrl ( string $logUrl)

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

◆ toArray()

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

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

◆ updateState()

updateState ( $state)
Аргументы
string$state

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

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

◆ $associatedEntity

$associatedEntity = null
protected

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

◆ $chatId

$chatId
protected

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

◆ $endDate

$endDate
protected

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

◆ $endpoint

$endpoint
protected

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

◆ $entityId

$entityId
protected

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

◆ $entityType

$entityType
protected

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

◆ $id

$id
protected

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

◆ $initiatorId

$initiatorId
protected

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

◆ $isPublic

$isPublic = false
protected

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

◆ $logUrl

$logUrl
protected

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

◆ $parentId

$parentId
protected

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

◆ $provider

$provider
protected

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

◆ $publicId

$publicId
protected

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

◆ $secretKey

$secretKey
protected

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

◆ $signaling

$signaling
protected

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

◆ $startDate

$startDate
protected

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

◆ $state

$state
protected

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

◆ $type

$type
protected

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

◆ $users

$users
protected

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

◆ $uuid

$uuid
protected

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

◆ PROVIDER_BITRIX

const PROVIDER_BITRIX = 'Bitrix'

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

◆ PROVIDER_PLAIN

const PROVIDER_PLAIN = 'Plain'

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

◆ PROVIDER_VOXIMPLANT

const PROVIDER_VOXIMPLANT = 'Voximplant'

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

◆ RECORD_TYPE_AUDIO

const RECORD_TYPE_AUDIO = 'audio'

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

◆ RECORD_TYPE_VIDEO

const RECORD_TYPE_VIDEO = 'video'

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

◆ STATE_ANSWERED

const STATE_ANSWERED = 'answered'

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

◆ STATE_FINISHED

const STATE_FINISHED = 'finished'

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

◆ STATE_INVITING

const STATE_INVITING = 'inviting'

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

◆ STATE_NEW

const STATE_NEW = 'new'

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

◆ TYPE_INSTANT

const TYPE_INSTANT = 1

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

◆ TYPE_PERMANENT

const TYPE_PERMANENT = 2

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