Bitrix-D7 22.6
 
Загрузка...
Поиск...
Не найдено
Класс 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 ()
 
 getStartDate ()
 
 getEndDate ()
 
 updateState ($state)
 
 setLogUrl (string $logUrl)
 
 finish ()
 
 toArray ($currentUserId=0)
 
 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 createWithArray (array $fields)
 
static createWithPublicId ($publicId)
 
static loadWithId ($id)
 
static isCallServerEnabled ()
 
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_VOXIMPLANT = 'Voximplant'
 

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

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

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

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

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

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

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

◆ __construct()

__construct ( )
protected

Use one of the named constructors

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

Методы

◆ addUser()

addUser (   $newUserId)

Adds new user to the call.

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

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

◆ checkAccess()

checkAccess (   $userId)

Returns true if specified user has access to the call.

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

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

◆ createWithArray()

static createWithArray ( array  $fields)
static

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

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

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

◆ createWithEntity()

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

Use this constructor only for creating new calls

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

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

◆ finish()

finish ( )

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

◆ getAssociatedEntity()

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

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

◆ getChatId()

getChatId ( )

Returns id of the chat, associated with the call.

Возвращает
int

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

◆ getCurrentUserId()

getCurrentUserId ( )
protected

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

◆ getEndDate()

getEndDate ( )

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

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

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

◆ getId()

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

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

◆ getInitiatorId()

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

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

◆ getLogService()

static getLogService ( )
static

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

◆ getLogToken()

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

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

◆ getMaxCallServerParticipants()

static getMaxCallServerParticipants ( )
static

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

◆ getMaxParticipants()

static getMaxParticipants ( )
static

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

◆ getMaxUsers()

getMaxUsers ( )

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

◆ getParentId()

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

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

◆ getProvider()

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

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

◆ getSignaling()

getSignaling ( )

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

◆ getStartDate()

getStartDate ( )

Returns date of the call start.

Возвращает
DateTime

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

◆ getState()

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

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

◆ getUser()

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

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

◆ getUsers()

getUsers ( )

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

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

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

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

◆ hasUser()

hasUser (   $userId)

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

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

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

◆ isCallServerEnabled()

static isCallServerEnabled ( )
static

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

◆ isFeedbackAllowed()

static isFeedbackAllowed ( )
static

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

◆ loadUsers()

loadUsers ( )
protected

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

◆ loadWithId()

static loadWithId (   $id)
static

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

◆ makeClone()

makeClone (   $newProvider = null)

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

◆ onVoximplantConferenceFinished()

static onVoximplantConferenceFinished ( Event  $event)
static

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

◆ removeUser()

removeUser (   $userId)

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

◆ save()

save ( )

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

◆ saveStat()

saveStat ( )
protected

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

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

◆ setAssociatedEntity()

setAssociatedEntity (   $entityType,
  $entityId 
)

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

◆ setLogUrl()

setLogUrl ( string  $logUrl)

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

◆ toArray()

toArray (   $currentUserId = 0)

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

◆ updateState()

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

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

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

◆ $associatedEntity

$associatedEntity = null
protected

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

◆ $chatId

$chatId
protected

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

◆ $endDate

$endDate
protected

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

◆ $entityId

$entityId
protected

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

◆ $entityType

$entityType
protected

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

◆ $id

$id
protected

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

◆ $initiatorId

$initiatorId
protected

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

◆ $isPublic

$isPublic = false
protected

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

◆ $logUrl

$logUrl
protected

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

◆ $parentId

$parentId
protected

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

◆ $provider

$provider
protected

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

◆ $publicId

$publicId
protected

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

◆ $signaling

$signaling
protected

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

◆ $startDate

$startDate
protected

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

◆ $state

$state
protected

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

◆ $type

$type
protected

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

◆ $users

$users
protected

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

◆ PROVIDER_PLAIN

const PROVIDER_PLAIN = 'Plain'

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

◆ PROVIDER_VOXIMPLANT

const PROVIDER_VOXIMPLANT = 'Voximplant'

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

◆ RECORD_TYPE_AUDIO

const RECORD_TYPE_AUDIO = 'audio'

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

◆ RECORD_TYPE_VIDEO

const RECORD_TYPE_VIDEO = 'video'

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

◆ STATE_ANSWERED

const STATE_ANSWERED = 'answered'

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

◆ STATE_FINISHED

const STATE_FINISHED = 'finished'

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

◆ STATE_INVITING

const STATE_INVITING = 'inviting'

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

◆ STATE_NEW

const STATE_NEW = 'new'

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

◆ TYPE_INSTANT

const TYPE_INSTANT = 1

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

◆ TYPE_PERMANENT

const TYPE_PERMANENT = 2

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