You are here

public function Api::isMeetingRunning in BigBlueButton 8

Is meeting running (isMeetingRunning).

This call enables you to simply check on whether or not a meeting is running by looking it up with either the token or your ID.

Parameters

\BigBlueButton\Parameters\IsMeetingRunningParameters $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.
  • 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.

Return value

bool A string of either “true” or “false” that signals whether a meeting with this ID or token is currently running.

File

src/Service/Api.php, line 149

Class

Api
Class Api.

Namespace

Drupal\bbb\Service

Code

public function isMeetingRunning(IsMeetingRunningParameters $params) {
  $response = $this->bbb
    ->isMeetingRunning($params);
  if ($response
    ->getReturnCode() === self::SUCCESS) {
    return $response
      ->isRunning();
  }
  else {
    \Drupal::logger('bigbluebutton')
      ->error('%message', [
      '%message' => $response
        ->getMessage(),
    ]);
    return FALSE;
  }
}