Bitrix API

PullManager

Table of Contents

Constants

EVENT_KANBAN_UPDATED  = 'CRM_KANBANUPDATED'
MODULE_ID  = 'crm'

Methods

__construct()  : mixed
getAdditionalPullTags()  : array<string|int, mixed>
getChannelShared()  : array<string|int, mixed>|false
getInstance()  : PullManager
isEnabled()  : bool
isPullChannelActiveByTag()  : bool
onGetDependentModule()  : array<string|int, mixed>
sendCrmInitiatedEvent()  : bool
sendItemAddedEvent()  : bool
sendItemDeletedEvent()  : bool
sendItemUpdatedEvent()  : bool
In some cases may not contain additional payload about `action`.
sendStageAddedEvent()  : bool
sendStageDeletedEvent()  : bool
sendStageUpdatedEvent()  : bool
setEnabled()  : self
subscribeOnItemUpdate()  : string|null
subscribeOnKanbanUpdate()  : string|null
unSubscribeUserPullEvents()  : void

Constants

EVENT_KANBAN_UPDATED

public mixed EVENT_KANBAN_UPDATED = 'CRM_KANBANUPDATED'

Methods

getAdditionalPullTags()

public getAdditionalPullTags(string $entityType[, array<string|int, mixed>|null $params = null ]) : array<string|int, mixed>
Parameters
$entityType : string
$params : array<string|int, mixed>|null = null
Return values
array<string|int, mixed>

getChannelShared()

public getChannelShared() : array<string|int, mixed>|false
Return values
array<string|int, mixed>|false

isEnabled()

public isEnabled() : bool
Return values
bool

isPullChannelActiveByTag()

public static isPullChannelActiveByTag(string $tag) : bool
Parameters
$tag : string
Return values
bool

onGetDependentModule()

public static onGetDependentModule() : array<string|int, mixed>
Return values
array<string|int, mixed>

sendCrmInitiatedEvent()

public sendCrmInitiatedEvent([array<string|int, mixed>|null $channelShared = null ]) : bool
Parameters
$channelShared : array<string|int, mixed>|null = null
Return values
bool

sendItemAddedEvent()

public sendItemAddedEvent(array<string|int, mixed> $item[, array<string|int, mixed>|null $params = null ]) : bool
Parameters
$item : array<string|int, mixed>
$params : array<string|int, mixed>|null = null
Return values
bool

sendItemDeletedEvent()

public sendItemDeletedEvent(array<string|int, mixed> $item[, array<string|int, mixed>|null $params = null ]) : bool
Parameters
$item : array<string|int, mixed>
$params : array<string|int, mixed>|null = null
Return values
bool

sendItemUpdatedEvent()

In some cases may not contain additional payload about `action`.

public sendItemUpdatedEvent(array<string|int, mixed> $item[, array<string|int, mixed>|null $params = null ]) : bool
Parameters
$item : array<string|int, mixed>
$params : array<string|int, mixed>|null = null
Return values
bool

sendStageAddedEvent()

public sendStageAddedEvent(array<string|int, mixed> $item[, array<string|int, mixed>|null $params = null ]) : bool
Parameters
$item : array<string|int, mixed>
$params : array<string|int, mixed>|null = null
Return values
bool

sendStageDeletedEvent()

public sendStageDeletedEvent(array<string|int, mixed> $item[, array<string|int, mixed>|null $params = null ]) : bool
Parameters
$item : array<string|int, mixed>
$params : array<string|int, mixed>|null = null
Return values
bool

sendStageUpdatedEvent()

public sendStageUpdatedEvent(array<string|int, mixed> $item[, array<string|int, mixed>|null $params = null ]) : bool
Parameters
$item : array<string|int, mixed>
$params : array<string|int, mixed>|null = null
Return values
bool

setEnabled()

public setEnabled(bool $enabled) : self
Parameters
$enabled : bool
Return values
self

subscribeOnItemUpdate()

public subscribeOnItemUpdate(int $entityTypeId, int $itemId) : string|null
Parameters
$entityTypeId : int
$itemId : int
Return values
string|null

subscribeOnKanbanUpdate()

public subscribeOnKanbanUpdate(string $entityType[, array<string|int, mixed>|null $params = null ]) : string|null
Parameters
$entityType : string
$params : array<string|int, mixed>|null = null
Return values
string|null

unSubscribeUserPullEvents()

public unSubscribeUserPullEvents(int $userId, int $entityTypeId, int $entityId) : void
Parameters
$userId : int
$entityTypeId : int
$entityId : int

        
On this page

Search results