Class humhub\modules\live\driver\Poll

Inheritancehumhub\modules\live\driver\Poll » humhub\modules\live\driver\BaseDriver » yii\base\BaseObject
Available since version1.2

Database driver for live events

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$idleFactor Factor used in the actual interval calculation in case of user idle. humhub\modules\live\driver\Poll
$idleInterval Interval for updating the update delay in case of user idle in seconds. humhub\modules\live\driver\Poll
$maxLiveEventAge integer Seconds to delete old live events humhub\modules\live\driver\Poll
$maxPollInterval Defines the maximum polling interval in seconds if the default polling client is active. humhub\modules\live\driver\Poll
$minPollInterval Defines the minimum polling interval in seconds if the default polling client is active. humhub\modules\live\driver\Poll

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getJsConfig() Returns the JavaScript Configuration for this driver humhub\modules\live\driver\Poll
onContentContainerLegitimationChanged() This callback will be executed whenever the access rules for a contentcontainer is changed. e.g. user joined a new space as member. humhub\modules\live\driver\BaseDriver
send() Sends a live event humhub\modules\live\driver\Poll

Property Details

$idleFactor public property
public $idleFactor 0.1
$idleInterval public property
public $idleInterval 20
$maxLiveEventAge public property

Seconds to delete old live events

$maxPollInterval public property
public $maxPollInterval 45
$minPollInterval public property
public $minPollInterval 15

Method Details

getJsConfig() public method

Returns the JavaScript Configuration for this driver

public array getJsConfig ( )
return array

The JS Configuratoin

send() public method

Sends a live event

public boolean send ( humhub\modules\live\components\LiveEvent $liveEvent )
$liveEvent humhub\modules\live\components\LiveEvent

The live event to send

return boolean

Indicates the sent was successful