Bitrix API

Consent

FinalYes

Class Consent

Table of Contents

Methods

checkIfConsentRequestLimitExceeded()  : bool
check is consent request num is beyond the maximum
decodeTag()  : mixed
return unsigned tag
encodeTag()  : string
sign $fields with contact parameters
isUnsub()  : bool
check if status equal 'deny' or consent request num is beyond the maximum

Methods

checkIfConsentRequestLimitExceeded()

check is consent request num is beyond the maximum

public static checkIfConsentRequestLimitExceeded(int $requests, string $code) : bool
Parameters
$requests : int
$code : string
Tags
throws
ArgumentException
Return values
bool

decodeTag()

return unsigned tag

public static decodeTag(string $tag) : mixed
Parameters
$tag : string
Tags
throws
ArgumentException
throws
BadSignatureException

encodeTag()

sign $fields with contact parameters

public static encodeTag(array<string|int, mixed> $fields) : string
Parameters
$fields : array<string|int, mixed>
Tags
throws
ArgumentNullException
throws
ArgumentException
Return values
string

isUnsub()

check if status equal 'deny' or consent request num is beyond the maximum

public static isUnsub(string $status, int|null $requests, string|null $code) : bool
Parameters
$status : string

consent status

$requests : int|null

int consent requests num

$code : string|null
Tags
throws
ArgumentNullException
throws
ArgumentException
throws
ArgumentOutOfRangeException
Return values
bool

        
On this page

Search results