Bitrix API

Controller extends Controller

FinalYes

Table of Contents

Constants

ADD_EVENT_NAME  = 'timeline_signdocument_add'

Methods

getInstance()  : static
Get an instance of the controller
onComplete()  : array<string|int, mixed>
onCreate()  : array<string|int, mixed>
onFill()  : array<string|int, mixed>
onIntegritySuccess()  : array<string|int, mixed>
onMessageStatusChange()  : bool
onNotificationDelivered()  : mixed
onNotificationError()  : mixed
onNotificationRead()  : mixed
onPinSendLimitReached()  : array<string|int, mixed>
onPrepareToFill()  : array<string|int, mixed>
onRegister()  : array<string|int, mixed>
onRequested()  : array<string|int, mixed>
onSend()  : array<string|int, mixed>
onSendFinal()  : array<string|int, mixed>
onSendIntegrityFailureNotice()  : array<string|int, mixed>
onSendRepeatedly()  : array<string|int, mixed>
onSignCompleted()  : array<string|int, mixed>
onSignConfigureError()  : array<string|int, mixed>
onSigned()  : array<string|int, mixed>
onView()  : 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

Constants

ADD_EVENT_NAME

public mixed ADD_EVENT_NAME = 'timeline_signdocument_add'

Methods

getInstance()

Get an instance of the controller

public static getInstance() : static
Return values
static

onComplete()

public onComplete(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>

onIntegritySuccess()

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

onMessageStatusChange()

public onMessageStatusChange(ItemIdentifier $identifier, int $entryId, MessageData $messageData) : bool
Parameters
$identifier : ItemIdentifier
$entryId : int
$messageData : MessageData
Return values
bool

onPinSendLimitReached()

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

onPrepareToFill()

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

onRegister()

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

onRequested()

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

onSendFinal()

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

onSendIntegrityFailureNotice()

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

onSendRepeatedly()

public onSendRepeatedly(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>

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