Base
AbstractYes
Table of Contents
Constants
- PROVIDER_TYPE_INTERNAL = 'internal'
- PROVIDER_TYPE_REST = 'rest'
Methods
- canUse() : bool
- Check can use state of provider.
- getExternalId() : mixed
- getId() : string
- getManageUrl() : string
- getName() : string
- getShortName() : string
- getType() : string
- Get type of provider.
- isInternal() : mixed
- isRest() : mixed
- sendMessage() : SendMessageResult
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
abstract canUse() : bool
Return values
boolgetExternalId()
public
getExternalId() : mixed
getId()
public
abstract getId() : string
Return values
string —Unique id.
getManageUrl()
public
abstract getManageUrl() : string
Return values
string —Manage url.
getName()
public
abstract getName() : string
Return values
stringgetShortName()
public
abstract getShortName() : string
Return values
stringgetType()
Get type of provider.
public
abstract getType() : string
Return values
string —PROVIDER_TYPE_INTERNAL or PROVIDER_TYPE_REST
isInternal()
public
isInternal() : mixed
isRest()
public
isRest() : mixed
sendMessage()
public
abstract sendMessage(Message $message) : SendMessageResult
Parameters
- $message : Message
Return values
SendMessageResult —Send operation result.