1C-Bitrix 25.700.0
Загрузка...
Поиск...
Не найдено
Класс Call
Граф наследования:Call:
Controller Errorable Controllerable

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

 createAction (int $type, string $provider, string $entityType, string $entityId, bool $joinExisting=false)
 createChildCallAction (int $parentId, string $newProvider, array $newUsers)
 tryJoinCallAction ($type, $provider, $entityType, $entityId)
 interruptAction (int $callId)
 getAction (int $callId)
 inviteAction (int $callId, array $userIds, $video="N", $show="Y", $legacyMobile="N", $repeated="N")
 cancelAction (int $callId)
 answerAction (int $callId, $callInstanceId, $legacyMobile="N")
 declineAction (int $callId, $callInstanceId, int $code=603)
 pingAction (int $callId, $requestId, $retransmit=true)
 onShareScreenAction (int $callId)
 onStartRecordAction (int $callId)
 negotiationNeededAction (int $callId, int $userId, $restart=false)
 connectionOfferAction (int $callId, int $userId, $connectionId, $sdp, $userAgent)
 connectionAnswerAction (int $callId, int $userId, $connectionId, $sdp, $userAgent)
 iceCandidateAction (int $callId, int $userId, $connectionId, array $candidates)
 hangupAction (int $callId, $callInstanceId, $retransmit=true)
 finishAction (int $callId)
 getUsersAction (int $callId, array $userIds=[])
 getUserStateAction (int $callId, int $userId=0)
 getCallLimitsAction ()
 reportConnectionStatusAction (int $callId, bool $connectionStatus)
 configureActions ()
Открытые члены унаследованные от Controller
 __construct (Request $request=null)
 forward ($controller, string $actionName, array $parameters=null)
 getConfigurationOfActions ()
 getModuleId ()
 isLocatedUnderPsr4 ()
 getActionUri (string $actionName, array $params=[], bool $absolute=false)
 getUnsignedParameters ()
 getCurrentUser ()
 setCurrentUser (CurrentUser $currentUser)
 convertKeysToCamelCase ($data)
 listNameActions ()
 getAutoWiredParameters ()
 getPrimaryAutoWiredParameter ()
 getDefaultAutoWiredParameters ()
 getRequest ()
 getScope ()
 setScope ($scope)
 getSourceParametersList ()
 setSourceParametersList ($sourceParametersList)
 run ($actionName, array $sourceParametersList)
 finalizeResponse (Response $response)
 generateActionMethodName ($action)
 redirectTo ($url)
 getErrors ()
 hasErrors ()
 getErrorByCode ($code)

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

 formatCallResponse (\Bitrix\Im\Call\Call $call, int $initiatorId=0, bool $isNew=false)
 inviteUsers (\Bitrix\Im\Call\Call $call, $userIds, $isLegacyMobile, $isVideo, $isShow, $isRepeated)
 checkCallAccess (\Bitrix\Im\Call\Call $call, $userId)
Защищенные члены унаследованные от Controller
 init ()
 getFilePath ()
 processUnsignedParameters ()
 getSaltToUnsign ()
 getActionResponse (Action $action)
 writeToLogException (\Throwable $e)
 collectDebugInfo ()
 logDebugInfo ()
 prepareParams ()
 processBeforeAction (Action $action)
 triggerOnBeforeAction (Action $action)
 processAfterAction (Action $action, $result)
 triggerOnAfterAction (Action $action, $result)
 create ($actionName)
 buildActionInstance ($actionName, array $config)
 existsAction ($actionName)
 getDefaultPreFilters ()
 getDefaultPostFilters ()
 buildFilters (array $config=null)
 appendFilters (array $filters, array $filtersToAppend)
 removeFilters (array $filters, array $filtersToRemove)
 detachFilters (Action $action)
 detachPreFilters (Action $action)
 detachPostFilters (Action $action)
 getActionConfig ($actionName)
 setActionConfig ($actionName, array $config=null)
 runProcessingThrowable (\Throwable $throwable)
 runProcessingException (\Exception $e)
 runProcessingError (\Error $error)
 runProcessingBinderThrowable (BinderArgumentException $e)
 runProcessingValidationException (ValidationException $e)
 buildErrorFromException (\Exception $e)
 buildErrorFromPhpError (\Error $error)
 runProcessingIfUserNotAuthorized ()
 runProcessingIfInvalidCsrfToken ()
 addError (Error $error)
 addErrors (array $errors)
 renderComponent (string $name, string $template='', array $params=[], bool $withSiteTemplate=true)
 renderView (string $viewPath, array $params=[], bool $withSiteTemplate=true)
 renderExtension (string $extension, array $params=[], bool $withSiteTemplate=true)

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

static getLockNameWithEntityId (string $entityType, $entityId, $currentUserId)
static getLockNameWithCallId (string $prefix, $callId)

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

const LOCK_TTL = 10
Защищенные данные унаследованные от Controller
 $errorCollection
 $request
Configurator $configurator

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

Открытые статические члены унаследованные от Controller
static className ()
static getFullEventName ($eventName)
Поля данных унаследованные от Controller
const SCOPE_REST = 'rest'
const SCOPE_AJAX = 'ajax'
const SCOPE_CLI = 'cli'
const EVENT_ON_BEFORE_ACTION = 'onBeforeAction'
const EVENT_ON_AFTER_ACTION = 'onAfterAction'
const ERROR_REQUIRED_PARAMETER = 'MAIN_CONTROLLER_22001'
const ERROR_UNKNOWN_ACTION = 'MAIN_CONTROLLER_22002'
const EXCEPTION_UNKNOWN_ACTION = 22002
Поля данных унаследованные от Controllerable
const METHOD_ACTION_SUFFIX = 'Action'

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

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

Методы

◆ answerAction()

answerAction ( int $callId,
$callInstanceId,
$legacyMobile = "N" )

@restMethod im.call.answer

Аргументы
int$callId
int$callInstanceId
string$legacyMobile
Возвращает
void|null

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

◆ cancelAction()

cancelAction ( int $callId)

@restMethod im.call.cancel

Аргументы
int$callId
Возвращает
void|null

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

◆ checkCallAccess()

checkCallAccess ( \Bitrix\Im\Call\Call $call,
$userId )
protected

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

◆ configureActions()

configureActions ( )
Возвращает
array

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

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

◆ connectionAnswerAction()

connectionAnswerAction ( int $callId,
int $userId,
$connectionId,
$sdp,
$userAgent )

@restMethod im.call.connectionAnswer

Аргументы
int$callId
int$userId
int$connectionId
string$sdp
string$userAgent
Возвращает
void|null

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

◆ connectionOfferAction()

connectionOfferAction ( int $callId,
int $userId,
$connectionId,
$sdp,
$userAgent )

@restMethod im.call.connectionOffer

Аргументы
int$callId
int$userId
int$connectionId
string$sdp
string$userAgent
Возвращает
void|null

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

◆ createAction()

createAction ( int $type,
string $provider,
string $entityType,
string $entityId,
bool $joinExisting = false )

@restMethod im.call.create

Аргументы
int$type
string$provider
string$entityType
string$entityId
bool$joinExisting
Возвращает
array|null

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

◆ createChildCallAction()

createChildCallAction ( int $parentId,
string $newProvider,
array $newUsers )

@restMethod im.call.createChild

Аргументы
int$parentId
string$newProvider
int[]$newUsers
Возвращает
array|null

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

◆ declineAction()

declineAction ( int $callId,
$callInstanceId,
int $code = 603 )

@restMethod im.call.decline

Аргументы
int$callId
int$callInstanceId
int$code
Возвращает
void|null

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

◆ finishAction()

finishAction ( int $callId)

@restMethod im.call.finish

Аргументы
int$callId
Возвращает
void|null

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

◆ formatCallResponse()

formatCallResponse ( \Bitrix\Im\Call\Call $call,
int $initiatorId = 0,
bool $isNew = false )
protected
Аргументы
\Bitrix\Im\Call\Call$call
bool$isNew
Возвращает
array{call: array, connectionData: array, users: array, userData: array, publicChannels: array, logToken: string, isNew: bool}

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

◆ getAction()

getAction ( int $callId)

@restMethod im.call.get

Аргументы
int$callId
Возвращает
array|null

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

◆ getCallLimitsAction()

getCallLimitsAction ( )

@restMethod im.call.getCallLimits

Возвращает
array

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

◆ getLockNameWithCallId()

getLockNameWithCallId ( string $prefix,
$callId )
staticprotected

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

◆ getLockNameWithEntityId()

getLockNameWithEntityId ( string $entityType,
$entityId,
$currentUserId )
staticprotected

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

◆ getUsersAction()

getUsersAction ( int $callId,
array $userIds = [] )

@restMethod im.call.getUsers

Аргументы
int$callId
int[]$userIds
Возвращает
null|array

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

◆ getUserStateAction()

getUserStateAction ( int $callId,
int $userId = 0 )

@restMethod im.call.getUserState

Аргументы
int$callId
int$userId
Возвращает
null|array

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

◆ hangupAction()

hangupAction ( int $callId,
$callInstanceId,
$retransmit = true )

@restMethod im.call.hangup

Аргументы
int$callId
int$callInstanceId
bool$retransmit
Возвращает
void|null

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

◆ iceCandidateAction()

iceCandidateAction ( int $callId,
int $userId,
$connectionId,
array $candidates )

@restMethod im.call.iceCandidate

Аргументы
int$callId
int$userId
int$connectionId
array$candidates
Возвращает
void|null

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

◆ interruptAction()

interruptAction ( int $callId)

@restMethod im.call.interrupt

Аргументы
int$callId
Возвращает
array|null

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

◆ inviteAction()

inviteAction ( int $callId,
array $userIds,
$video = "N",
$show = "Y",
$legacyMobile = "N",
$repeated = "N" )

@restMethod im.call.invite

Аргументы
int$callId
int[]$userIds
string$video
string$show
string$legacyMobile
string$repeated
Возвращает
true|null

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

◆ inviteUsers()

inviteUsers ( \Bitrix\Im\Call\Call $call,
$userIds,
$isLegacyMobile,
$isVideo,
$isShow,
$isRepeated )
protected

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

◆ negotiationNeededAction()

negotiationNeededAction ( int $callId,
int $userId,
$restart = false )

@restMethod im.call.negotiationNeeded

Аргументы
int$callId
int$userId
bool$restart
Возвращает
void|null

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

◆ onShareScreenAction()

onShareScreenAction ( int $callId)

@restMethod im.call.onShareScreen

Аргументы
int$callId
Возвращает
void|null

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

◆ onStartRecordAction()

onStartRecordAction ( int $callId)

@restMethod im.call.onStartRecord

Аргументы
int$callId
Возвращает
void|null

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

◆ pingAction()

pingAction ( int $callId,
$requestId,
$retransmit = true )

@restMethod im.call.ping

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

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

◆ reportConnectionStatusAction()

reportConnectionStatusAction ( int $callId,
bool $connectionStatus )

@restMethod im.call.reportConnectionStatus

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

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

◆ tryJoinCallAction()

tryJoinCallAction ( $type,
$provider,
$entityType,
$entityId )

@restMethod im.call.tryJoinCall

Аргументы
int$type
string$provider
string$entityType
string$entityId
Возвращает
array|null

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

Поля

◆ LOCK_TTL

const LOCK_TTL = 10
protected

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


Объявления и описания членов класса находятся в файле:
  • C:/bitrix/modules/im/lib/controller/call.php