Bitrix API

FromTemplate extends Task

FinalYes
Tags
see
RegularTemplateTaskReplicator

Table of Contents

Methods

forceRepeatTask()  : mixed|string
getConfig()  : mixed
getConverter()  : Converter
getNextTime()  : Result
Calculates next time agent should be scheduled at
produce()  : Result
produceSub()  : Result
Create sub-tasks for $destination task based on sub-templates of $source
reInstallAgent()  : mixed
repeatTask()  : mixed|string
Agent handler for repeating tasks.
resurrectFallenTemplates()  : mixed
sendEvents()  : void
setConfig()  : mixed
setConverter()  : mixed
unInstallAgent()  : mixed

Methods

forceRepeatTask()

public static forceRepeatTask(int $templateId[, int $userId = 0 ]) : mixed|string
Parameters
$templateId : int
$userId : int = 0
Tags
throws
ArgumentException
Return values
mixed|string

getConfig()

public getConfig(mixed $field) : mixed
Parameters
$field : mixed

getConverter()

public getConverter() : Converter
Tags
throws
NotImplementedException
Return values
Converter

getNextTime()

Calculates next time agent should be scheduled at

public static getNextTime(array<string|int, mixed> $templateData[, bool $agentTime = false ][, bool $nowTime = false ]) : Result
Parameters
$templateData : array<string|int, mixed>
$agentTime : bool = false
$nowTime : bool = false
Return values
Result

produce()

public produce(int|Item $source[, int $userId = 0 ][, array<string|int, mixed> $parameters = array() ]) : Result
Parameters
$source : int|Item
$userId : int = 0
$parameters : array<string|int, mixed> = array()
Tags
see
RegularTemplateTaskReplicator::replicate()
throws
NotImplementedException
Return values
Result

produceSub()

Create sub-tasks for $destination task based on sub-templates of $source

public produceSub(mixed $source, mixed $destination[, array<string|int, mixed> $parameters = array() ][, int $userId = 0 ]) : Result
Parameters
$source : mixed
$destination : mixed
$parameters : array<string|int, mixed> = array()
$userId : int = 0
Return values
Result

reInstallAgent()

public static reInstallAgent(mixed $templateId, array<string|int, mixed> $templateData) : mixed
Parameters
$templateId : mixed
$templateData : array<string|int, mixed>

repeatTask()

Agent handler for repeating tasks.

public static repeatTask(mixed $templateId[, array<string|int, mixed> $parameters = [] ]) : mixed|string

Create new task based on given template.

Parameters
$templateId : mixed
$parameters : array<string|int, mixed> = []
Tags
throws
ArgumentException
Return values
mixed|string

resurrectFallenTemplates()

public static resurrectFallenTemplates() : mixed

sendEvents()

public sendEvents(int $taskId, int $userId) : void
Parameters
$taskId : int
$userId : int

setConfig()

public setConfig(mixed $field, mixed $value) : mixed
Parameters
$field : mixed
$value : mixed

setConverter()

public setConverter(mixed $converter) : mixed
Parameters
$converter : mixed

unInstallAgent()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results