Ver código fonte

doc(iframe_api): Fix the names of the properties in the options object.

j8
hristoterezov 8 anos atrás
pai
commit
4dcbe5c6a0
2 arquivos alterados com 17 adições e 16 exclusões
  1. 6
    6
      doc/api.md
  2. 11
    10
      doc/examples/api.html

+ 6
- 6
doc/api.md Ver arquivo

@@ -19,11 +19,11 @@ Its constructor gets a number of options:
19 19
 * **domain**: domain used to build the conference URL, "meet.jit.si" for
20 20
   example.
21 21
 * **options**: object with properties - the optional arguments:
22
-    * **room**: (optional) name of the room to join.
22
+    * **roomName**: (optional) name of the room to join.
23 23
     * **width**: (optional) width for the iframe which will be created. If a number is specified it's treated as pixel units. If a string is specified the format is number followed by 'px', 'em', 'pt' or '%'.
24 24
     * **height**: (optional) height for the iframe which will be created. If a number is specified it's treated as pixel units. If a string is specified the format is number followed by 'px', 'em', 'pt' or '%'.
25
-    * **htmlElement**: (optional) HTL DOM Element where the iframe will be added as a child.
26
-    * **configOverwite**: (optional) JS object with overrides for options defined in [config.js].
25
+    * **parentNode**: (optional) HTML DOM Element where the iframe will be added as a child.
26
+    * **configOverwrite**: (optional) JS object with overrides for options defined in [config.js].
27 27
     * **interfaceConfigOverwrite**: (optional) JS object with overrides for options defined in [interface_config.js].
28 28
     * **noSsl**: (optional, defaults to true) Boolean indicating if the server should be contacted using HTTP or HTTPS.
29 29
     * **jwt**: (optional) [JWT](https://jwt.io/) token.
@@ -31,12 +31,12 @@ Its constructor gets a number of options:
31 31
 Example:
32 32
 
33 33
 ```javascript
34
+var domain = "meet.jit.si";
34 35
 var options = {
35
-    domain: "meet.jit.si",
36
-    room: "JitsiMeetAPIExample",
36
+    roomName: "JitsiMeetAPIExample",
37 37
     width: 700,
38 38
     height: 700,
39
-    htmlElement: document.querySelector('#meet')
39
+    parentNode: document.querySelector('#meet')
40 40
 }
41 41
 var api = new JitsiMeetExternalAPI(domain, options);
42 42
 ```

+ 11
- 10
doc/examples/api.html Ver arquivo

@@ -7,16 +7,17 @@
7 7
         <script src="https://meet.jit.si/external_api.js"></script>
8 8
         <script>
9 9
             var domain = "meet.jit.si";
10
-            var room = "JitsiMeetAPIExample";
11
-            var width = 700;
12
-            var height = 180;
13
-            var htmlElement = undefined;
14
-            var configOverwrite = {};
15
-            var interfaceConfigOverwrite = {
16
-                filmStripOnly: true
17
-            };
18
-            var api = new JitsiMeetExternalAPI(domain, room, width, height,
19
-                htmlElement, configOverwrite, interfaceConfigOverwrite);
10
+            var options = {
11
+                roomName: "JitsiMeetAPIExample",
12
+                width: 700,
13
+                height: 180,
14
+                parent: undefined,
15
+                configOverwrite: {},
16
+                interfaceConfigOverwrite: {
17
+                    filmStripOnly: true
18
+                }
19
+            }
20
+            var api = new JitsiMeetExternalAPI(domain, options);
20 21
         </script>
21 22
     </body>
22 23
 </html>

Carregando…
Cancelar
Salvar