public function Api::getMeetingInfo in BigBlueButton 8

Get Meeting Info (getMeetingInfo).

This call will return all of a meeting's information, including the list of attendees as well as start and end times.

Parameters

\BigBlueButton\Parameters\GetMeetingInfoParameters $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 (REQUIRED) The moderator password for this meeting. You can not get the meeting information using the attendee password.

Return value

\BigBlueButton\Core\Meeting|false Meeting instance.

File

src/Service/Api.php, line 213

Class

Api

Class Api.

Namespace

Drupal\bbb\Service

Code

public function getMeetingInfo(GetMeetingInfoParameters $params) {
  $response = $this->bbb
    ->getMeetingInfo($params);
  if ($response
    ->getReturnCode() === self::SUCCESS) {
    return $response
      ->getMeeting();
  }
  else {
    return FALSE;
  }
}