ImOpenLineChannelInfo extends ChannelInfo
Table of Contents
Methods
- __construct() : mixed
- checkConfigurationPermission() : bool
- Check if current user has permission to configure this channel.
- compareBySort() : int
- Compare items by sort field
- externalize() : array<string|int, mixed>
- Externalize
- getCaption() : string
- Get channel caption.
- getChannelComponent() : string
- Get Channel Component.
- getChannelOrigin() : string
- Get Channel Origin (Identifier, GUID or other sign).
- getChannelTypeID() : ChannelType
- Get Channel Type ID.
- getConfigurationUrl() : string
- Get channel URL.
- getGroupID() : string
- Get group ID
- getKey() : string
- Get channel unique key.
- getSort() : int
- Get sorting
- isEnabled() : bool
- Check if channel enabled.
- isInUse() : bool
- Check if channel in use.
- prepareKey() : string
- Get channel unique key.
Methods
__construct()
public
__construct(mixed $caption, mixed $lineID, mixed $connectorID[, mixed $sort = 1000 ][, mixed $groupID = '' ]) : mixed
Parameters
- $caption : mixed
- $lineID : mixed
- $connectorID : mixed
- $sort : mixed = 1000
- $groupID : mixed = ''
checkConfigurationPermission()
Check if current user has permission to configure this channel.
public
checkConfigurationPermission() : bool
Return values
boolcompareBySort()
Compare items by sort field
public
static compareBySort(ChannelInfo $first, ChannelInfo $second) : int
Parameters
- $first : ChannelInfo
- $second : ChannelInfo
Return values
intexternalize()
Externalize
public
externalize() : array<string|int, mixed>
Return values
array<string|int, mixed>getCaption()
Get channel caption.
public
getCaption() : string
Return values
stringgetChannelComponent()
Get Channel Component.
public
getChannelComponent() : string
Return values
stringgetChannelOrigin()
Get Channel Origin (Identifier, GUID or other sign).
public
getChannelOrigin() : string
Return values
stringgetChannelTypeID()
Get Channel Type ID.
public
getChannelTypeID() : ChannelType
Return values
ChannelTypegetConfigurationUrl()
Get channel URL.
public
getConfigurationUrl() : string
Return values
stringgetGroupID()
Get group ID
public
getGroupID() : string
Return values
stringgetKey()
Get channel unique key.
public
getKey() : string
Return values
stringgetSort()
Get sorting
public
getSort() : int
Return values
intisEnabled()
Check if channel enabled.
public
isEnabled() : bool
Return values
boolisInUse()
Check if channel in use.
public
isInUse() : bool
Return values
boolprepareKey()
Get channel unique key.
public
static prepareKey(int $typeID[, array<string|int, mixed>|null $params = null ]) : string
Parameters
- $typeID : int
-
Channel Type ID.
- $params : array<string|int, mixed>|null = null
-
Channel Params.