Bitrix API

Manager

Table of Contents

Methods

activateScript()  : Result
canUserCreateScript()  : bool
canUserEditScript()  : bool
canUserStartScript()  : bool
checkDocumentIdsLimit()  : bool
checkQueuesCount()  : bool
createScript()  : mixed
deactivateScript()  : Result
deleteQueue()  : mixed
deleteScript()  : Result
exportScript()  : array<string|int, mixed>|null
getActiveQueueCountByScriptId()  : int
getById()  : mixed
getDocumentIdLimit()  : int
getListByDocument()  : mixed
getQueueById()  : EO_ScriptQueue|null
getQueuesLimit()  : int
importScript()  : mixed
saveScript()  : mixed
startScript()  : StartScriptResult
terminateQueue()  : mixed

Methods

activateScript()

public static activateScript(mixed $id) : Result
Parameters
$id : mixed
Return values
Result

canUserCreateScript()

public static canUserCreateScript(array<string|int, mixed> $documentType, int $userId) : bool
Parameters
$documentType : array<string|int, mixed>
$userId : int
Return values
bool

canUserEditScript()

public static canUserEditScript(int $scriptId, int $userId) : bool
Parameters
$scriptId : int
$userId : int
Return values
bool

canUserStartScript()

public static canUserStartScript(int $scriptId, int $userId) : bool
Parameters
$scriptId : int
$userId : int
Return values
bool

checkDocumentIdsLimit()

public static checkDocumentIdsLimit(array<string|int, mixed> $documentIds) : bool
Parameters
$documentIds : array<string|int, mixed>
Return values
bool

checkQueuesCount()

public static checkQueuesCount(int $scriptId) : bool
Parameters
$scriptId : int
Return values
bool

createScript()

public static createScript(array<string|int, mixed> $documentType) : mixed
Parameters
$documentType : array<string|int, mixed>

deactivateScript()

public static deactivateScript(mixed $id) : Result
Parameters
$id : mixed
Return values
Result

deleteQueue()

public static deleteQueue(int $queueId, int $userId) : mixed
Parameters
$queueId : int
$userId : int

deleteScript()

public static deleteScript(mixed $id) : Result
Parameters
$id : mixed
Return values
Result

exportScript()

public static exportScript(int $scriptId) : array<string|int, mixed>|null
Parameters
$scriptId : int
Return values
array<string|int, mixed>|null

getActiveQueueCountByScriptId()

public static getActiveQueueCountByScriptId(int $scriptId) : int
Parameters
$scriptId : int
Return values
int

getById()

public static getById(mixed $id) : mixed
Parameters
$id : mixed

getDocumentIdLimit()

public static getDocumentIdLimit() : int
Return values
int

getListByDocument()

public static getListByDocument(array<string|int, mixed> $documentType[, mixed $showInactive = false ]) : mixed
Parameters
$documentType : array<string|int, mixed>
$showInactive : mixed = false

getQueueById()

public static getQueueById(int $queueId) : EO_ScriptQueue|null
Parameters
$queueId : int
Return values
EO_ScriptQueue|null

getQueuesLimit()

public static getQueuesLimit() : int
Return values
int

importScript()

public static importScript(array<string|int, mixed> $data, int $userId) : mixed
Parameters
$data : array<string|int, mixed>
$userId : int

saveScript()

public static saveScript(int $id, array<string|int, mixed> $documentType, array<string|int, mixed> $fields[, mixed $userId = null ]) : mixed
Parameters
$id : int
$documentType : array<string|int, mixed>
$fields : array<string|int, mixed>
$userId : mixed = null

startScript()

public static startScript(int $scriptId, int $userId, array<string|int, mixed> $documentIds[, array<string|int, mixed> $parameters = [] ]) : StartScriptResult
Parameters
$scriptId : int
$userId : int
$documentIds : array<string|int, mixed>
$parameters : array<string|int, mixed> = []
Return values
StartScriptResult

terminateQueue()

public static terminateQueue(int $queueId, int $userId) : mixed
Parameters
$queueId : int
$userId : int 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results