Bitrix API

Adapter implements iBase, iLimitation

Class Transport

Table of Contents

Interfaces

iBase
Interface iBase
iLimitation
Interface iLimitable

Methods

__construct()  : mixed
Transport constructor.
__destroy()  : mixed
Destroy.
create()  : static
Create.
end()  : void
End.
getCode()  : string
Get code.
getConsentMaxRequests()  : mixed
getDuration()  : int
Get send duration in seconds.
getExceededLimiter()  : iLimiter|null
Check limit exceeding and returns iLimiter.
getInstance()  : Adapter
Get instance.
getLimiters()  : array<string|int, iLimiter>
Get limiters.
getName()  : string
Get name.
getSendCount()  : int
Get count of send.
getSupportedRecipientTypes()  : array<string|int, int>
Get supported recipient types.
hasLimiters()  : bool
Has limiters.
isConsentAvailable()  : bool
check if consent supported by transport and check is consent need
isConsentSupported()  : bool
check if consent messaging supported by this transport
isLimitsExceeded()  : bool
Check limit exceeding.
loadConfiguration()  : Configuration
Load configuration.
saveConfiguration()  : void
Save configuration.
send()  : bool
Send message.
sendConsent()  : bool|null
Send consent message to contact
sendTestConsent()  : bool
Send Test Consent Message
setSendCount()  : $this
Set count of send.
start()  : void
Start.

Methods

__construct()

Transport constructor.

public __construct(iBase $transport) : mixed
Parameters
$transport : iBase

Transport.

__destroy()

Destroy.

public __destroy() : mixed

create()

Create.

public static create(string $code) : static
Parameters
$code : string

Code.

Tags
throws
ArgumentException
Return values
static

getCode()

Get code.

public getCode() : string
Return values
string

getConsentMaxRequests()

public getConsentMaxRequests() : mixed

getDuration()

Get send duration in seconds.

public getDuration([Adapter|null $message = null ]) : int
Parameters
$message : Adapter|null = null

Message.

Return values
int

getExceededLimiter()

Check limit exceeding and returns iLimiter.

public getExceededLimiter([iBase|null $message = null ]) : iLimiter|null
Parameters
$message : iBase|null = null

Message.

Return values
iLimiter|null

getInstance()

Get instance.

public static getInstance(string $code) : Adapter
Parameters
$code : string

Code.

Return values
Adapter

getLimiters()

Get limiters.

public getLimiters([iBase $message = null ]) : array<string|int, iLimiter>
Parameters
$message : iBase = null

Message.

Return values
array<string|int, iLimiter>

getName()

Get name.

public getName() : string
Return values
string

getSendCount()

Get count of send.

public getSendCount() : int
Return values
int

getSupportedRecipientTypes()

Get supported recipient types.

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

hasLimiters()

Has limiters.

public hasLimiters() : bool
Return values
bool

isConsentAvailable()

check if consent supported by transport and check is consent need

public isConsentAvailable() : bool
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
bool

isConsentSupported()

check if consent messaging supported by this transport

public isConsentSupported() : bool
Return values
bool

isLimitsExceeded()

Check limit exceeding.

public isLimitsExceeded([iBase $message = null ]) : bool
Parameters
$message : iBase = null

Message.

Return values
bool

send()

Send message.

public send(Adapter $message) : bool
Parameters
$message : Adapter

Message.

Return values
bool

sendConsent()

Send consent message to contact

public sendConsent(mixed $message, array<string|int, mixed> $data) : bool|null
Parameters
$message : mixed
$data : array<string|int, mixed>
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
bool|null

sendTestConsent()

Send Test Consent Message

public sendTestConsent(mixed $message, mixed $data) : bool
Parameters
$message : mixed
$data : mixed
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
bool

setSendCount()

Set count of send.

public setSendCount(int $sendCount) : $this
Parameters
$sendCount : int

Count of send.

Return values
$this

start()

Start.

public start() : void 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results