Bitrix API

PushManager

Table of Contents

Constants

QUEUE_ROUTE_KEY_CONNECTION  = 'calendar:SyncConnectionPush'
QUEUE_ROUTE_KEY_SECTION  = 'calendar:SyncSectionPush'
TYPE_CONNECTION  = 'CONNECTION'
TYPE_SECTION  = 'SECTION'
TYPE_SECTION_CONNECTION  = 'SECTION_CONNECTION'

Methods

addPush()  : Result
deletePush()  : void
getPush()  : Push|null
handlePush()  : Result
lockConnection()  : bool
renewPush()  : Result
setBlockPush()  : bool
setUnblockPush()  : void
setUnprocessedPush()  : void
unLockConnection()  : bool
updatePush()  : void

Constants

QUEUE_ROUTE_KEY_CONNECTION

public mixed QUEUE_ROUTE_KEY_CONNECTION = 'calendar:SyncConnectionPush'

QUEUE_ROUTE_KEY_SECTION

public mixed QUEUE_ROUTE_KEY_SECTION = 'calendar:SyncSectionPush'

TYPE_CONNECTION

public mixed TYPE_CONNECTION = 'CONNECTION'

TYPE_SECTION_CONNECTION

public mixed TYPE_SECTION_CONNECTION = 'SECTION_CONNECTION'

Methods

addPush()

public addPush(string $entityType, int $entityId, array<string|int, mixed> $data) : Result
Parameters
$entityType : string
$entityId : int
$data : array<string|int, mixed>
Tags
throws
ObjectException
throws
Exception
Return values
Result

deletePush()

public deletePush(Push $push) : void
Parameters
$push : Push
Tags
throws
Exception

getPush()

public getPush(string $entityType, int $entityId) : Push|null
Parameters
$entityType : string
$entityId : int
Tags
throws
ArgumentException
throws
ObjectException
throws
ObjectPropertyException
throws
SystemException
Return values
Push|null

handlePush()

public handlePush(string $channel, string $resourceId[, bool $forceUnprocessedPush = false ]) : Result
Parameters
$channel : string
$resourceId : string
$forceUnprocessedPush : bool = false
Tags
throws
ArgumentException
throws
BaseException
throws
ObjectException
throws
ObjectNotFoundException
throws
ObjectPropertyException
throws
SystemException
throws
Exception
Return values
Result

lockConnection()

public lockConnection(Connection $connection[, int $time = 30 ]) : bool
Parameters
$connection : Connection
$time : int = 30
Return values
bool

renewPush()

public renewPush(Push $push, array<string|int, mixed> $data) : Result
Parameters
$push : Push
$data : array<string|int, mixed>
Tags
throws
ObjectException
throws
Exception
Return values
Result

setBlockPush()

public setBlockPush(Push|null $push) : bool
Parameters
$push : Push|null
Return values
bool

setUnblockPush()

public setUnblockPush(Push|null $push) : void
Parameters
$push : Push|null
Tags
throws
ArgumentException
throws
BaseException
throws
ObjectException
throws
ObjectNotFoundException
throws
ObjectPropertyException
throws
SystemException
throws
Exception

setUnprocessedPush()

public setUnprocessedPush(Push|null $push) : void
Parameters
$push : Push|null
Tags
throws
Exception

updatePush()

public updatePush(Push $pushChannel) : void
Parameters
$pushChannel : Push
Tags
throws
Exception 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results