Bitrix API

IChannelTracker

Table of Contents

Methods

checkConfigurationPermission()  : bool
Check if current user has permission to configure External Channel.
getTypeID()  : int
Get Channel Type ID
getUrl()  : string
Get External Channel page URL.
initializeUserContext()  : void
Initialize tracker for using by user.
isEnabled()  : bool
Check if External Channel is enabled.
isInUse()  : bool
Check if External 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 External Channel info items.
registerActivity()  : void
Register binding to the channel for specified Activity.
registerDeal()  : void
Register binding to the channel for specified Deal.
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.

Methods

checkConfigurationPermission()

Check if current user has permission to configure External Channel.

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

Array of channel parameters.

Return values
bool

getTypeID()

Get Channel Type ID

public getTypeID() : int
Return values
int

getUrl()

Get External Channel page URL.

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

Array of channel parameters.

Return values
string

initializeUserContext()

Initialize tracker for using by user.

public initializeUserContext() : void

isEnabled()

Check if External Channel is enabled.

public isEnabled() : bool
Return values
bool

isInUse()

Check if External 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.

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.

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.

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