Bitrix API

Tracking

Class Tracking

Table of Contents

Constants

CUSTOM_SIGNER_KEY  = 'signer_sender_mail_key'
onChangeStatus  = 'OnMailEventMailChangeStatus'
onClick  = 'OnMailEventMailClick'
onRead  = 'OnMailEventMailRead'
onUnsubscribe  = 'OnMailEventSubscriptionDisable'
SIGN_SALT_ACTION  = 'event_mail_tracking'

Methods

changeStatus()  : bool
Change status of sending.
click()  : bool
Click.
clickFromRequest()  : void
Track click from request.
getLinkClick()  : string
Get click page link.
getLinkRead()  : string
Get read page link
getLinkUnsub()  : string
Get link for unsubscribe.
getSign()  : string
Get sign.
getSignedTag()  : string
Get signed tag.
getSubscriptionList()  : array<string|int, mixed>|bool
Get subscription list.
getTag()  : string
Get tag.
parseSignedTag()  : array<string|int, mixed>
Parse signed tag.
parseTag()  : array<string|int, mixed>
Parse tag.
read()  : bool
Read.
readFromRequest()  : bool
Track read from request.
subscribe()  : bool
Subscribe.
unsubscribe()  : bool
Unsubscribe.
validateSign()  : bool
Verify sign.

Constants

CUSTOM_SIGNER_KEY

public mixed CUSTOM_SIGNER_KEY = 'signer_sender_mail_key'

onChangeStatus

public mixed onChangeStatus = 'OnMailEventMailChangeStatus'

onClick

public mixed onClick = 'OnMailEventMailClick'

onRead

public mixed onRead = 'OnMailEventMailRead'

onUnsubscribe

public mixed onUnsubscribe = 'OnMailEventSubscriptionDisable'

SIGN_SALT_ACTION

public mixed SIGN_SALT_ACTION = 'event_mail_tracking'

Methods

changeStatus()

Change status of sending.

public static changeStatus(Result $callbackResult) : bool
Parameters
$callbackResult : Result

Callback result instance.

Return values
bool

click()

Click.

public static click(array<string|int, mixed> $data) : bool
Parameters
$data : array<string|int, mixed>

Data.

Return values
bool

clickFromRequest()

Track click from request.

public static clickFromRequest() : void

getLinkClick()

Get click page link.

public static getLinkClick(string $moduleId, array<string|int, mixed> $fields[, string|null $urlPage = null ]) : string
Parameters
$moduleId : string

Module ID.

$fields : array<string|int, mixed>

Fields.

$urlPage : string|null = null

Url of custom click page.

Tags
throws
SystemException
Return values
string

getLinkRead()

Get read page link

public static getLinkRead(string $moduleId, array<string|int, mixed> $fields[, string|null $urlPage = null ]) : string
Parameters
$moduleId : string

Module ID.

$fields : array<string|int, mixed>

Fields.

$urlPage : string|null = null

Url of custom click page.

Tags
throws
SystemException
Return values
string

getLinkUnsub()

Get link for unsubscribe.

public static getLinkUnsub(string $moduleId, array<string|int, mixed> $fields[, string|null $urlPage = null ]) : string
Parameters
$moduleId : string

Module ID.

$fields : array<string|int, mixed>

Fields.

$urlPage : string|null = null

Url of custom unsubscribe page.

Tags
throws
ArgumentTypeException
throws
SystemException
Return values
string

getSign()

Get sign.

public static getSign(string $value) : string
Parameters
$value : string

Value.

Tags
throws
ArgumentTypeException
Return values
string

getSignedTag()

Get signed tag.

public static getSignedTag(string $moduleId, array<string|int, mixed> $fields) : string
Parameters
$moduleId : string

Module ID.

$fields : array<string|int, mixed>

Fields.

Tags
throws
ArgumentTypeException
Return values
string

getSubscriptionList()

Get subscription list.

public static getSubscriptionList(array<string|int, mixed> $data) : array<string|int, mixed>|bool
Parameters
$data : array<string|int, mixed>

Data.

Return values
array<string|int, mixed>|bool

getTag()

Get tag.

public static getTag(string $moduleId, array<string|int, mixed> $fields) : string
Parameters
$moduleId : string

Module ID.

$fields : array<string|int, mixed>

Fields.

Return values
string

parseSignedTag()

Parse signed tag.

public static parseSignedTag(string $signedTag) : array<string|int, mixed>
Parameters
$signedTag : string

Signed tag.

Tags
throws
BadSignatureException
throws
ArgumentTypeException
Return values
array<string|int, mixed>

parseTag()

Parse tag.

public static parseTag(string $tag) : array<string|int, mixed>
Parameters
$tag : string

Tag.

Return values
array<string|int, mixed>

read()

Read.

public static read(array<string|int, mixed> $data) : bool
Parameters
$data : array<string|int, mixed>

Data.

Return values
bool

readFromRequest()

Track read from request.

public static readFromRequest() : bool
Return values
bool

subscribe()

Subscribe.

public static subscribe(array<string|int, mixed> $data) : bool
Parameters
$data : array<string|int, mixed>

Data.

Return values
bool

unsubscribe()

Unsubscribe.

public static unsubscribe(array<string|int, mixed> $data) : bool
Parameters
$data : array<string|int, mixed>

Data.

Return values
bool

validateSign()

Verify sign.

public static validateSign(string $value, string $signature) : bool
Parameters
$value : string

Value.

$signature : string

Signature.

Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results