Bitrix API

IMOpenLineTracker extends ChannelTracker

Table of Contents

Constants

CHAT_CONNECTOR  = 'livechat'

Methods

__construct()  : mixed
checkConfigurationPermission()  : bool
Check if current user has permission to configure IM Open Lines.
checkConnectorConfigurationPermission()  : bool
Check if current user has permission to configure IM Open Lines feature.
compareConnectorInfoBySort()  : int
Compare connector info by sort field.
getConnectorCaption()  : string
Get Open Line Connector name
getConnectorInfos()  : array<string|int, mixed>
Get all active connector info array.
getConnectorUrl()  : string
Get IM Open Lines feature URL.
getInstance()  : IMOpenLineTracker
Get manager instance
getItems()  : mixed
getTypeID()  : int
Get Channel Type ID
getUrl()  : string
Get IM Open Lines URL.
initializeUserContext()  : void
Initialize tracker for using by user.
isConnectorEnabled()  : bool
Check if IM Open Lines connector is enabled
isConnectorInUse()  : bool
Check if IM Open Lines connector in use
isEnabled()  : bool
Check if IM Open Lines enabled.
isInUse()  : bool
Check if channel is in use.
prepareCaption()  : string
Prepare channel caption
prepareChannelGroupInfos()  : array<string|int, IChannelGroupInfo>
Create channel group info items.
prepareChannelInfos()  : array<string|int, IChannelInfo>
Create channel info items.
registerActivity()  : void
Register binding to the channel for specified Activity.
registerDeal()  : void
Register binding to the channel for specified Deal.
registerInstance()  : mixed
Add instance of this manager to collection
registerLead()  : void
Register binding to the channel for specified Lead.
unregisterActivity()  : void
Unregister binding to the channel for specified Activity.
unregisterDeal()  : void
Unregister binding to the channel for specified Deal.
unregisterLead()  : void
Unregister binding to the channel for specified Lead.

Constants

Methods

checkConfigurationPermission()

Check if current user has permission to configure IM Open Lines.

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

Array of channel parameters.

Return values
bool

checkConnectorConfigurationPermission()

Check if current user has permission to configure IM Open Lines feature.

public checkConnectorConfigurationPermission(string $connectorID) : bool
Parameters
$connectorID : string

Connector ID.

Return values
bool

compareConnectorInfoBySort()

Compare connector info by sort field.

public static compareConnectorInfoBySort(array<string|int, mixed> $a, array<string|int, mixed> $b) : int
Parameters
$a : array<string|int, mixed>

First connector info.

$b : array<string|int, mixed>

Second connector info.

Return values
int

getConnectorCaption()

Get Open Line Connector name

public getConnectorCaption(string $connectorID) : string
Parameters
$connectorID : string

Connector ID.

Return values
string

getConnectorInfos()

Get all active connector info array.

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

getConnectorUrl()

Get IM Open Lines feature URL.

public getConnectorUrl(string $connectorID) : string
Parameters
$connectorID : string

Connector ID.

Tags
throws
LoaderException
Return values
string

getTypeID()

Get Channel Type ID

public getTypeID() : int
Return values
int

getUrl()

Get IM Open Lines URL.

public getUrl([array<string|int, mixed> $params = null ]) : string
Parameters
$params : array<string|int, mixed> = null

Array of channel parameters

Return values
string

initializeUserContext()

Initialize tracker for using by user.

public initializeUserContext() : void

isConnectorEnabled()

Check if IM Open Lines connector is enabled

public isConnectorEnabled(string $connectorID) : bool
Parameters
$connectorID : string

Connector ID.

Return values
bool

isConnectorInUse()

Check if IM Open Lines connector in use

public isConnectorInUse(string $connectorID[, int $lineID = 0 ]) : bool
Parameters
$connectorID : string

Connector ID.

$lineID : int = 0

Line ID.

Return values
bool

isEnabled()

Check if IM Open Lines enabled.

public isEnabled() : bool
Return values
bool

isInUse()

Check if channel is in use.

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

Array of channel parameters.

Return values
bool

prepareCaption()

Prepare channel caption

public prepareCaption([array<string|int, mixed>|null $params = null ]) : string
Parameters
$params : array<string|int, mixed>|null = null

Array of channel parameters.

Return values
string

registerActivity()

Register binding to the channel for specified Activity.

public registerActivity(int $ID[, array<string|int, mixed> $params = null ]) : void
Parameters
$ID : int

Activity ID.

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

Array of binding parameters. For example ORIGIN_ID and COMPONENT_ID.

Tags
throws
ArgumentException

registerDeal()

Register binding to the channel for specified Deal.

public registerDeal(int $ID[, array<string|int, mixed> $params = null ]) : void
Parameters
$ID : int

Deal ID.

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

Array of binding parameters. For example ORIGIN_ID and COMPONENT_ID.

Tags
throws
ArgumentException

registerInstance()

Add instance of this manager to collection

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

Destination collection.

registerLead()

Register binding to the channel for specified Lead.

public registerLead(int $ID[, array<string|int, mixed> $params = null ]) : void
Parameters
$ID : int

Lead ID.

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

Array of binding parameters. For example ORIGIN_ID and COMPONENT_ID.

Tags
throws
ArgumentException

unregisterActivity()

Unregister binding to the channel for specified Activity.

public unregisterActivity(int $ID) : void
Parameters
$ID : int

Activity ID.

unregisterDeal()

Unregister binding to the channel for specified Deal.

public unregisterDeal(int $ID) : void
Parameters
$ID : int

Deal ID.

unregisterLead()

Unregister binding to the channel for specified Lead.

public unregisterLead(int $ID) : void
Parameters
$ID : int

Lead ID.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results