bigbluebutton 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/LICENSE +18 -1
- data/Rakefile +2 -2
- data/doc/classes/BigBlueButton.html +112 -0
- data/doc/classes/BigBlueButton/BigBlueButtonApi.html +431 -0
- data/doc/classes/BigBlueButton/BigBlueButtonApi.src/M000001.html +21 -0
- data/doc/classes/BigBlueButton/BigBlueButtonApi.src/M000002.html +18 -0
- data/doc/classes/BigBlueButton/BigBlueButtonApi.src/M000003.html +18 -0
- data/doc/classes/BigBlueButton/BigBlueButtonApi.src/M000004.html +23 -0
- data/doc/classes/BigBlueButton/BigBlueButtonApi.src/M000005.html +18 -0
- data/doc/classes/BigBlueButton/BigBlueButtonApi.src/M000006.html +20 -0
- data/doc/classes/BigBlueButton/BigBlueButtonApi.src/M000007.html +20 -0
- data/doc/classes/BigBlueButton/BigBlueButtonApi.src/M000008.html +18 -0
- data/doc/classes/BigBlueButton/BigBlueButtonApi.src/M000009.html +24 -0
- data/doc/classes/BigBlueButton/BigBlueButtonApi.src/M000010.html +28 -0
- data/doc/classes/BigBlueButton/BigBlueButtonsException.html +111 -0
- data/doc/created.rid +1 -0
- data/doc/files/lib/bigbluebutton_rb.html +111 -0
- data/doc/files/test/test_rb.html +147 -0
- data/doc/fr_class_index.html +29 -0
- data/doc/fr_file_index.html +27 -0
- data/doc/fr_method_index.html +36 -0
- data/doc/index.html +24 -0
- data/doc/rdoc-style.css +208 -0
- data/test/test.rb +40 -0
- metadata +24 -2
data/LICENSE
CHANGED
@@ -1,3 +1,20 @@
|
|
1
1
|
== bigbluebutton
|
2
2
|
|
3
|
-
|
3
|
+
Copyright (c) 2010 Joe Kinsella
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
6
|
+
this software and associated documentation files (the "Software"), to deal in
|
7
|
+
the Software without restriction, including without limitation the rights to
|
8
|
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
9
|
+
the Software, and to permit persons to whom the Software is furnished to do so,
|
10
|
+
subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
17
|
+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
18
|
+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
19
|
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
20
|
+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/Rakefile
CHANGED
@@ -12,7 +12,7 @@ require 'rake/testtask'
|
|
12
12
|
|
13
13
|
spec = Gem::Specification.new do |s|
|
14
14
|
s.name = 'bigbluebutton'
|
15
|
-
s.version = '0.0.
|
15
|
+
s.version = '0.0.2'
|
16
16
|
s.has_rdoc = true
|
17
17
|
s.extra_rdoc_files = ['README', 'LICENSE']
|
18
18
|
s.summary = 'Provides an interface to the BigBlueButton web meeting API (http://code.google.com/p/bigbluebutton/)'
|
@@ -21,7 +21,7 @@ spec = Gem::Specification.new do |s|
|
|
21
21
|
s.email = 'joe.kinsella@gmail.com'
|
22
22
|
s.homepage = "http://www.brownbaglunch.com/bigbluebutton"
|
23
23
|
# s.executables = ['your_executable_here']
|
24
|
-
s.files = %w(LICENSE README Rakefile) + Dir.glob("{bin,lib,spec}/**/*")
|
24
|
+
s.files = %w(LICENSE README Rakefile) + Dir.glob("{bin,lib,doc,test,spec}/**/*")
|
25
25
|
s.require_path = "lib"
|
26
26
|
s.bindir = "bin"
|
27
27
|
end
|
@@ -0,0 +1,112 @@
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
2
|
+
<!DOCTYPE html
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
5
|
+
|
6
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
7
|
+
<head>
|
8
|
+
<title>Module: BigBlueButton</title>
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
10
|
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
11
|
+
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
|
12
|
+
<script type="text/javascript">
|
13
|
+
// <![CDATA[
|
14
|
+
|
15
|
+
function popupCode( url ) {
|
16
|
+
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
17
|
+
}
|
18
|
+
|
19
|
+
function toggleCode( id ) {
|
20
|
+
if ( document.getElementById )
|
21
|
+
elem = document.getElementById( id );
|
22
|
+
else if ( document.all )
|
23
|
+
elem = eval( "document.all." + id );
|
24
|
+
else
|
25
|
+
return false;
|
26
|
+
|
27
|
+
elemStyle = elem.style;
|
28
|
+
|
29
|
+
if ( elemStyle.display != "block" ) {
|
30
|
+
elemStyle.display = "block"
|
31
|
+
} else {
|
32
|
+
elemStyle.display = "none"
|
33
|
+
}
|
34
|
+
|
35
|
+
return true;
|
36
|
+
}
|
37
|
+
|
38
|
+
// Make codeblocks hidden by default
|
39
|
+
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
|
40
|
+
|
41
|
+
// ]]>
|
42
|
+
</script>
|
43
|
+
|
44
|
+
</head>
|
45
|
+
<body>
|
46
|
+
|
47
|
+
|
48
|
+
|
49
|
+
<div id="classHeader">
|
50
|
+
<table class="header-table">
|
51
|
+
<tr class="top-aligned-row">
|
52
|
+
<td><strong>Module</strong></td>
|
53
|
+
<td class="class-name-in-header">BigBlueButton</td>
|
54
|
+
</tr>
|
55
|
+
<tr class="top-aligned-row">
|
56
|
+
<td><strong>In:</strong></td>
|
57
|
+
<td>
|
58
|
+
<a href="../files/lib/bigbluebutton_rb.html">
|
59
|
+
lib/bigbluebutton.rb
|
60
|
+
</a>
|
61
|
+
<br />
|
62
|
+
</td>
|
63
|
+
</tr>
|
64
|
+
|
65
|
+
</table>
|
66
|
+
</div>
|
67
|
+
<!-- banner header -->
|
68
|
+
|
69
|
+
<div id="bodyContent">
|
70
|
+
|
71
|
+
|
72
|
+
|
73
|
+
<div id="contextContent">
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
</div>
|
78
|
+
|
79
|
+
|
80
|
+
</div>
|
81
|
+
|
82
|
+
|
83
|
+
<!-- if includes -->
|
84
|
+
|
85
|
+
<div id="section">
|
86
|
+
|
87
|
+
<div id="class-list">
|
88
|
+
<h3 class="section-bar">Classes and Modules</h3>
|
89
|
+
|
90
|
+
Class <a href="BigBlueButton/BigBlueButtonApi.html" class="link">BigBlueButton::BigBlueButtonApi</a><br />
|
91
|
+
Class <a href="BigBlueButton/BigBlueButtonsException.html" class="link">BigBlueButton::BigBlueButtonsException</a><br />
|
92
|
+
|
93
|
+
</div>
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
|
99
|
+
|
100
|
+
|
101
|
+
<!-- if method_list -->
|
102
|
+
|
103
|
+
|
104
|
+
</div>
|
105
|
+
|
106
|
+
|
107
|
+
<div id="validator-badges">
|
108
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
109
|
+
</div>
|
110
|
+
|
111
|
+
</body>
|
112
|
+
</html>
|
@@ -0,0 +1,431 @@
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
2
|
+
<!DOCTYPE html
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
5
|
+
|
6
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
7
|
+
<head>
|
8
|
+
<title>Class: BigBlueButton::BigBlueButtonApi</title>
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
10
|
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
11
|
+
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
|
12
|
+
<script type="text/javascript">
|
13
|
+
// <![CDATA[
|
14
|
+
|
15
|
+
function popupCode( url ) {
|
16
|
+
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
17
|
+
}
|
18
|
+
|
19
|
+
function toggleCode( id ) {
|
20
|
+
if ( document.getElementById )
|
21
|
+
elem = document.getElementById( id );
|
22
|
+
else if ( document.all )
|
23
|
+
elem = eval( "document.all." + id );
|
24
|
+
else
|
25
|
+
return false;
|
26
|
+
|
27
|
+
elemStyle = elem.style;
|
28
|
+
|
29
|
+
if ( elemStyle.display != "block" ) {
|
30
|
+
elemStyle.display = "block"
|
31
|
+
} else {
|
32
|
+
elemStyle.display = "none"
|
33
|
+
}
|
34
|
+
|
35
|
+
return true;
|
36
|
+
}
|
37
|
+
|
38
|
+
// Make codeblocks hidden by default
|
39
|
+
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
|
40
|
+
|
41
|
+
// ]]>
|
42
|
+
</script>
|
43
|
+
|
44
|
+
</head>
|
45
|
+
<body>
|
46
|
+
|
47
|
+
|
48
|
+
|
49
|
+
<div id="classHeader">
|
50
|
+
<table class="header-table">
|
51
|
+
<tr class="top-aligned-row">
|
52
|
+
<td><strong>Class</strong></td>
|
53
|
+
<td class="class-name-in-header">BigBlueButton::BigBlueButtonApi</td>
|
54
|
+
</tr>
|
55
|
+
<tr class="top-aligned-row">
|
56
|
+
<td><strong>In:</strong></td>
|
57
|
+
<td>
|
58
|
+
<a href="../../files/lib/bigbluebutton_rb.html">
|
59
|
+
lib/bigbluebutton.rb
|
60
|
+
</a>
|
61
|
+
<br />
|
62
|
+
</td>
|
63
|
+
</tr>
|
64
|
+
|
65
|
+
<tr class="top-aligned-row">
|
66
|
+
<td><strong>Parent:</strong></td>
|
67
|
+
<td>
|
68
|
+
Object
|
69
|
+
</td>
|
70
|
+
</tr>
|
71
|
+
</table>
|
72
|
+
</div>
|
73
|
+
<!-- banner header -->
|
74
|
+
|
75
|
+
<div id="bodyContent">
|
76
|
+
|
77
|
+
|
78
|
+
|
79
|
+
<div id="contextContent">
|
80
|
+
|
81
|
+
<div id="description">
|
82
|
+
<p>
|
83
|
+
This class provides access to the <a
|
84
|
+
href="../BigBlueButton.html">BigBlueButton</a> API. <a
|
85
|
+
href="../BigBlueButton.html">BigBlueButton</a> is an open source project
|
86
|
+
that provides web conferencing for distance education (<a
|
87
|
+
href="http://code.google.com/p/bigbluebutton/wiki/API">code.google.com/p/bigbluebutton/wiki/API</a>).
|
88
|
+
This API was developed to the 0.64 version of bbb.
|
89
|
+
</p>
|
90
|
+
<p>
|
91
|
+
Sample usage of the API is as follows: 1) Create a meeting with the <a
|
92
|
+
href="BigBlueButtonApi.html#M000004">create_meeting</a> call 2) Direct a
|
93
|
+
user to either <a href="BigBlueButtonApi.html#M000002">moderator_url</a> or
|
94
|
+
<a href="BigBlueButtonApi.html#M000003">attendee_url</a> 3) To force
|
95
|
+
meeting to end, call <a
|
96
|
+
href="BigBlueButtonApi.html#M000005">end_meeting</a>
|
97
|
+
</p>
|
98
|
+
<table>
|
99
|
+
<tr><td valign="top">Author:</td><td>Joe Kinsella (<a
|
100
|
+
href="mailto:joe.kinsella@gmail.com">joe.kinsella@gmail.com</a>)
|
101
|
+
|
102
|
+
</td></tr>
|
103
|
+
<tr><td valign="top">Copyright:</td><td>Copyright (c) 2010 Joe Kinsella
|
104
|
+
|
105
|
+
</td></tr>
|
106
|
+
<tr><td valign="top">License:</td><td>Distributes under same terms as Ruby
|
107
|
+
|
108
|
+
</td></tr>
|
109
|
+
</table>
|
110
|
+
|
111
|
+
</div>
|
112
|
+
|
113
|
+
|
114
|
+
</div>
|
115
|
+
|
116
|
+
<div id="method-list">
|
117
|
+
<h3 class="section-bar">Methods</h3>
|
118
|
+
|
119
|
+
<div class="name-list">
|
120
|
+
<a href="#M000003">attendee_url</a>
|
121
|
+
<a href="#M000004">create_meeting</a>
|
122
|
+
<a href="#M000005">end_meeting</a>
|
123
|
+
<a href="#M000008">get_meeting_info</a>
|
124
|
+
<a href="#M000009">get_url</a>
|
125
|
+
<a href="#M000006">is_meeting_running</a>
|
126
|
+
<a href="#M000007">join_meeting</a>
|
127
|
+
<a href="#M000002">moderator_url</a>
|
128
|
+
<a href="#M000001">new</a>
|
129
|
+
<a href="#M000010">send_api_request</a>
|
130
|
+
</div>
|
131
|
+
</div>
|
132
|
+
|
133
|
+
</div>
|
134
|
+
|
135
|
+
|
136
|
+
<!-- if includes -->
|
137
|
+
|
138
|
+
<div id="section">
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
<!-- if method_list -->
|
148
|
+
<div id="methods">
|
149
|
+
<h3 class="section-bar">Public Class methods</h3>
|
150
|
+
|
151
|
+
<div id="method-M000001" class="method-detail">
|
152
|
+
<a name="M000001"></a>
|
153
|
+
|
154
|
+
<div class="method-heading">
|
155
|
+
<a href="BigBlueButtonApi.src/M000001.html" target="Code" class="method-signature"
|
156
|
+
onclick="popupCode('BigBlueButtonApi.src/M000001.html');return false;">
|
157
|
+
<span class="method-name">new</span><span class="method-args">(base_url = 'http://devbuild.bigbluebutton.org/bigbluebutton/api', salt = '639259d4-9dd8-4b25-bf01-95f9567eaf4b', debug=false)</span>
|
158
|
+
</a>
|
159
|
+
</div>
|
160
|
+
|
161
|
+
<div class="method-description">
|
162
|
+
<p>
|
163
|
+
Initializes an instance
|
164
|
+
</p>
|
165
|
+
<table>
|
166
|
+
<tr><td valign="top">base_url:</td><td>URL to a <a href="../BigBlueButton.html">BigBlueButton</a> server (defaults
|
167
|
+
to bbb development server)
|
168
|
+
|
169
|
+
</td></tr>
|
170
|
+
<tr><td valign="top">salt:</td><td>Secret salt for this server (defaults to bbb development server)"<a
|
171
|
+
href="http://devbuild.bigbluebu">devbuild.bigbluebu</a>
|
172
|
+
|
173
|
+
</td></tr>
|
174
|
+
</table>
|
175
|
+
</div>
|
176
|
+
</div>
|
177
|
+
|
178
|
+
<h3 class="section-bar">Public Instance methods</h3>
|
179
|
+
|
180
|
+
<div id="method-M000003" class="method-detail">
|
181
|
+
<a name="M000003"></a>
|
182
|
+
|
183
|
+
<div class="method-heading">
|
184
|
+
<a href="BigBlueButtonApi.src/M000003.html" target="Code" class="method-signature"
|
185
|
+
onclick="popupCode('BigBlueButtonApi.src/M000003.html');return false;">
|
186
|
+
<span class="method-name">attendee_url</span><span class="method-args">(meeting_id, user_name, attendee_password)</span>
|
187
|
+
</a>
|
188
|
+
</div>
|
189
|
+
|
190
|
+
<div class="method-description">
|
191
|
+
<p>
|
192
|
+
Returns url to login as attendee
|
193
|
+
</p>
|
194
|
+
<table>
|
195
|
+
<tr><td valign="top">meeting_id:</td><td>Unique identifier for the meeting
|
196
|
+
|
197
|
+
</td></tr>
|
198
|
+
<tr><td valign="top">user_name:</td><td>Name of the user
|
199
|
+
|
200
|
+
</td></tr>
|
201
|
+
<tr><td valign="top">password:</td><td>Attendee password for this meeting
|
202
|
+
|
203
|
+
</td></tr>
|
204
|
+
</table>
|
205
|
+
</div>
|
206
|
+
</div>
|
207
|
+
|
208
|
+
<div id="method-M000004" class="method-detail">
|
209
|
+
<a name="M000004"></a>
|
210
|
+
|
211
|
+
<div class="method-heading">
|
212
|
+
<a href="BigBlueButtonApi.src/M000004.html" target="Code" class="method-signature"
|
213
|
+
onclick="popupCode('BigBlueButtonApi.src/M000004.html');return false;">
|
214
|
+
<span class="method-name">create_meeting</span><span class="method-args">(meeting_id, meeting_name, moderator_password, attendee_password, welcome_message = nil, dialin_number = nil, logout_url = nil, max_participants = nil)</span>
|
215
|
+
</a>
|
216
|
+
</div>
|
217
|
+
|
218
|
+
<div class="method-description">
|
219
|
+
<p>
|
220
|
+
Creates a <a href="BigBlueButtonApi.html#M000001">new</a> meeting. Throws
|
221
|
+
BigBlueButtonException on failure.
|
222
|
+
</p>
|
223
|
+
<table>
|
224
|
+
<tr><td valign="top">meeting_id:</td><td>Unique identifier for the meeting
|
225
|
+
|
226
|
+
</td></tr>
|
227
|
+
<tr><td valign="top">meeting_name:</td><td>Name for the meeting
|
228
|
+
|
229
|
+
</td></tr>
|
230
|
+
<tr><td valign="top">moderator_password:</td><td>Moderator password
|
231
|
+
|
232
|
+
</td></tr>
|
233
|
+
<tr><td valign="top">attendee_password:</td><td>Attendee password
|
234
|
+
|
235
|
+
</td></tr>
|
236
|
+
<tr><td valign="top">welcome_message:</td><td>Welcome message to display in chat window
|
237
|
+
|
238
|
+
</td></tr>
|
239
|
+
<tr><td valign="top">dialin_number:</td><td>Dial in number for conference
|
240
|
+
|
241
|
+
</td></tr>
|
242
|
+
<tr><td valign="top">logout_url:</td><td>URL to return user to after exiting meeting
|
243
|
+
|
244
|
+
</td></tr>
|
245
|
+
</table>
|
246
|
+
</div>
|
247
|
+
</div>
|
248
|
+
|
249
|
+
<div id="method-M000005" class="method-detail">
|
250
|
+
<a name="M000005"></a>
|
251
|
+
|
252
|
+
<div class="method-heading">
|
253
|
+
<a href="BigBlueButtonApi.src/M000005.html" target="Code" class="method-signature"
|
254
|
+
onclick="popupCode('BigBlueButtonApi.src/M000005.html');return false;">
|
255
|
+
<span class="method-name">end_meeting</span><span class="method-args">(meeting_id, moderator_password)</span>
|
256
|
+
</a>
|
257
|
+
</div>
|
258
|
+
|
259
|
+
<div class="method-description">
|
260
|
+
<p>
|
261
|
+
Ends an existing meeting. Throws BigBlueButtonException on failure.
|
262
|
+
</p>
|
263
|
+
<table>
|
264
|
+
<tr><td valign="top">meeting_id:</td><td>Unique identifier for the meeting
|
265
|
+
|
266
|
+
</td></tr>
|
267
|
+
<tr><td valign="top">moderator_password:</td><td>Moderator password
|
268
|
+
|
269
|
+
</td></tr>
|
270
|
+
</table>
|
271
|
+
</div>
|
272
|
+
</div>
|
273
|
+
|
274
|
+
<div id="method-M000008" class="method-detail">
|
275
|
+
<a name="M000008"></a>
|
276
|
+
|
277
|
+
<div class="method-heading">
|
278
|
+
<a href="BigBlueButtonApi.src/M000008.html" target="Code" class="method-signature"
|
279
|
+
onclick="popupCode('BigBlueButtonApi.src/M000008.html');return false;">
|
280
|
+
<span class="method-name">get_meeting_info</span><span class="method-args">(meeting_id, password)</span>
|
281
|
+
</a>
|
282
|
+
</div>
|
283
|
+
|
284
|
+
<div class="method-description">
|
285
|
+
<p>
|
286
|
+
Returns a REXML::Document object containing the meeting information. See
|
287
|
+
the API documentation for details on the return XML (<a
|
288
|
+
href="http://code.google.com/p/bigbluebutton/wiki/API">code.google.com/p/bigbluebutton/wiki/API</a>).
|
289
|
+
</p>
|
290
|
+
<table>
|
291
|
+
<tr><td valign="top">meeting_id:</td><td>Unique identifier for the meeting
|
292
|
+
|
293
|
+
</td></tr>
|
294
|
+
<tr><td valign="top">password:</td><td>Moderator password for this meeting
|
295
|
+
|
296
|
+
</td></tr>
|
297
|
+
</table>
|
298
|
+
</div>
|
299
|
+
</div>
|
300
|
+
|
301
|
+
<div id="method-M000006" class="method-detail">
|
302
|
+
<a name="M000006"></a>
|
303
|
+
|
304
|
+
<div class="method-heading">
|
305
|
+
<a href="BigBlueButtonApi.src/M000006.html" target="Code" class="method-signature"
|
306
|
+
onclick="popupCode('BigBlueButtonApi.src/M000006.html');return false;">
|
307
|
+
<span class="method-name">is_meeting_running</span><span class="method-args">(meeting_id)</span>
|
308
|
+
</a>
|
309
|
+
</div>
|
310
|
+
|
311
|
+
<div class="method-description">
|
312
|
+
<p>
|
313
|
+
Returns true or false as to whether meeting is open. A meeting is only open
|
314
|
+
after at least one participant has joined.
|
315
|
+
</p>
|
316
|
+
<table>
|
317
|
+
<tr><td valign="top">meeting_id:</td><td>Unique identifier for the meeting
|
318
|
+
|
319
|
+
</td></tr>
|
320
|
+
</table>
|
321
|
+
</div>
|
322
|
+
</div>
|
323
|
+
|
324
|
+
<div id="method-M000007" class="method-detail">
|
325
|
+
<a name="M000007"></a>
|
326
|
+
|
327
|
+
<div class="method-heading">
|
328
|
+
<a href="BigBlueButtonApi.src/M000007.html" target="Code" class="method-signature"
|
329
|
+
onclick="popupCode('BigBlueButtonApi.src/M000007.html');return false;">
|
330
|
+
<span class="method-name">join_meeting</span><span class="method-args">(meeting_id, user_name, password)</span>
|
331
|
+
</a>
|
332
|
+
</div>
|
333
|
+
|
334
|
+
<div class="method-description">
|
335
|
+
<p>
|
336
|
+
Warning: As of this version of the gem, this bbb call does not work
|
337
|
+
(instead of returning XML response, joins meeting).
|
338
|
+
</p>
|
339
|
+
<p>
|
340
|
+
Joins a user into the meeting using an API call, instead of directing the
|
341
|
+
user‘s browser to <a
|
342
|
+
href="BigBlueButtonApi.html#M000002">moderator_url</a> or <a
|
343
|
+
href="BigBlueButtonApi.html#M000003">attendee_url</a> (note: this will
|
344
|
+
still be required however to actually use bbb). Returns the URL a user can
|
345
|
+
use to enter this meeting.
|
346
|
+
</p>
|
347
|
+
<table>
|
348
|
+
<tr><td valign="top">meeting_id:</td><td>Unique identifier for the meeting
|
349
|
+
|
350
|
+
</td></tr>
|
351
|
+
<tr><td valign="top">user_name:</td><td>Name of the user
|
352
|
+
|
353
|
+
</td></tr>
|
354
|
+
<tr><td valign="top">password:</td><td>Moderator or attendee password for this meeting
|
355
|
+
|
356
|
+
</td></tr>
|
357
|
+
</table>
|
358
|
+
</div>
|
359
|
+
</div>
|
360
|
+
|
361
|
+
<div id="method-M000002" class="method-detail">
|
362
|
+
<a name="M000002"></a>
|
363
|
+
|
364
|
+
<div class="method-heading">
|
365
|
+
<a href="BigBlueButtonApi.src/M000002.html" target="Code" class="method-signature"
|
366
|
+
onclick="popupCode('BigBlueButtonApi.src/M000002.html');return false;">
|
367
|
+
<span class="method-name">moderator_url</span><span class="method-args">(meeting_id, user_name, password)</span>
|
368
|
+
</a>
|
369
|
+
</div>
|
370
|
+
|
371
|
+
<div class="method-description">
|
372
|
+
<p>
|
373
|
+
Returns url to login as moderator
|
374
|
+
</p>
|
375
|
+
<table>
|
376
|
+
<tr><td valign="top">meeting_id:</td><td>Unique identifier for the meeting
|
377
|
+
|
378
|
+
</td></tr>
|
379
|
+
<tr><td valign="top">user_name:</td><td>Name of the user
|
380
|
+
|
381
|
+
</td></tr>
|
382
|
+
<tr><td valign="top">password:</td><td>Moderator password for this meeting
|
383
|
+
|
384
|
+
</td></tr>
|
385
|
+
</table>
|
386
|
+
</div>
|
387
|
+
</div>
|
388
|
+
|
389
|
+
<h3 class="section-bar">Protected Instance methods</h3>
|
390
|
+
|
391
|
+
<div id="method-M000009" class="method-detail">
|
392
|
+
<a name="M000009"></a>
|
393
|
+
|
394
|
+
<div class="method-heading">
|
395
|
+
<a href="BigBlueButtonApi.src/M000009.html" target="Code" class="method-signature"
|
396
|
+
onclick="popupCode('BigBlueButtonApi.src/M000009.html');return false;">
|
397
|
+
<span class="method-name">get_url</span><span class="method-args">(method, data)</span>
|
398
|
+
</a>
|
399
|
+
</div>
|
400
|
+
|
401
|
+
<div class="method-description">
|
402
|
+
</div>
|
403
|
+
</div>
|
404
|
+
|
405
|
+
<div id="method-M000010" class="method-detail">
|
406
|
+
<a name="M000010"></a>
|
407
|
+
|
408
|
+
<div class="method-heading">
|
409
|
+
<a href="BigBlueButtonApi.src/M000010.html" target="Code" class="method-signature"
|
410
|
+
onclick="popupCode('BigBlueButtonApi.src/M000010.html');return false;">
|
411
|
+
<span class="method-name">send_api_request</span><span class="method-args">(method, data = {})</span>
|
412
|
+
</a>
|
413
|
+
</div>
|
414
|
+
|
415
|
+
<div class="method-description">
|
416
|
+
</div>
|
417
|
+
</div>
|
418
|
+
|
419
|
+
|
420
|
+
</div>
|
421
|
+
|
422
|
+
|
423
|
+
</div>
|
424
|
+
|
425
|
+
|
426
|
+
<div id="validator-badges">
|
427
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
428
|
+
</div>
|
429
|
+
|
430
|
+
</body>
|
431
|
+
</html>
|