function bbb_api_end in BigBlueButton 6

Same name in this branch

1. 6 includes/api-0.64.bbb.inc \bbb_api_end()
2. 6 includes/api-0.7.bbb.inc \bbb_api_end()

End Meeting (end)

Use this to forcibly end a meeting and kick all participants out of the meeting.

Parameters

ARRAY $params: Associative array of additional url parameters. Components:

• meetingID: STRING The meeting ID that identifies the meeting you are attempting to end.
• password: STRING The moderator password for this meeting. You can not end a meeting using the attendee password.

@return OBJECT or FALSE This call returns no additional information other than the standard returncode parameter of "SUCCESS" or "FAILED". It will return a messageKey and message for additional information.

See also

http://code.google.com/p/bigbluebutton/wiki/API#End_Meeting_(end)

2 calls to bbb_api_end()

bbb_get_meeting in ./bbb.module

Return a meeting object

bbb_meeting_end in ./bbb.module

Redirect to big blue button instance; Menu callback

File

includes/api-0.64.bbb.inc, line 155

Big Blue Button - Enables universities and colleges to deliver a high-quality learning experience.

Code

function bbb_api_end($params) {
  $query_string = bbb_api_generate_querystring(BBB_API_END_MEETING, $params);
  $request = BBB_API_BASE_URL . BBB_API_END_MEETING . '?' . $query_string;
  return bbb_api_execute_query($request);
}