From 4dcbe5c6a0f31256db78e9209f820c4a50a800b1 Mon Sep 17 00:00:00 2001 From: hristoterezov Date: Tue, 1 Aug 2017 08:48:50 +0300 Subject: [PATCH] doc(iframe_api): Fix the names of the properties in the options object. --- doc/api.md | 12 ++++++------ doc/examples/api.html | 21 +++++++++++---------- 2 files changed, 17 insertions(+), 16 deletions(-) diff --git a/doc/api.md b/doc/api.md index d74d74bc3..d047d5c45 100644 --- a/doc/api.md +++ b/doc/api.md @@ -19,11 +19,11 @@ Its constructor gets a number of options: * **domain**: domain used to build the conference URL, "meet.jit.si" for example. * **options**: object with properties - the optional arguments: - * **room**: (optional) name of the room to join. + * **roomName**: (optional) name of the room to join. * **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 '%'. * **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 '%'. - * **htmlElement**: (optional) HTL DOM Element where the iframe will be added as a child. - * **configOverwite**: (optional) JS object with overrides for options defined in [config.js]. + * **parentNode**: (optional) HTML DOM Element where the iframe will be added as a child. + * **configOverwrite**: (optional) JS object with overrides for options defined in [config.js]. * **interfaceConfigOverwrite**: (optional) JS object with overrides for options defined in [interface_config.js]. * **noSsl**: (optional, defaults to true) Boolean indicating if the server should be contacted using HTTP or HTTPS. * **jwt**: (optional) [JWT](https://jwt.io/) token. @@ -31,12 +31,12 @@ Its constructor gets a number of options: Example: ```javascript +var domain = "meet.jit.si"; var options = { - domain: "meet.jit.si", - room: "JitsiMeetAPIExample", + roomName: "JitsiMeetAPIExample", width: 700, height: 700, - htmlElement: document.querySelector('#meet') + parentNode: document.querySelector('#meet') } var api = new JitsiMeetExternalAPI(domain, options); ``` diff --git a/doc/examples/api.html b/doc/examples/api.html index be5642495..4f7ff9bb7 100644 --- a/doc/examples/api.html +++ b/doc/examples/api.html @@ -7,16 +7,17 @@