Socialid.wifi.API
(Difference between revisions)
(Created page with "== Description == Initializes the API to be used in a captive portal context. == Usage == var api = new socialid.wifi.API(portalPathName) == Parameters == {| ! align="l...") |
|||
| Line 14: | Line 14: | ||
| The path identifier of the captive portal. i.e. the path name after the "/portals/" part in the captive portal's URL. It can be automatically retrived from the "path_name" property of the shared "appConfig" object. | | The path identifier of the captive portal. i.e. the path name after the "/portals/" part in the captive portal's URL. It can be automatically retrived from the "path_name" property of the shared "appConfig" object. | ||
|} | |} | ||
| + | |||
| + | == API Response == | ||
| + | |||
| + | {| | ||
| + | ! align="left" width="200px" | api | ||
| + | | Javascript Object that provides the Wi-Fi Javascript APIs. | ||
| + | |} | ||
| + | |||
== Example == | == Example == | ||
var api = socialid.wifi.API(appConfig.path_name); | var api = socialid.wifi.API(appConfig.path_name); | ||
Revision as of 22:39, 18 October 2021
Contents |
Description
Initializes the API to be used in a captive portal context.
Usage
var api = new socialid.wifi.API(portalPathName)
Parameters
| portalPathName | required | The path identifier of the captive portal. i.e. the path name after the "/portals/" part in the captive portal's URL. It can be automatically retrived from the "path_name" property of the shared "appConfig" object. |
|---|
API Response
| api | Javascript Object that provides the Wi-Fi Javascript APIs. |
|---|
Example
var api = socialid.wifi.API(appConfig.path_name);
