Bitrix API

Conference

Table of Contents

Constants

ALIAS_TYPE  = 'VIDEOCONF'
AVAILABLE_PARAMS  = ['ID', 'TITLE', 'PASSWORD_NEEDED', 'PASSWORD', 'USERS', 'BROADCAST_MODE', 'PRESENTERS', 'INVITATION']
BROADCAST_MODE  = 'BROADCAST'
BROADCAST_USER_LIMIT  = 500
ERROR_BITRIX24_ONLY  = "bitrix24only"
ERROR_DETECT_INTRANET_USER  = "detectIntranetUser"
ERROR_KICKED_FROM_CALL  = "kickedFromCall"
ERROR_USER_LIMIT_REACHED  = "userLimitReached"
ERROR_WRONG_ALIAS  = "wrongAlias"
PRESENTERS_LIMIT  = 4
ROLE_PRESENTER  = 'presenter'
STATE_ACTIVE  = "active"
STATE_FINISHED  = "finished"
STATE_NOT_STARTED  = "notStarted"

Methods

add()  : Result
canUserDelete()  : bool
canUserEdit()  : bool
createWithArray()  : Conference
delete()  : Result
deletePresenter()  : DeleteResult
getAlias()  : mixed
getAliasId()  : mixed
getAll()  : ArrayResult
getByAlias()  : mixed
getById()  : Conference|null
getChatId()  : mixed
getChatName()  : mixed
getDefaultSelectFields()  : array<string|int, mixed>
getHostId()  : mixed
getHostName()  : mixed
getId()  : mixed
getInvitation()  : mixed
getOwnerId()  : int|null
getPassword()  : mixed
getPresentersInfo()  : array<string|int, mixed>
getPresentersList()  : array<string|int, mixed>
getPublicLink()  : string
getRuntimeChatField()  : array<string|int, mixed>
getStartDate()  : mixed
getStatus()  : string
getStatusList()  : array<string|int, mixed>
getUserLimit()  : int
getUsers()  : array<string|int, mixed>
isActive()  : bool
isBroadcast()  : bool
isFinished()  : bool
isPasswordRequired()  : bool
isPresenter()  : bool
makePresenter()  : AddResult
prepareParamsForAdd()  : Result
removeTemporaryAliases()  : string
update()  : Result

Constants

ALIAS_TYPE

public mixed ALIAS_TYPE = 'VIDEOCONF'

AVAILABLE_PARAMS

public mixed AVAILABLE_PARAMS = ['ID', 'TITLE', 'PASSWORD_NEEDED', 'PASSWORD', 'USERS', 'BROADCAST_MODE', 'PRESENTERS', 'INVITATION']

BROADCAST_MODE

public mixed BROADCAST_MODE = 'BROADCAST'

BROADCAST_USER_LIMIT

public mixed BROADCAST_USER_LIMIT = 500

ERROR_BITRIX24_ONLY

public mixed ERROR_BITRIX24_ONLY = "bitrix24only"

ERROR_DETECT_INTRANET_USER

public mixed ERROR_DETECT_INTRANET_USER = "detectIntranetUser"

ERROR_KICKED_FROM_CALL

public mixed ERROR_KICKED_FROM_CALL = "kickedFromCall"

ERROR_USER_LIMIT_REACHED

public mixed ERROR_USER_LIMIT_REACHED = "userLimitReached"

ERROR_WRONG_ALIAS

public mixed ERROR_WRONG_ALIAS = "wrongAlias"

PRESENTERS_LIMIT

public mixed PRESENTERS_LIMIT = 4

ROLE_PRESENTER

public mixed ROLE_PRESENTER = 'presenter'

STATE_ACTIVE

public mixed STATE_ACTIVE = "active"

STATE_FINISHED

public mixed STATE_FINISHED = "finished"

STATE_NOT_STARTED

public mixed STATE_NOT_STARTED = "notStarted"

Methods

add()

public static add([array<string|int, mixed> $fields = [] ]) : Result
Parameters
$fields : array<string|int, mixed> = []
Return values
Result

canUserDelete()

public canUserDelete(mixed $userId) : bool
Parameters
$userId : mixed
Return values
bool

canUserEdit()

public canUserEdit(mixed $userId) : bool
Parameters
$userId : mixed
Return values
bool

createWithArray()

public static createWithArray(array<string|int, mixed> $fields) : Conference
Parameters
$fields : array<string|int, mixed>
Return values
Conference

delete()

public delete() : Result
Return values
Result

getAll()

public static getAll(array<string|int, mixed> $queryParams) : ArrayResult
Parameters
$queryParams : array<string|int, mixed>
Return values
ArrayResult

getByAlias()

public static getByAlias(string $alias) : mixed
Parameters
$alias : string

getDefaultSelectFields()

public static getDefaultSelectFields() : array<string|int, mixed>
Return values
array<string|int, mixed>

getOwnerId()

public getOwnerId() : int|null
Return values
int|null

getPresentersInfo()

public getPresentersInfo() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPresentersList()

public getPresentersList() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPublicLink()

public getPublicLink() : string
Return values
string

getRuntimeChatField()

public static getRuntimeChatField() : array<string|int, mixed>
Return values
array<string|int, mixed>

getStatus()

public getStatus() : string
Return values
string

getStatusList()

public static getStatusList() : array<string|int, mixed>
Return values
array<string|int, mixed>

getUserLimit()

public getUserLimit() : int
Return values
int

getUsers()

public getUsers() : array<string|int, mixed>
Return values
array<string|int, mixed>

isActive()

public isActive() : bool
Return values
bool

isBroadcast()

public isBroadcast() : bool
Return values
bool

isFinished()

public isFinished() : bool
Return values
bool

isPasswordRequired()

public isPasswordRequired() : bool
Return values
bool

isPresenter()

public isPresenter(int $userId) : bool
Parameters
$userId : int
Return values
bool

prepareParamsForAdd()

public static prepareParamsForAdd(array<string|int, mixed> $fields) : Result
Parameters
$fields : array<string|int, mixed>
Return values
Result

removeTemporaryAliases()

public static removeTemporaryAliases() : string
Return values
string

update()

public update([array<string|int, mixed> $fields = [] ]) : Result
Parameters
$fields : array<string|int, mixed> = []
Return values
Result 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results