Bitrix API

B2eController extends Controller

FinalYes

Table of Contents

Methods

completeActivity()  : void
getInstance()  : static
Get an instance of the controller
notifyAboutActivityChange()  : void
onCancelByEditor()  : array<string|int, mixed>
onCancelByEmployee()  : array<string|int, mixed>
onCancelByResponsiblePerson()  : array<string|int, mixed>
onCancelByReviewer()  : array<string|int, mixed>
onCreate()  : array<string|int, mixed>
onDeliveryError()  : array<string|int, mixed>
onMemberSigningError()  : array<string|int, mixed>
onMemberSigningExpiredError()  : array<string|int, mixed>
onMemberSnilsError()  : array<string|int, mixed>
onMemberStoppedByAssignee()  : array<string|int, mixed>
onMemberStoppedByEditor()  : array<string|int, mixed>
onMemberStoppedByReviewer()  : array<string|int, mixed>
onMessageDelivered()  : array<string|int, mixed>
onMessageSent()  : array<string|int, mixed>
onSending()  : array<string|int, mixed>
onSignCompleted()  : array<string|int, mixed>
onSignConfigureError()  : array<string|int, mixed>
onSignedByEditor()  : array<string|int, mixed>
onSignedByEmployee()  : array<string|int, mixed>
onSignedByResponsiblePerson()  : array<string|int, mixed>
onSignedByReviewer()  : array<string|int, mixed>
onSignedDocumentDelivered()  : array<string|int, mixed>
onSignStarted()  : array<string|int, mixed>
onSignStopped()  : array<string|int, mixed>
onStart()  : array<string|int, mixed>
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
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

completeActivity()

public completeActivity(ItemIdentifier $identifier) : void
Parameters
$identifier : ItemIdentifier

getInstance()

Get an instance of the controller

public static getInstance() : static
Return values
static

notifyAboutActivityChange()

public notifyAboutActivityChange(ItemIdentifier $identifier) : void
Parameters
$identifier : ItemIdentifier

onCancelByEditor()

public onCancelByEditor(ItemIdentifier $identifier, DocumentData $documentData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
Return values
array<string|int, mixed>

onCancelByEmployee()

public onCancelByEmployee(ItemIdentifier $identifier, DocumentData $documentData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
Return values
array<string|int, mixed>

onCancelByResponsiblePerson()

public onCancelByResponsiblePerson(ItemIdentifier $identifier, DocumentData $documentData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
Return values
array<string|int, mixed>

onCancelByReviewer()

public onCancelByReviewer(ItemIdentifier $identifier, DocumentData $documentData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
Return values
array<string|int, mixed>

onCreate()

public onCreate(ItemIdentifier $identifier, DocumentData $documentData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
Return values
array<string|int, mixed>

onMemberSigningError()

public onMemberSigningError(ItemIdentifier $identifier, DocumentData $documentData, MessageData $messageData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
$messageData : MessageData
Return values
array<string|int, mixed>

onMemberSigningExpiredError()

public onMemberSigningExpiredError(ItemIdentifier $identifier, DocumentData $documentData, MessageData $messageData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
$messageData : MessageData
Return values
array<string|int, mixed>

onMemberSnilsError()

public onMemberSnilsError(ItemIdentifier $identifier, DocumentData $documentData, MessageData $messageData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
$messageData : MessageData
Return values
array<string|int, mixed>

onMemberStoppedByAssignee()

public onMemberStoppedByAssignee(ItemIdentifier $identifier, DocumentData $documentData, MessageData $messageData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
$messageData : MessageData
Return values
array<string|int, mixed>

onMemberStoppedByEditor()

public onMemberStoppedByEditor(ItemIdentifier $identifier, DocumentData $documentData, MessageData $messageData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
$messageData : MessageData
Return values
array<string|int, mixed>

onMemberStoppedByReviewer()

public onMemberStoppedByReviewer(ItemIdentifier $identifier, DocumentData $documentData, MessageData $messageData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
$messageData : MessageData
Return values
array<string|int, mixed>

onMessageDelivered()

public onMessageDelivered(ItemIdentifier $identifier, DocumentData $documentData, MessageData $messageData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
$messageData : MessageData
Return values
array<string|int, mixed>

onSignCompleted()

public onSignCompleted(ItemIdentifier $identifier, DocumentData $documentData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
Return values
array<string|int, mixed>

onSignConfigureError()

public onSignConfigureError(ItemIdentifier $identifier, DocumentData $documentData, MessageData $messageData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
$messageData : MessageData
Return values
array<string|int, mixed>

onSignedByEditor()

public onSignedByEditor(ItemIdentifier $identifier, DocumentData $documentData, MessageData $messageData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
$messageData : MessageData
Return values
array<string|int, mixed>

onSignedByEmployee()

public onSignedByEmployee(ItemIdentifier $identifier, DocumentData $documentData, MessageData $messageData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
$messageData : MessageData
Return values
array<string|int, mixed>

onSignedByResponsiblePerson()

public onSignedByResponsiblePerson(ItemIdentifier $identifier, DocumentData $documentData, MessageData $messageData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
$messageData : MessageData
Return values
array<string|int, mixed>

onSignedByReviewer()

public onSignedByReviewer(ItemIdentifier $identifier, DocumentData $documentData, MessageData $messageData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
$messageData : MessageData
Return values
array<string|int, mixed>

onSignedDocumentDelivered()

public onSignedDocumentDelivered(ItemIdentifier $identifier, DocumentData $documentData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
Return values
array<string|int, mixed>

onSignStarted()

public onSignStarted(ItemIdentifier $identifier, DocumentData $documentData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
Return values
array<string|int, mixed>

onSignStopped()

public onSignStopped(ItemIdentifier $identifier, DocumentData $documentData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
Return values
array<string|int, mixed>

onStart()

public onStart(ItemIdentifier $identifier, DocumentData $documentData) : array<string|int, mixed>
Parameters
$identifier : ItemIdentifier
$documentData : DocumentData
Return values
array<string|int, mixed>

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>|null $options = null ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$options : array<string|int, mixed>|null = null

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

Return values
array<string|int, mixed>

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