Bitrix API

RecipientController extends EntityController

Class RecipientController

Table of Contents

Methods

getEntityTypeID()  : int
Get entity type ID.
getInstance()  : static
Get instance.
getSupportedPullCommands()  : array<string|int, string>
Returns associative array of supported pull commands
loadCommunicationsAndMultifields()  : void
onConvert()  : mixed
Register conversion event in a timeline of a source entity (This entity is a source)
onCreate()  : mixed
Handler of event 'onCreate'.
onDelete()  : mixed
Handler of event 'onDelete'.
onModify()  : mixed
Handler of event 'onModify'.
onRestore()  : mixed
Register restore event in a timeline
prepareAuthorInfo()  : mixed
prepareAuthorInfoBulk()  : mixed
prepareEntityPushTag()  : mixed
prepareHistoryDataModel()  : array<string|int, mixed>
Prepare history data model.
prepareMultiFieldInfo()  : mixed
prepareMultiFieldInfoBulk()  : mixed
prepareSearchContent()  : mixed
register()  : void
Register existed entity in retrospect mode.
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

getEntityTypeID()

Get entity type ID.

public getEntityTypeID() : int
Return values
int

getInstance()

Get instance.

public static getInstance() : static
Return values
static

getSupportedPullCommands()

Returns associative array of supported pull commands

public getSupportedPullCommands() : array<string|int, string>
Return values
array<string|int, string>

loadCommunicationsAndMultifields()

public static loadCommunicationsAndMultifields(array<string|int, mixed> &$items[, CCrmPerms $userPermissions = null ][, array<string|int, mixed> $options = [] ]) : void
Parameters
$items : array<string|int, mixed>
$userPermissions : CCrmPerms = null
$options : array<string|int, mixed> = []

onConvert()

Register conversion event in a timeline of a source entity (This entity is a source)

public onConvert(mixed $ownerID, array<string|int, mixed> $params) : mixed
Parameters
$ownerID : mixed
  • id of a source entity, which this controller is associated with
$params : array<string|int, mixed>

onCreate()

Handler of event 'onCreate'.

public onCreate(int $id, array<string|int, mixed> $params) : mixed
Parameters
$id : int

ID.

$params : array<string|int, mixed>

Parameters.

onDelete()

Handler of event 'onDelete'.

public onDelete(int $ownerID, array<string|int, mixed> $params) : mixed
Parameters
$ownerID : int

Owner ID.

$params : array<string|int, mixed>

Parameters.

onModify()

Handler of event 'onModify'.

public onModify(int $id, array<string|int, mixed> $params) : mixed
Parameters
$id : int

ID.

$params : array<string|int, mixed>

Parameters.

onRestore()

Register restore event in a timeline

public onRestore(mixed $entityID, array<string|int, mixed> $params) : mixed
Parameters
$entityID : mixed
$params : 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>

prepareEntityPushTag()

public prepareEntityPushTag(mixed $entityID) : mixed
Parameters
$entityID : mixed

prepareHistoryDataModel()

Prepare history data model.

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

Data.

$options : array<string|int, mixed>|null = null

Options.

Return values
array<string|int, mixed>

prepareMultiFieldInfo()

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

prepareMultiFieldInfoBulk()

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

prepareSearchContent()

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

register()

Register existed entity in retrospect mode.

public register(int $ownerID[, array<string|int, mixed> $options = null ]) : void
Parameters
$ownerID : int

Entity ID

$options : array<string|int, mixed> = null

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