ActivityChannelBinding
Class ActivityChannelBinding Managing of Activity bindings to external channels.
Table of Contents
Methods
- exists() : bool
- Check if specified Activity has bindings to channel.
- getAll() : array<string|int, mixed>
- Get all bindings to channels for specified Activity.
- register() : void
- Register binding to the channel for specified Activity.
- synchronize() : mixed
- Synchronize Activity statistics.
- unregister() : void
- Unregister binding to the channel for specified Activity.
- unregisterAll() : void
- Unregister bindings to all channels for specified Activity.
Methods
exists()
Check if specified Activity has bindings to channel.
public
static exists(int $ID) : bool
Parameters
- $ID : int
-
Activity ID.
Tags
Return values
boolgetAll()
Get all bindings to channels for specified Activity.
public
static getAll(int $ID) : array<string|int, mixed>
Parameters
- $ID : int
-
Activity ID.
Tags
Return values
array<string|int, mixed>register()
Register binding to the channel for specified Activity.
public
static register(int $ID, ChannelType $typeID[, array<string|int, mixed> $params = null ]) : void
Parameters
- $ID : int
-
Activity ID.
- $typeID : ChannelType
-
Channel Type ID.
- $params : array<string|int, mixed> = null
-
Array of binding parameters. For example ORIGIN_ID and COMPONENT_ID.
Tags
synchronize()
Synchronize Activity statistics.
public
static synchronize(int $ID, array<string|int, mixed> $fields) : mixed
Parameters
- $ID : int
-
Activity ID
- $fields : array<string|int, mixed>
-
Activity Fields
Tags
unregister()
Unregister binding to the channel for specified Activity.
public
static unregister(int $ID, ChannelType $typeID) : void
Parameters
- $ID : int
-
Activity ID.
- $typeID : ChannelType
-
Channel Type ID.
Tags
unregisterAll()
Unregister bindings to all channels for specified Activity.
public
static unregisterAll(int $ID) : void
Parameters
- $ID : int
-
Activity ID.