Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
- Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
- PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
Differences Between: [Versions 400 and 401] [Versions 400 and 402] [Versions 400 and 403]
(no description)
| File Size: | 492 lines (17 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
bigbluebutton_proxy:: (19 methods):
get_join_url()
get_server_version()
get_instance_ownerid()
is_voicebridge_number_unique()
is_remote_resource_valid()
enqueue_completion_event()
update_completion_state()
get_instance_type_profiles()
get_instance_type_profiles_create_allowed()
get_instance_profiles_array()
view_get_activity_status()
require_working_server()
handle_server_not_available()
get_server_not_available_message()
get_server_not_available_url()
create_meeting()
get_meeting_info()
end_meeting()
is_bn_server()
Class: bigbluebutton_proxy - X-Ref
The bigbluebutton proxy class.This class acts as a proxy between Moodle and the BigBlueButton API server,
and handles all requests relating to the server and meetings.
| get_join_url(string $meetingid,string $username,string $pw,string $logouturl,string $role,string $configtoken = null,string $userid = null,string $createtime = null) X-Ref |
| Builds and returns a url for joining a bigbluebutton meeting. return: string param: string $meetingid param: string $username param: string $pw param: string $logouturl param: string $role param: string|null $configtoken param: string|null $userid param: string|null $createtime |
| get_server_version() X-Ref |
| Perform api request on BBB. return: null|string |
| get_instance_ownerid(stdClass $bigbluebuttonbn) X-Ref |
| Helper for getting the owner userid of a bigbluebuttonbn instance. return: int ownerid (a valid user id or null if not registered/found) param: stdClass $bigbluebuttonbn BigBlueButtonBN instance |
| is_voicebridge_number_unique(int $instance, int $voicebridge) X-Ref |
| Helper evaluates if a voicebridge number is unique. return: bool param: int $instance param: int $voicebridge |
| is_remote_resource_valid(string $url) X-Ref |
| Helper function validates a remote resource. return: bool param: string $url |
| enqueue_completion_event(stdClass $bigbluebuttonbn, int $userid) X-Ref |
| Helper function enqueues one user for being validated as for completion. return: void param: stdClass $bigbluebuttonbn param: int $userid |
| update_completion_state(stdClass $bigbluebuttonbn, int $userid) X-Ref |
| Helper function enqueues completion trigger. return: void param: stdClass $bigbluebuttonbn param: int $userid |
| get_instance_type_profiles() X-Ref |
| Helper function returns an array with the profiles (with features per profile) for the different types of bigbluebuttonbn instances. return: array |
| get_instance_type_profiles_create_allowed(bool $room, bool $recording) X-Ref |
| Helper function returns an array with the profiles (with features per profile) for the different types of bigbluebuttonbn instances that the user is allowed to create. return: array param: bool $room param: bool $recording |
| get_instance_profiles_array(array $profiles = []) X-Ref |
| Helper function returns an array with the profiles (with features per profile) for the different types of bigbluebuttonbn instances. return: array param: array $profiles |
| view_get_activity_status(instance $instance) X-Ref |
| Return the status of an activity [open|not_started|ended]. return: string param: instance $instance |
| require_working_server(instance $instance) X-Ref |
| Ensure that the remote server was contactable. param: instance $instance |
| handle_server_not_available(instance $instance) X-Ref |
| Handle the server not being available. param: instance $instance |
| get_server_not_available_message(instance $instance) X-Ref |
| Get message when server not available return: string param: instance $instance |
| get_server_not_available_url(instance $instance) X-Ref |
| Get URL to the page displaying that the server is not available return: string param: instance $instance |
| create_meeting(array $data,array $metadata,?string $presentationname = null,?string $presentationurl = null) X-Ref |
| Create a Meeting return: array param: array $data param: array $metadata param: string|null $presentationname param: string|null $presentationurl |
| get_meeting_info(string $meetingid) X-Ref |
| Get meeting info for a given meeting id return: array param: string $meetingid |
| end_meeting(string $meetingid, string $modpw) X-Ref |
| Perform end meeting on BBB. param: string $meetingid param: string $modpw |
| is_bn_server() X-Ref |
| Helper evaluates if the bigbluebutton server used belongs to blindsidenetworks domain. return: bool |
