Bitrix API

Call extends Controller

Constants

ERROR_REQUIRED_PARAMETER = 'MAIN_CONTROLLER_22001'
ERROR_UNKNOWN_ACTION = 'MAIN_CONTROLLER_22002'
EVENT_ON_AFTER_ACTION = 'onAfterAction'
EVENT_ON_BEFORE_ACTION = 'onBeforeAction'
EXCEPTION_UNKNOWN_ACTION = 22002
SCOPE_AJAX = 'ajax'
SCOPE_CLI = 'cli'
SCOPE_REST = 'rest'

Methods

__construct() : mixed: Constructor Controller.
answerAction() : void|null
cancelAction() : void|null
className() : string: Returns the fully qualified name of this class.
configureActions() : array<string|int, mixed>
connectionAnswerAction() : void|null
connectionOfferAction() : void|null
convertKeysToCamelCase() : array<string|int, mixed>|mixed|string: Converts keys of array to camel case notation.
createAction() : array<string|int, mixed>|null
createChildCallAction() : array<string|int, mixed>|null
declineAction() : void|null
finalizeResponse() : void: Finalizes response.
finishAction() : void|null
forward() : HttpResponse|mixed
generateActionMethodName() : string
getAction() : array<string|int, mixed>|null
getActionUri() : Uri: Returns uri for ajax end point for the action name. It's a helper, which uses relative action name without controller name.
getAutoWiredParameters() : array<string|int, Parameter>
getCallLimitsAction() : array<string|int, mixed>
getConfigurationOfActions() : array<string|int, mixed>|null
getCurrentUser() : CurrentUser
getDefaultAutoWiredParameters() : array<string|int, Parameter>
getErrorByCode() : Error: Getting once error with the necessary code.
getErrors() : array<string|int, Error>: Getting array of errors.
getFullEventName() : string
getModuleId() : string: Returns module id.
getPrimaryAutoWiredParameter() : Parameter|null
getRequest() : HttpRequest
getScope() : string
getSourceParametersList() : array<string|int, mixed>
getUnsignedParameters() : mixed
getUsersAction() : null|array<string|int, mixed>
getUserStateAction() : null|array<string|int, mixed>
hangupAction() : void|null
iceCandidateAction() : void|null
interruptAction() : array<string|int, mixed>|null
inviteAction() : true|null
isLocatedUnderPsr4() : bool
listNameActions() : array<string|int, mixed>: Returns list of all
negotiationNeededAction() : void|null
onShareScreenAction() : void|null
onStartRecordAction() : void|null
pingAction() : bool
redirectTo() : Redirect: Redirect to URL.
reportConnectionStatusAction() : void
run() : HttpResponse|mixed
setCurrentUser() : void
setScope() : Controller
setSourceParametersList() : Controller
tryJoinCallAction() : array<string|int, mixed>|null

ERROR_REQUIRED_PARAMETER


    public
        mixed
    ERROR_REQUIRED_PARAMETER
    = 'MAIN_CONTROLLER_22001'

ERROR_UNKNOWN_ACTION


    public
        mixed
    ERROR_UNKNOWN_ACTION
    = 'MAIN_CONTROLLER_22002'

EVENT_ON_AFTER_ACTION


    public
        mixed
    EVENT_ON_AFTER_ACTION
    = 'onAfterAction'

EVENT_ON_BEFORE_ACTION


    public
        mixed
    EVENT_ON_BEFORE_ACTION
    = 'onBeforeAction'

EXCEPTION_UNKNOWN_ACTION


    public
        mixed
    EXCEPTION_UNKNOWN_ACTION
    = 22002

SCOPE_AJAX


    public
        mixed
    SCOPE_AJAX
    = 'ajax'

SCOPE_CLI


    public
        mixed
    SCOPE_CLI
    = 'cli'

SCOPE_REST


    public
        mixed
    SCOPE_REST
    = 'rest'

__construct()

Constructor Controller.


    public
                    __construct([Request|null $request = null ]) : mixed

Parameters

$request : Request|null = null

answerAction()


    public
                    answerAction(int $callId, int $callInstanceId[, string $legacyMobile = "N" ]) : void|null

Parameters

$callId : int
$callInstanceId : int
$legacyMobile : string = "N"

Return values

void|null

cancelAction()


    public
                    cancelAction(int $callId) : void|null

Parameters

$callId : int

Return values

void|null

className()

Returns the fully qualified name of this class.


    public
        final    static        className() : string

Return values

string

configureActions()


    public
                    configureActions() : array<string|int, mixed>

Return values

array<string|int, mixed>

connectionAnswerAction()


    public
                    connectionAnswerAction(int $callId, int $userId, int $connectionId, string $sdp, string $userAgent) : void|null

Parameters

$callId : int
$userId : int
$connectionId : int
$sdp : string
$userAgent : string

Return values

void|null

connectionOfferAction()


    public
                    connectionOfferAction(int $callId, int $userId, int $connectionId, string $sdp, string $userAgent) : void|null

Parameters

$callId : int
$userId : int
$connectionId : int
$sdp : string
$userAgent : string

Return values

void|null

convertKeysToCamelCase()

Converts keys of array to camel case notation.


    public
                    convertKeysToCamelCase(mixed $data) : array<string|int, mixed>|mixed|string

Parameters

$data : mixed: Data.

Return values

array<string|int, mixed>|mixed|string

createAction()


    public
                    createAction(int $type, string $provider, string $entityType, string $entityId[, bool $joinExisting = false ]) : array<string|int, mixed>|null

Parameters

$type : int
$provider : string
$entityType : string
$entityId : string
$joinExisting : bool = false

Return values

array<string|int, mixed>|null

createChildCallAction()


    public
                    createChildCallAction(int $parentId, string $newProvider, array<string|int, int> $newUsers) : array<string|int, mixed>|null

Parameters

$parentId : int
$newProvider : string
$newUsers : array<string|int, int>

Return values

array<string|int, mixed>|null

declineAction()


    public
                    declineAction(int $callId, int $callInstanceId[, int $code = 603 ]) : void|null

Parameters

$callId : int
$callInstanceId : int
$code : int = 603

Return values

void|null

finalizeResponse()

Finalizes response.


    public
                    finalizeResponse(Response $response) : void

The method will be invoked when HttpApplication will be ready to send response to client. It's a final place where Controller can interact with response.

Parameters

$response : Response

finishAction()


    public
                    finishAction(int $callId) : void|null

Parameters

$callId : int

Return values

void|null

forward()


    public
                    forward(Controller|string $controller, string $actionName[, array<string|int, mixed>|null $parameters = null ]) : HttpResponse|mixed

Parameters

$controller : Controller|string
$actionName : string
$parameters : array<string|int, mixed>|null = null

Return values

HttpResponse|mixed

generateActionMethodName()


    public
        final            generateActionMethodName(mixed $action) : string

Parameters

$action : mixed

Return values

string

getAction()


    public
                    getAction(int $callId) : array<string|int, mixed>|null

Parameters

$callId : int

Return values

array<string|int, mixed>|null

getActionUri()

Returns uri for ajax end point for the action name. It's a helper, which uses relative action name without controller name.


    public
        final            getActionUri(string $actionName[, array<string|int, mixed> $params = [] ][, bool $absolute = false ]) : Uri

Parameters

$actionName : string: Action name. It's a relative action name without controller name.
$params : array<string|int, mixed> = []: Parameters for creating uri.
$absolute : bool = false

Return values

Uri

getAutoWiredParameters()


    public
                    getAutoWiredParameters() : array<string|int, Parameter>

Return values

array<string|int, Parameter>

getCallLimitsAction()


    public
                    getCallLimitsAction() : array<string|int, mixed>

Return values

array<string|int, mixed>

getConfigurationOfActions()


    public
        final            getConfigurationOfActions() : array<string|int, mixed>|null

Return values

array<string|int, mixed>|null

getCurrentUser()


    public
        final            getCurrentUser() : CurrentUser

Return values

CurrentUser

getDefaultAutoWiredParameters()


    public
        final            getDefaultAutoWiredParameters() : array<string|int, Parameter>

Return values

array<string|int, Parameter>

getErrorByCode()

Getting once error with the necessary code.


    public
        final            getErrorByCode(string $code) : Error

Parameters

$code : string: Code of error.

Return values

Error

getErrors()

Getting array of errors.


    public
        final            getErrors() : array<string|int, Error>

Return values

array<string|int, Error>

getFullEventName()


    public
        final    static        getFullEventName(mixed $eventName) : string

Parameters

$eventName : mixed

Return values

string

getModuleId()

Returns module id.


    public
        final            getModuleId() : string

Tries to guess module id by file path and function @see getModuleId().

Return values

string

getPrimaryAutoWiredParameter()


    public
                    getPrimaryAutoWiredParameter() : Parameter|null

Return values

Parameter|null

getRequest()


    public
        final            getRequest() : HttpRequest

Return values

HttpRequest

getScope()


    public
        final            getScope() : string

Return values

string

getSourceParametersList()


    public
        final            getSourceParametersList() : array<string|int, mixed>

Return values

array<string|int, mixed>

getUnsignedParameters()


    public
        final            getUnsignedParameters() : mixed

getUsersAction()


    public
                    getUsersAction(int $callId[, array<string|int, int> $userIds = [] ]) : null|array<string|int, mixed>

Parameters

$callId : int
$userIds : array<string|int, int> = []

Return values

null|array<string|int, mixed>

getUserStateAction()


    public
                    getUserStateAction(int $callId[, int $userId = 0 ]) : null|array<string|int, mixed>

Parameters

$callId : int
$userId : int = 0

Return values

null|array<string|int, mixed>

hangupAction()


    public
                    hangupAction(int $callId, int $callInstanceId[, bool $retransmit = true ]) : void|null

Parameters

$callId : int
$callInstanceId : int
$retransmit : bool = true

Return values

void|null

iceCandidateAction()


    public
                    iceCandidateAction(int $callId, int $userId, int $connectionId, array<string|int, mixed> $candidates) : void|null

Parameters

$callId : int
$userId : int
$connectionId : int
$candidates : array<string|int, mixed>

Return values

void|null

interruptAction()


    public
                    interruptAction(int $callId) : array<string|int, mixed>|null

Parameters

$callId : int

Return values

array<string|int, mixed>|null

inviteAction()


    public
                    inviteAction(int $callId, array<string|int, int> $userIds[, string $video = "N" ][, string $show = "Y" ][, string $legacyMobile = "N" ][, string $repeated = "N" ]) : true|null

Parameters

$callId : int
$userIds : array<string|int, int>
$video : string = "N"
$show : string = "Y"
$legacyMobile : string = "N"
$repeated : string = "N"

Return values

true|null

isLocatedUnderPsr4()


    public
        final            isLocatedUnderPsr4() : bool

Return values

bool

listNameActions()

Returns list of all


    public
        final            listNameActions() : array<string|int, mixed>

Return values

array<string|int, mixed>

negotiationNeededAction()


    public
                    negotiationNeededAction(int $callId, int $userId[, bool $restart = false ]) : void|null

Parameters

$callId : int
$userId : int
$restart : bool = false

Return values

void|null

onShareScreenAction()


    public
                    onShareScreenAction(int $callId) : void|null

Parameters

$callId : int

Return values

void|null

onStartRecordAction()


    public
                    onStartRecordAction(int $callId) : void|null

Parameters

$callId : int

Return values

void|null

pingAction()


    public
                    pingAction(int $callId, int $requestId[, bool $retransmit = true ]) : bool

Parameters

$callId : int
$requestId : int
$retransmit : bool = true

Return values

bool

redirectTo()

Redirect to URL.


    public
                    redirectTo(string $url) : Redirect

Parameters

$url : string

Return values

Redirect

reportConnectionStatusAction()


    public
                    reportConnectionStatusAction(int $callId, bool $connectionStatus) : void

Parameters

$callId : int
$connectionStatus : bool

run()


    public
        final            run(mixed $actionName, array<string|int, mixed> $sourceParametersList) : HttpResponse|mixed

Parameters

$actionName : mixed
$sourceParametersList : array<string|int, mixed>

Return values

HttpResponse|mixed

setCurrentUser()


    public
        final            setCurrentUser(CurrentUser $currentUser) : void

Parameters

$currentUser : CurrentUser

setScope()


    public
        final            setScope(string $scope) : Controller

Parameters

$scope : string

Return values

Controller

setSourceParametersList()


    public
        final            setSourceParametersList(array<string|int, mixed> $sourceParametersList) : Controller

Parameters

$sourceParametersList : array<string|int, mixed>

Return values

Controller

tryJoinCallAction()


    public
                    tryJoinCallAction(int $type, string $provider, string $entityType, string $entityId) : array<string|int, mixed>|null

Parameters

$type : int
$provider : string
$entityType : string
$entityId : string

Return values

array<string|int, mixed>|null

Call extends Controller

Table of Contents

Constants

Methods

Constants

ERROR_REQUIRED_PARAMETER

ERROR_UNKNOWN_ACTION

EVENT_ON_AFTER_ACTION

EVENT_ON_BEFORE_ACTION

EXCEPTION_UNKNOWN_ACTION

SCOPE_AJAX

SCOPE_CLI

SCOPE_REST

Methods

__construct()

Parameters

answerAction()

Parameters

Tags

Return values

cancelAction()

Parameters

Tags

Return values

className()

Return values

configureActions()

Return values

connectionAnswerAction()

Parameters

Tags

Return values

connectionOfferAction()

Parameters

Tags

Return values

convertKeysToCamelCase()

Parameters

Tags

Return values

createAction()

Parameters

Tags

Return values

createChildCallAction()

Parameters

Tags

Return values

declineAction()

Parameters

Tags

Return values

finalizeResponse()

Parameters

finishAction()

Parameters

Tags

Return values

forward()

Parameters

Tags

Return values

generateActionMethodName()

Parameters

Return values

getAction()

Parameters

Tags

Return values

getActionUri()

Parameters

Return values

getAutoWiredParameters()

Return values

getCallLimitsAction()

Tags

Return values

getConfigurationOfActions()

Return values

getCurrentUser()