ChannelTrackerManager
Table of Contents
Methods
- getAllTrackers() : array<string|int, IChannelTracker>
- Get all registered Channel Trackers
- getGroupInfo() : IChannelGroupInfo|null
- Get group info by ID.
- getGroupInfos() : array<string|int, IChannelGroupInfo>
- Get Channel Group Info items.
- getInfos() : array<string|int, IChannelInfo>
- Get Channel Info items.
- getTrackerByType() : IChannelTracker|null
- Get Channel Tracker by Type ID.
- initializeUserContext() : void
- Initialize enabled trackers for using by user.
- prepareChannelCaption() : string
- Get Channel Caption.
- prepareChannelKey() : string
- Get Channel Key.
Methods
getAllTrackers()
Get all registered Channel Trackers
public
static getAllTrackers() : array<string|int, IChannelTracker>
Return values
array<string|int, IChannelTracker>getGroupInfo()
Get group info by ID.
public
static getGroupInfo(string $groupID) : IChannelGroupInfo|null
Parameters
- $groupID : string
-
Group ID.
Return values
IChannelGroupInfo|nullgetGroupInfos()
Get Channel Group Info items.
public
static getGroupInfos() : array<string|int, IChannelGroupInfo>
Return values
array<string|int, IChannelGroupInfo>getInfos()
Get Channel Info items.
public
static getInfos() : array<string|int, IChannelInfo>
Return values
array<string|int, IChannelInfo>getTrackerByType()
Get Channel Tracker by Type ID.
public
static getTrackerByType(int $typeID) : IChannelTracker|null
Parameters
- $typeID : int
-
Channel Type ID.
Return values
IChannelTracker|nullinitializeUserContext()
Initialize enabled trackers for using by user.
public
static initializeUserContext() : void
prepareChannelCaption()
Get Channel Caption.
public
static prepareChannelCaption(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.
Return values
stringprepareChannelKey()
Get Channel Key.
public
static prepareChannelKey(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.