Socialid.wifi.API
From Social ID Developers
(Difference between revisions)
(→Usage) |
|||
| (2 intermediate revisions by one user not shown) | |||
| Line 5: | Line 5: | ||
== Usage == | == Usage == | ||
| − | + | socialid.wifi.API(portalPathName) | |
== Parameters == | == Parameters == | ||
| Line 12: | Line 12: | ||
! align="left" width="200px" | portalPathName | ! align="left" width="200px" | portalPathName | ||
| width="200px" | required | | width="200px" | 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 | + | | 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 retrieved from the "path_name" property of the shared "appConfig" object. |
|} | |} | ||
| Line 25: | Line 25: | ||
== Example == | == Example == | ||
| − | var api = socialid.wifi.API(appConfig.path_name); | + | var api = new socialid.wifi.API(appConfig.path_name); |
Latest revision as of 14:18, 19 October 2021
Contents |
Description
Initializes the API to be used in a captive portal context.
Usage
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 retrieved 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 = new socialid.wifi.API(appConfig.path_name);
