Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Открытые члены | Открытые статические члены | Защищенные члены | Защищенные данные | Статические защищенные данные | Полный список членов класса
Класс Adapter
+ Граф наследования:Adapter:

Открытые члены

 __construct (iBase $transport)
 
 getName ()
 
 getCode ()
 
 getSupportedRecipientTypes ()
 
 setSendCount ($sendCount)
 
 getSendCount ()
 
 loadConfiguration ()
 
 saveConfiguration (Message\Configuration $configuration)
 
 getConsentMaxRequests ()
 
 start ()
 
 send (Message\Adapter $message)
 
 end ()
 
 __destroy ()
 
 getDuration ($message=null)
 
 isConsentAvailable ()
 
 isConsentSupported ()
 
 sendConsent ($message, $data)
 
 sendTestConsent ($message, $data)
 
 hasLimiters ()
 
 getLimiters (Message\iBase $message=null)
 
 isLimitsExceeded (Message\iBase $message=null)
 
 getExceededLimiter (Message\iBase $message=null)
 
- Открытые члены унаследованные от iBase
 getSupportedTransports ()
 
 loadConfiguration ($id=null)
 
 saveConfiguration (Configuration $configuration)
 
 copyConfiguration ($id)
 

Открытые статические члены

static getInstance ($code)
 

Защищенные члены

 sendConsentByBuilder (Message\Adapter $message, AbstractConsentMessageBuilder $builder)
 

Защищенные данные

 $transport
 
 $startResult = null
 
 $isStarted = false
 
 $isEnded = false
 
 $limiters = null
 
 $sendCount = 0
 

Статические защищенные данные

static $list
 

Дополнительные унаследованные члены

- Открытые атрибуты унаследованные от iBase
const CODE_MAIL = 'mail'
 
const CODE_TOLOKA = 'toloka'
 
const CODE_WEB_HOOK = 'web_hook'
 
const CODE_SMS = 'sms'
 
const CODE_IM = 'im'
 
const CODE_CALL = 'call'
 
const CODE_AUDIO_CALL = 'audio_call'
 
const CODE_UNDEFINED = ''
 
const CODE_MASTER_YANDEX = 'master_yandex'
 
const EVENT_NAME = 'onSenderMessageList'
 

Подробное описание

См. определение в файле adapter.php строка 20

Конструктор(ы)

◆ __construct()

__construct ( iBase $transport)

Transport constructor.

Аргументы
iBase$transportTransport.

См. определение в файле adapter.php строка 80

Методы

◆ __destroy()

__destroy ( )

Destroy.

См. определение в файле adapter.php строка 221

◆ end()

end ( )

End.

См. определение в файле adapter.php строка 207

◆ getCode()

getCode ( )

Get code.

Возвращает
string

Замещает iBase.

См. определение в файле adapter.php строка 100

◆ getConsentMaxRequests()

getConsentMaxRequests ( )

См. определение в файле adapter.php строка 156

◆ getDuration()

getDuration ( $message = null)

Get send duration in seconds.

Аргументы
Adapter | null$messageMessage.
Возвращает
integer

См. определение в файле adapter.php строка 232

◆ getExceededLimiter()

getExceededLimiter ( Message\iBase $message = null)

Check limit exceeding and returns iLimiter.

Аргументы
Message\iBase | null$messageMessage.
Возвращает
iLimiter|null

См. определение в файле adapter.php строка 364

◆ getInstance()

static getInstance ( $code)
static

Get instance.

Аргументы
string$codeCode.
Возвращает
Adapter

См. определение в файле adapter.php строка 51

◆ getLimiters()

getLimiters ( Message\iBase $message = null)

Get limiters.

Аргументы
Message\iBase$messageMessage.
Возвращает
iLimiter[]

Замещает iLimitation.

См. определение в файле adapter.php строка 320

◆ getName()

getName ( )

Get name.

Возвращает
string

Замещает iBase.

См. определение в файле adapter.php строка 90

◆ getSendCount()

getSendCount ( )

Get count of send.

Возвращает
integer

См. определение в файле adapter.php строка 132

◆ getSupportedRecipientTypes()

getSupportedRecipientTypes ( )

Get supported recipient types.

Возвращает
integer[]

См. определение в файле adapter.php строка 110

◆ hasLimiters()

hasLimiters ( )

Has limiters.

Возвращает
bool

См. определение в файле adapter.php строка 309

◆ isConsentAvailable()

isConsentAvailable ( )

check if consent supported by transport and check is consent need

Возвращает
bool
Исключения

Bitrix\Main\ArgumentNullException

Исключения

Bitrix\Main\ArgumentOutOfRangeException

См. определение в файле adapter.php строка 248

◆ isConsentSupported()

isConsentSupported ( )

check if consent messaging supported by this transport

Возвращает
bool

См. определение в файле adapter.php строка 257

◆ isLimitsExceeded()

isLimitsExceeded ( Message\iBase $message = null)

Check limit exceeding.

Аргументы
Message\iBase$messageMessage.
Возвращает
bool

См. определение в файле adapter.php строка 343

◆ loadConfiguration()

loadConfiguration ( )

Load configuration.

Возвращает
Message\Configuration

См. определение в файле adapter.php строка 142

◆ saveConfiguration()

saveConfiguration ( Message\Configuration $configuration)

Save configuration.

Аргументы
Message\Configuration$configurationConfiguration.

См. определение в файле adapter.php строка 152

◆ send()

send ( Message\Adapter $message)

Send message.

Аргументы
Message\Adapter$messageMessage.
Возвращает
bool

См. определение в файле adapter.php строка 191

◆ sendConsent()

sendConsent ( $message,
$data )

Send consent message to contact

Аргументы
array$data
Возвращает
bool|null
Исключения

Bitrix\Main\ArgumentNullException

Исключения

Bitrix\Main\ArgumentOutOfRangeException

См. определение в файле adapter.php строка 271

◆ sendConsentByBuilder()

sendConsentByBuilder ( Message\Adapter $message,
AbstractConsentMessageBuilder $builder )
protected

См. определение в файле adapter.php строка 300

◆ sendTestConsent()

sendTestConsent ( $message,
$data )

Send Test Consent Message

Аргументы
$data
Возвращает
bool
Исключения

Bitrix\Main\ArgumentNullException

Исключения

Bitrix\Main\ArgumentOutOfRangeException

См. определение в файле adapter.php строка 290

◆ setSendCount()

setSendCount ( $sendCount)

Set count of send.

Аргументы
integer$sendCountCount of send.
Возвращает
$this

См. определение в файле adapter.php строка 121

◆ start()

start ( )

Start.

См. определение в файле adapter.php строка 167

Данные класса

◆ $isEnded

$isEnded = false
protected

См. определение в файле adapter.php строка 36

◆ $isStarted

$isStarted = false
protected

См. определение в файле adapter.php строка 33

◆ $limiters

$limiters = null
protected

См. определение в файле adapter.php строка 39

◆ $list

$list
staticprotected

См. определение в файле adapter.php строка 26

◆ $sendCount

$sendCount = 0
protected

См. определение в файле adapter.php строка 42

◆ $startResult

$startResult = null
protected

См. определение в файле adapter.php строка 29

◆ $transport

$transport
protected

См. определение в файле adapter.php строка 23