BaseInternal extends Base
AbstractYes
Table of Contents
Constants
- PROVIDER_TYPE_INTERNAL = 'internal'
- PROVIDER_TYPE_REST = 'rest'
Methods
- canUse() : bool
- Check can use state of provider.
- clearOptions() : bool
- confirmRegistration() : Result
- disableDemo() : $this
- Disable demo mode.
- enableDemo() : $this
- Enable demo mode.
- getDefaultSender() : string
- Get default sender alias.
- getExternalId() : mixed
- getExternalManageUrl() : string
- getId() : string
- getManageUrl() : string
- getMessageStatus() : MessageStatusResult
- getName() : string
- getOwnerInfo() : array<string|int, mixed>
- getSenderList() : array<string|int, mixed>
- Get senders list.
- getShortName() : string
- getType() : string
- Get type of provider.
- isConfirmed() : bool
- Check is registration confirmed.
- isDemo() : bool
- Check demo status.
- isInternal() : mixed
- isRegistered() : bool
- Check registration state.
- isRest() : mixed
- register() : Result
- sendConfirmationCode() : Result
- sendMessage() : SendMessageResult
- setDefaultSender() : $this
- Set default sms sender alias.
Constants
PROVIDER_TYPE_INTERNAL
public
mixed
PROVIDER_TYPE_INTERNAL
= 'internal'
PROVIDER_TYPE_REST
public
mixed
PROVIDER_TYPE_REST
= 'rest'
Methods
canUse()
Check can use state of provider.
public
canUse() : bool
Return values
boolclearOptions()
public
clearOptions() : bool
Return values
boolconfirmRegistration()
public
confirmRegistration(array<string|int, mixed> $fields) : Result
Parameters
- $fields : array<string|int, mixed>
Return values
ResultdisableDemo()
Disable demo mode.
public
disableDemo() : $this
Return values
$thisenableDemo()
Enable demo mode.
public
enableDemo() : $this
Return values
$thisgetDefaultSender()
Get default sender alias.
public
abstract getDefaultSender() : string
Return values
stringgetExternalId()
public
getExternalId() : mixed
getExternalManageUrl()
public
abstract getExternalManageUrl() : string
Return values
stringgetId()
public
abstract getId() : string
Return values
string —Unique id.
getManageUrl()
public
getManageUrl() : string
Return values
stringgetMessageStatus()
public
abstract getMessageStatus(string $messageId) : MessageStatusResult
Parameters
- $messageId : string
-
Message Id.
Return values
MessageStatusResult —Message status result.
getName()
public
abstract getName() : string
Return values
stringgetOwnerInfo()
public
abstract getOwnerInfo() : array<string|int, mixed>
Return values
array<string|int, mixed>getSenderList()
Get senders list.
public
abstract getSenderList() : array<string|int, mixed>
Return values
array<string|int, mixed>getShortName()
public
abstract getShortName() : string
Return values
stringgetType()
Get type of provider.
public
getType() : string
Return values
string —PROVIDER_TYPE_INTERNAL or PROVIDER_TYPE_REST
isConfirmed()
Check is registration confirmed.
public
isConfirmed() : bool
Return values
boolisDemo()
Check demo status.
public
isDemo() : bool
Return values
boolisInternal()
public
isInternal() : mixed
isRegistered()
Check registration state.
public
abstract isRegistered() : bool
Return values
boolisRest()
public
isRest() : mixed
register()
public
abstract register(array<string|int, mixed> $fields) : Result
Parameters
- $fields : array<string|int, mixed>
Return values
ResultsendConfirmationCode()
public
sendConfirmationCode() : Result
Return values
ResultsendMessage()
public
abstract sendMessage(Message $message) : SendMessageResult
Parameters
- $message : Message
Return values
SendMessageResult —Send operation result.
setDefaultSender()
Set default sms sender alias.
public
abstract setDefaultSender(string $sender) : $this
Parameters
- $sender : string
-
Sender alias.