Bitrix API

Controller extends Controller

FinalYes

Table of Contents

Methods

getInstance()  : static
Get an instance of the controller
onAutomationLaunchError()  : void
onCallScoringEmptyResult()  : void
onCreate()  : void
onFinishCallScoring()  : void
onFinishFillingEntityFields()  : void
onFinishProcessingEntityFields()  : void
onFinishRecordTranscript()  : void
onFinishRecordTranscriptSummary()  : void
onLaunchError()  : void
onStartCallScoring()  : void
onStartFillingEntityFields()  : void
onStartRecordTranscript()  : void
onStartRecordTranscriptSummary()  : void
prepareAuthorInfo()  : mixed
prepareAuthorInfoBulk()  : mixed
prepareHistoryDataModel()  : array<string|int, mixed>
Prepare data about an timeline entry. The data is used in interface to display timeline event
prepareSearchContent()  : string
sendPullEventOnAdd()  : void
Send pull event about timeline item creation
sendPullEventOnDelete()  : void
Send pull event about timeline item deletion
sendPullEventOnPin()  : mixed
sendPullEventOnUpdate()  : void
Send pull event about timeline item modification

Methods

getInstance()

Get an instance of the controller

public static getInstance() : static
Return values
static

onAutomationLaunchError()

public onAutomationLaunchError(ItemIdentifier $identifier, int $activityId, array<string|int, mixed> $settings[, int $userId = null ]) : void
Parameters
$identifier : ItemIdentifier
$activityId : int
$settings : array<string|int, mixed>
$userId : int = null

onCallScoringEmptyResult()

public onCallScoringEmptyResult(ItemIdentifier $identifier, int $activityId[, array<string|int, mixed> $settings = [] ][, int $userId = null ]) : void
Parameters
$identifier : ItemIdentifier
$activityId : int
$settings : array<string|int, mixed> = []
$userId : int = null

onCreate()

public onCreate(array<string|int, mixed> $input, int $typeCategoryId[, int|null $authorId = null ]) : void
Parameters
$input : array<string|int, mixed>
$typeCategoryId : int
$authorId : int|null = null

onFinishCallScoring()

public onFinishCallScoring(ItemIdentifier $identifier, int $activityId[, array<string|int, mixed> $settings = [] ][, int $userId = null ]) : void
Parameters
$identifier : ItemIdentifier
$activityId : int
$settings : array<string|int, mixed> = []
$userId : int = null

onFinishFillingEntityFields()

public onFinishFillingEntityFields(ItemIdentifier $identifier, int $activityId[, array<string|int, mixed> $settings = [] ][, int $userId = null ]) : void
Parameters
$identifier : ItemIdentifier
$activityId : int
$settings : array<string|int, mixed> = []
$userId : int = null

onFinishProcessingEntityFields()

public onFinishProcessingEntityFields(ItemIdentifier $identifier, int $activityId[, int $userId = null ]) : void
Parameters
$identifier : ItemIdentifier
$activityId : int
$userId : int = null

onFinishRecordTranscript()

public onFinishRecordTranscript(ItemIdentifier $identifier, int $activityId[, array<string|int, mixed> $settings = [] ][, int $userId = null ]) : void
Parameters
$identifier : ItemIdentifier
$activityId : int
$settings : array<string|int, mixed> = []
$userId : int = null

onFinishRecordTranscriptSummary()

public onFinishRecordTranscriptSummary(ItemIdentifier $identifier, int $activityId[, array<string|int, mixed> $settings = [] ][, int $userId = null ]) : void
Parameters
$identifier : ItemIdentifier
$activityId : int
$settings : array<string|int, mixed> = []
$userId : int = null

onLaunchError()

public onLaunchError(ItemIdentifier $identifier, int $activityId[, array<string|int, mixed> $settings = [] ][, int $userId = null ]) : void
Parameters
$identifier : ItemIdentifier
$activityId : int
$settings : array<string|int, mixed> = []
$userId : int = null

onStartCallScoring()

public onStartCallScoring(ItemIdentifier $identifier, int $activityId[, int $userId = null ]) : void
Parameters
$identifier : ItemIdentifier
$activityId : int
$userId : int = null

onStartFillingEntityFields()

public onStartFillingEntityFields(ItemIdentifier $identifier, int $activityId[, int $userId = null ]) : void
Parameters
$identifier : ItemIdentifier
$activityId : int
$userId : int = null

onStartRecordTranscript()

public onStartRecordTranscript(ItemIdentifier $identifier, int $activityId[, int $userId = null ]) : void
Parameters
$identifier : ItemIdentifier
$activityId : int
$userId : int = null

onStartRecordTranscriptSummary()

public onStartRecordTranscriptSummary(ItemIdentifier $identifier, int $activityId[, int $userId = null ]) : void
Parameters
$identifier : ItemIdentifier
$activityId : int
$userId : int = null

prepareAuthorInfo()

public static prepareAuthorInfo(array<string|int, mixed> &$item) : mixed
Parameters
$item : array<string|int, mixed>

prepareAuthorInfoBulk()

public static prepareAuthorInfoBulk(array<string|int, mixed> &$items) : mixed
Parameters
$items : array<string|int, mixed>

prepareHistoryDataModel()

Prepare data about an timeline entry. The data is used in interface to display timeline event

public prepareHistoryDataModel(array<string|int, mixed> $data[, array<string|int, mixed> $options = null ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$options : array<string|int, mixed> = null

= [ 'ENABLE_USER_INFO' => false, // prepare detailed author info (link, image, name). Disabled by default ];

Return values
array<string|int, mixed>

prepareSearchContent()

public prepareSearchContent(array<string|int, mixed> $params) : string
Parameters
$params : array<string|int, mixed>
Return values
string

sendPullEventOnAdd()

Send pull event about timeline item creation

public sendPullEventOnAdd(ItemIdentifier $itemIdentifier, int $timelineEntryId[, int|null $userId = null ]) : void
Parameters
$itemIdentifier : ItemIdentifier
$timelineEntryId : int
$userId : int|null = null

sendPullEventOnDelete()

Send pull event about timeline item deletion

public sendPullEventOnDelete(ItemIdentifier $itemIdentifier, int $timelineEntryId[, int|null $userId = null ]) : void
Parameters
$itemIdentifier : ItemIdentifier
$timelineEntryId : int
$userId : int|null = null

sendPullEventOnPin()

public sendPullEventOnPin(ItemIdentifier $itemIdentifier, int $timelineEntryId, bool $isPinned[, int $userId = null ]) : mixed
Parameters
$itemIdentifier : ItemIdentifier
$timelineEntryId : int
$isPinned : bool
$userId : int = null

sendPullEventOnUpdate()

Send pull event about timeline item modification

public sendPullEventOnUpdate(ItemIdentifier $itemIdentifier, int $timelineEntryId[, int|null $userId = null ]) : void
Parameters
$itemIdentifier : ItemIdentifier
$timelineEntryId : int
$userId : int|null = null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results