function bbb_api_join in BigBlueButton 7

Same name and namespace in other branches

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

Join Meeting (join)

Parameters

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

• fullName: STRING (REQUIRED) The full name that is to be used to identify this user to other conference attendees.
• meetingToken: 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 password that this attendee is using. If the moderator password is supplied, he will be given moderator status (and the same for attendee password, etc)
• redirectImmediately: BOOLEAN If this is passed as true, then BBB will not return a URL for you to redirect the user to, but will instead treat this as an entry URL and will immediately set up the client session and redirect the user into the conference. Values can be either a 1 (one) or a 0 (zero), indicating true or false respectively. Defaults to false.

@return STRING The URL that the user can be sent to in order to join the meeting. When they go to this URL, BBB will setup their client session and redirect them into the conference.

1 call to bbb_api_join()

bbb_get_meeting in ./bbb.module

Return a meeting object

File

includes/api.bbb.inc, line 95

BigBlueButton - Enables universities and colleges to deliver a high-quality learning experience.

Code

function bbb_api_join($params) {
  $query_string = bbb_api_generate_querystring($params, 'join');
  return BIGBLUEBUTTON_BASE_URL . BIGBLUEBUTTON_JOIN_URL . '?' . $query_string;
}