public function Api::end in BigBlueButton 8

End Meeting (endMeeting)

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

Parameters

\BigBlueButton\Parameters\EndMeetingParameters $params: Associative array of additional url parameters. Components:

• meetingToken: STRING The internal meeting token assigned by the API for this meeting when it was created. Note that either the meetingToken or the meetingID along with one of the passwords must be passed into this call in order to determine which meeting to find.
• meetingID: STRING If you specified a meeting ID when calling create, then you can use either the generated meeting token or your specified meeting ID to find meetings. This parameter takes your meeting ID.
• password: STRING The moderator password for this meeting. You can not end a meeting using the attendee password.

Return value

\BigBlueButton\Responses\EndMeetingResponse|BOOLEAN A string of either “true” or “false” that signals whether the meeting was successfully ended.

File

src/Service/Api.php, line 245

Class

Api

Class Api.

Namespace

Drupal\bbb\Service

Code

public function end($key) {
}