mod_bigbluebuttonbn\broker Class Reference

The broker routines. More...

Public Member Functions
	validate_parameters (array $params)
	Validate the supplied list of parameters, providing feedback about any missing or incorrect values.

Static Public Member Functions
static	process_meeting_events (instance $instance)
	Process meeting events for instance with provided HTTP headers.
static	process_recording_ready (instance $instance, array $params)
	Helper for responding when recording ready is performed.

Static Protected Member Functions
static	validate_parameters_message (array $params, array $requiredparams)
	Check whether the specified parameter is valid.

Protected Attributes
array	$requiredparams
	List of required params.

Detailed Description

The broker routines.

Copyright

2010 onwards, Blindside Networks Inc

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Author

Jesus Federico (jesus [at] blindsidenetworks [dt] com)

Member Function Documentation

process_meeting_events()

static mod_bigbluebuttonbn\broker::process_meeting_events ( instance $instance )

static

Process meeting events for instance with provided HTTP headers.

Parameters

instance

$instance

Return values

void

process_recording_ready()

static mod_bigbluebuttonbn\broker::process_recording_ready ( instance $instance, array $params )

static

Helper for responding when recording ready is performed.

Parameters

instance	$instance
array	$params

validate_parameters()

mod_bigbluebuttonbn\broker::validate_parameters

(

array

$params

)

Validate the supplied list of parameters, providing feedback about any missing or incorrect values.

Parameters

array

$params

Return values

null|string

validate_parameters_message()

static mod_bigbluebuttonbn\broker::validate_parameters_message ( array $params, array $requiredparams )

staticprotected

Check whether the specified parameter is valid.

Parameters

array	$params
array	$requiredparams

Return values

null|string

Member Data Documentation

$requiredparams

array mod_bigbluebuttonbn\broker::$requiredparams

protected

Initial value:

= [
        'recording_ready' => [
            'bigbluebuttonbn' => 'The BigBlueButtonBN instance ID must be specified.',
            'signed_parameters' => 'A JWT encoded string must be included as [signed_parameters].'
        ],
        'meeting_events' => [
            'bigbluebuttonbn' => 'The BigBlueButtonBN instance ID must be specified.'
        ],
    ]

List of required params.

---

The documentation for this class was generated from the following file:

• mod/bigbluebuttonbn/classes/broker.php