@capgo/capacitor-wifi 7.0.0
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.
- package/CapgoCapacitorWifi.podspec +17 -0
- package/LICENSE +21 -0
- package/Package.swift +30 -0
- package/README.md +450 -0
- package/android/build.gradle +59 -0
- package/android/src/main/AndroidManifest.xml +9 -0
- package/android/src/main/java/app/capgo/capacitorwifi/CapacitorWifiPlugin.java +439 -0
- package/android/src/main/java/ee/forgr/plugin/capacitor_wifi/CapacitorWifiPlugin.java +591 -0
- package/dist/docs.json +1031 -0
- package/dist/esm/definitions.d.ts +493 -0
- package/dist/esm/definitions.js +75 -0
- package/dist/esm/definitions.js.map +1 -0
- package/dist/esm/index.d.ts +4 -0
- package/dist/esm/index.js +7 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/web.d.ts +18 -0
- package/dist/esm/web.js +40 -0
- package/dist/esm/web.js.map +1 -0
- package/dist/plugin.cjs.js +129 -0
- package/dist/plugin.cjs.js.map +1 -0
- package/dist/plugin.js +132 -0
- package/dist/plugin.js.map +1 -0
- package/ios/Sources/CapacitorWifiPlugin/CapacitorWifiPlugin.swift +227 -0
- package/ios/Tests/CapacitorWifiPluginTests/CapacitorWifiPluginTests.swift +10 -0
- package/package.json +86 -0
package/dist/docs.json
ADDED
|
@@ -0,0 +1,1031 @@
|
|
|
1
|
+
{
|
|
2
|
+
"api": {
|
|
3
|
+
"name": "CapacitorWifiPlugin",
|
|
4
|
+
"slug": "capacitorwifiplugin",
|
|
5
|
+
"docs": "WiFi plugin for managing device WiFi connectivity",
|
|
6
|
+
"tags": [
|
|
7
|
+
{
|
|
8
|
+
"text": "7.0.0",
|
|
9
|
+
"name": "since"
|
|
10
|
+
}
|
|
11
|
+
],
|
|
12
|
+
"methods": [
|
|
13
|
+
{
|
|
14
|
+
"name": "addNetwork",
|
|
15
|
+
"signature": "(options: AddNetworkOptions) => Promise<void>",
|
|
16
|
+
"parameters": [
|
|
17
|
+
{
|
|
18
|
+
"name": "options",
|
|
19
|
+
"docs": "- Network configuration options",
|
|
20
|
+
"type": "AddNetworkOptions"
|
|
21
|
+
}
|
|
22
|
+
],
|
|
23
|
+
"returns": "Promise<void>",
|
|
24
|
+
"tags": [
|
|
25
|
+
{
|
|
26
|
+
"name": "param",
|
|
27
|
+
"text": "options - Network configuration options"
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"name": "returns",
|
|
31
|
+
"text": "Promise that resolves when the network is added"
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"name": "throws",
|
|
35
|
+
"text": "Error if adding the network fails"
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
"name": "since",
|
|
39
|
+
"text": "7.0.0"
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
"name": "example",
|
|
43
|
+
"text": "```typescript\nawait CapacitorWifi.addNetwork({\n ssid: 'MyNetwork',\n password: 'mypassword',\n isHiddenSsid: false,\n securityType: NetworkSecurityType.WPA2_PSK\n});\n```"
|
|
44
|
+
}
|
|
45
|
+
],
|
|
46
|
+
"docs": "Show a system dialog to add a Wi-Fi network to the device.\nOn Android SDK 30+, this opens the system Wi-Fi settings with the network pre-filled.\nOn iOS, this connects to the network directly.",
|
|
47
|
+
"complexTypes": [
|
|
48
|
+
"AddNetworkOptions"
|
|
49
|
+
],
|
|
50
|
+
"slug": "addnetwork"
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"name": "connect",
|
|
54
|
+
"signature": "(options: ConnectOptions) => Promise<void>",
|
|
55
|
+
"parameters": [
|
|
56
|
+
{
|
|
57
|
+
"name": "options",
|
|
58
|
+
"docs": "- Connection options",
|
|
59
|
+
"type": "ConnectOptions"
|
|
60
|
+
}
|
|
61
|
+
],
|
|
62
|
+
"returns": "Promise<void>",
|
|
63
|
+
"tags": [
|
|
64
|
+
{
|
|
65
|
+
"name": "param",
|
|
66
|
+
"text": "options - Connection options"
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"name": "returns",
|
|
70
|
+
"text": "Promise that resolves when connected"
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
"name": "throws",
|
|
74
|
+
"text": "Error if connection fails"
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
"name": "since",
|
|
78
|
+
"text": "7.0.0"
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
"name": "example",
|
|
82
|
+
"text": "```typescript\nawait CapacitorWifi.connect({\n ssid: 'MyNetwork',\n password: 'mypassword'\n});\n```"
|
|
83
|
+
}
|
|
84
|
+
],
|
|
85
|
+
"docs": "Connect to a Wi-Fi network.\nOn Android, this creates a temporary connection that doesn't route traffic through the network by default.\nFor a persistent connection on Android, use addNetwork() instead.\nOn iOS, this creates a persistent connection.",
|
|
86
|
+
"complexTypes": [
|
|
87
|
+
"ConnectOptions"
|
|
88
|
+
],
|
|
89
|
+
"slug": "connect"
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
"name": "disconnect",
|
|
93
|
+
"signature": "(options?: DisconnectOptions | undefined) => Promise<void>",
|
|
94
|
+
"parameters": [
|
|
95
|
+
{
|
|
96
|
+
"name": "options",
|
|
97
|
+
"docs": "- Optional disconnect options",
|
|
98
|
+
"type": "DisconnectOptions | undefined"
|
|
99
|
+
}
|
|
100
|
+
],
|
|
101
|
+
"returns": "Promise<void>",
|
|
102
|
+
"tags": [
|
|
103
|
+
{
|
|
104
|
+
"name": "param",
|
|
105
|
+
"text": "options - Optional disconnect options"
|
|
106
|
+
},
|
|
107
|
+
{
|
|
108
|
+
"name": "returns",
|
|
109
|
+
"text": "Promise that resolves when disconnected"
|
|
110
|
+
},
|
|
111
|
+
{
|
|
112
|
+
"name": "throws",
|
|
113
|
+
"text": "Error if disconnection fails"
|
|
114
|
+
},
|
|
115
|
+
{
|
|
116
|
+
"name": "since",
|
|
117
|
+
"text": "7.0.0"
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
"name": "example",
|
|
121
|
+
"text": "```typescript\nawait CapacitorWifi.disconnect();\n```"
|
|
122
|
+
}
|
|
123
|
+
],
|
|
124
|
+
"docs": "Disconnect from the current Wi-Fi network.\nOn iOS, only disconnects from networks that were added via this plugin.",
|
|
125
|
+
"complexTypes": [
|
|
126
|
+
"DisconnectOptions"
|
|
127
|
+
],
|
|
128
|
+
"slug": "disconnect"
|
|
129
|
+
},
|
|
130
|
+
{
|
|
131
|
+
"name": "getAvailableNetworks",
|
|
132
|
+
"signature": "() => Promise<GetAvailableNetworksResult>",
|
|
133
|
+
"parameters": [],
|
|
134
|
+
"returns": "Promise<GetAvailableNetworksResult>",
|
|
135
|
+
"tags": [
|
|
136
|
+
{
|
|
137
|
+
"name": "returns",
|
|
138
|
+
"text": "Promise that resolves with the list of networks"
|
|
139
|
+
},
|
|
140
|
+
{
|
|
141
|
+
"name": "throws",
|
|
142
|
+
"text": "Error if getting networks fails or on unsupported platform"
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
"name": "since",
|
|
146
|
+
"text": "7.0.0"
|
|
147
|
+
},
|
|
148
|
+
{
|
|
149
|
+
"name": "example",
|
|
150
|
+
"text": "```typescript\nconst { networks } = await CapacitorWifi.getAvailableNetworks();\nnetworks.forEach(network => {\n console.log(`SSID: ${network.ssid}, Signal: ${network.rssi} dBm`);\n});\n```"
|
|
151
|
+
}
|
|
152
|
+
],
|
|
153
|
+
"docs": "Get a list of available Wi-Fi networks from the last scan.\nOnly available on Android.",
|
|
154
|
+
"complexTypes": [
|
|
155
|
+
"GetAvailableNetworksResult"
|
|
156
|
+
],
|
|
157
|
+
"slug": "getavailablenetworks"
|
|
158
|
+
},
|
|
159
|
+
{
|
|
160
|
+
"name": "getIpAddress",
|
|
161
|
+
"signature": "() => Promise<GetIpAddressResult>",
|
|
162
|
+
"parameters": [],
|
|
163
|
+
"returns": "Promise<GetIpAddressResult>",
|
|
164
|
+
"tags": [
|
|
165
|
+
{
|
|
166
|
+
"name": "returns",
|
|
167
|
+
"text": "Promise that resolves with the IP address"
|
|
168
|
+
},
|
|
169
|
+
{
|
|
170
|
+
"name": "throws",
|
|
171
|
+
"text": "Error if getting IP address fails"
|
|
172
|
+
},
|
|
173
|
+
{
|
|
174
|
+
"name": "since",
|
|
175
|
+
"text": "7.0.0"
|
|
176
|
+
},
|
|
177
|
+
{
|
|
178
|
+
"name": "example",
|
|
179
|
+
"text": "```typescript\nconst { ipAddress } = await CapacitorWifi.getIpAddress();\nconsole.log('IP Address:', ipAddress);\n```"
|
|
180
|
+
}
|
|
181
|
+
],
|
|
182
|
+
"docs": "Get the device's current IP address.\nAvailable on both Android and iOS.",
|
|
183
|
+
"complexTypes": [
|
|
184
|
+
"GetIpAddressResult"
|
|
185
|
+
],
|
|
186
|
+
"slug": "getipaddress"
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"name": "getRssi",
|
|
190
|
+
"signature": "() => Promise<GetRssiResult>",
|
|
191
|
+
"parameters": [],
|
|
192
|
+
"returns": "Promise<GetRssiResult>",
|
|
193
|
+
"tags": [
|
|
194
|
+
{
|
|
195
|
+
"name": "returns",
|
|
196
|
+
"text": "Promise that resolves with the RSSI value"
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
"name": "throws",
|
|
200
|
+
"text": "Error if getting RSSI fails or on unsupported platform"
|
|
201
|
+
},
|
|
202
|
+
{
|
|
203
|
+
"name": "since",
|
|
204
|
+
"text": "7.0.0"
|
|
205
|
+
},
|
|
206
|
+
{
|
|
207
|
+
"name": "example",
|
|
208
|
+
"text": "```typescript\nconst { rssi } = await CapacitorWifi.getRssi();\nconsole.log('Signal strength:', rssi, 'dBm');\n```"
|
|
209
|
+
}
|
|
210
|
+
],
|
|
211
|
+
"docs": "Get the received signal strength indicator (RSSI) of the current network in dBm.\nOnly available on Android.",
|
|
212
|
+
"complexTypes": [
|
|
213
|
+
"GetRssiResult"
|
|
214
|
+
],
|
|
215
|
+
"slug": "getrssi"
|
|
216
|
+
},
|
|
217
|
+
{
|
|
218
|
+
"name": "getSsid",
|
|
219
|
+
"signature": "() => Promise<GetSsidResult>",
|
|
220
|
+
"parameters": [],
|
|
221
|
+
"returns": "Promise<GetSsidResult>",
|
|
222
|
+
"tags": [
|
|
223
|
+
{
|
|
224
|
+
"name": "returns",
|
|
225
|
+
"text": "Promise that resolves with the SSID"
|
|
226
|
+
},
|
|
227
|
+
{
|
|
228
|
+
"name": "throws",
|
|
229
|
+
"text": "Error if getting SSID fails"
|
|
230
|
+
},
|
|
231
|
+
{
|
|
232
|
+
"name": "since",
|
|
233
|
+
"text": "7.0.0"
|
|
234
|
+
},
|
|
235
|
+
{
|
|
236
|
+
"name": "example",
|
|
237
|
+
"text": "```typescript\nconst { ssid } = await CapacitorWifi.getSsid();\nconsole.log('Connected to:', ssid);\n```"
|
|
238
|
+
}
|
|
239
|
+
],
|
|
240
|
+
"docs": "Get the service set identifier (SSID) of the current network.\nAvailable on both Android and iOS.",
|
|
241
|
+
"complexTypes": [
|
|
242
|
+
"GetSsidResult"
|
|
243
|
+
],
|
|
244
|
+
"slug": "getssid"
|
|
245
|
+
},
|
|
246
|
+
{
|
|
247
|
+
"name": "isEnabled",
|
|
248
|
+
"signature": "() => Promise<IsEnabledResult>",
|
|
249
|
+
"parameters": [],
|
|
250
|
+
"returns": "Promise<IsEnabledResult>",
|
|
251
|
+
"tags": [
|
|
252
|
+
{
|
|
253
|
+
"name": "returns",
|
|
254
|
+
"text": "Promise that resolves with the Wi-Fi enabled status"
|
|
255
|
+
},
|
|
256
|
+
{
|
|
257
|
+
"name": "throws",
|
|
258
|
+
"text": "Error if checking status fails or on unsupported platform"
|
|
259
|
+
},
|
|
260
|
+
{
|
|
261
|
+
"name": "since",
|
|
262
|
+
"text": "7.0.0"
|
|
263
|
+
},
|
|
264
|
+
{
|
|
265
|
+
"name": "example",
|
|
266
|
+
"text": "```typescript\nconst { enabled } = await CapacitorWifi.isEnabled();\nconsole.log('WiFi is', enabled ? 'enabled' : 'disabled');\n```"
|
|
267
|
+
}
|
|
268
|
+
],
|
|
269
|
+
"docs": "Check if Wi-Fi is enabled on the device.\nOnly available on Android.",
|
|
270
|
+
"complexTypes": [
|
|
271
|
+
"IsEnabledResult"
|
|
272
|
+
],
|
|
273
|
+
"slug": "isenabled"
|
|
274
|
+
},
|
|
275
|
+
{
|
|
276
|
+
"name": "startScan",
|
|
277
|
+
"signature": "() => Promise<void>",
|
|
278
|
+
"parameters": [],
|
|
279
|
+
"returns": "Promise<void>",
|
|
280
|
+
"tags": [
|
|
281
|
+
{
|
|
282
|
+
"name": "returns",
|
|
283
|
+
"text": "Promise that resolves when scan starts"
|
|
284
|
+
},
|
|
285
|
+
{
|
|
286
|
+
"name": "throws",
|
|
287
|
+
"text": "Error if scan fails or on unsupported platform"
|
|
288
|
+
},
|
|
289
|
+
{
|
|
290
|
+
"name": "since",
|
|
291
|
+
"text": "7.0.0"
|
|
292
|
+
},
|
|
293
|
+
{
|
|
294
|
+
"name": "example",
|
|
295
|
+
"text": "```typescript\nawait CapacitorWifi.addListener('networksScanned', () => {\n console.log('Scan completed');\n});\nawait CapacitorWifi.startScan();\n```"
|
|
296
|
+
}
|
|
297
|
+
],
|
|
298
|
+
"docs": "Start scanning for Wi-Fi networks.\nOnly available on Android.\nResults are delivered via the 'networksScanned' event listener.\nNote: May fail due to system throttling or hardware issues.",
|
|
299
|
+
"complexTypes": [],
|
|
300
|
+
"slug": "startscan"
|
|
301
|
+
},
|
|
302
|
+
{
|
|
303
|
+
"name": "checkPermissions",
|
|
304
|
+
"signature": "() => Promise<PermissionStatus>",
|
|
305
|
+
"parameters": [],
|
|
306
|
+
"returns": "Promise<PermissionStatus>",
|
|
307
|
+
"tags": [
|
|
308
|
+
{
|
|
309
|
+
"name": "returns",
|
|
310
|
+
"text": "Promise that resolves with the permission status"
|
|
311
|
+
},
|
|
312
|
+
{
|
|
313
|
+
"name": "throws",
|
|
314
|
+
"text": "Error if checking permissions fails"
|
|
315
|
+
},
|
|
316
|
+
{
|
|
317
|
+
"name": "since",
|
|
318
|
+
"text": "7.0.0"
|
|
319
|
+
},
|
|
320
|
+
{
|
|
321
|
+
"name": "example",
|
|
322
|
+
"text": "```typescript\nconst status = await CapacitorWifi.checkPermissions();\nconsole.log('Location permission:', status.location);\n```"
|
|
323
|
+
}
|
|
324
|
+
],
|
|
325
|
+
"docs": "Check the current permission status for location access.\nLocation permission is required for Wi-Fi operations on both platforms.",
|
|
326
|
+
"complexTypes": [
|
|
327
|
+
"PermissionStatus"
|
|
328
|
+
],
|
|
329
|
+
"slug": "checkpermissions"
|
|
330
|
+
},
|
|
331
|
+
{
|
|
332
|
+
"name": "requestPermissions",
|
|
333
|
+
"signature": "(options?: RequestPermissionsOptions | undefined) => Promise<PermissionStatus>",
|
|
334
|
+
"parameters": [
|
|
335
|
+
{
|
|
336
|
+
"name": "options",
|
|
337
|
+
"docs": "- Optional permission request options",
|
|
338
|
+
"type": "RequestPermissionsOptions | undefined"
|
|
339
|
+
}
|
|
340
|
+
],
|
|
341
|
+
"returns": "Promise<PermissionStatus>",
|
|
342
|
+
"tags": [
|
|
343
|
+
{
|
|
344
|
+
"name": "param",
|
|
345
|
+
"text": "options - Optional permission request options"
|
|
346
|
+
},
|
|
347
|
+
{
|
|
348
|
+
"name": "returns",
|
|
349
|
+
"text": "Promise that resolves with the updated permission status"
|
|
350
|
+
},
|
|
351
|
+
{
|
|
352
|
+
"name": "throws",
|
|
353
|
+
"text": "Error if requesting permissions fails"
|
|
354
|
+
},
|
|
355
|
+
{
|
|
356
|
+
"name": "since",
|
|
357
|
+
"text": "7.0.0"
|
|
358
|
+
},
|
|
359
|
+
{
|
|
360
|
+
"name": "example",
|
|
361
|
+
"text": "```typescript\nconst status = await CapacitorWifi.requestPermissions();\nif (status.location === 'granted') {\n console.log('Permission granted');\n}\n```"
|
|
362
|
+
}
|
|
363
|
+
],
|
|
364
|
+
"docs": "Request location permissions from the user.\nLocation permission is required for Wi-Fi operations on both platforms.",
|
|
365
|
+
"complexTypes": [
|
|
366
|
+
"PermissionStatus",
|
|
367
|
+
"RequestPermissionsOptions"
|
|
368
|
+
],
|
|
369
|
+
"slug": "requestpermissions"
|
|
370
|
+
},
|
|
371
|
+
{
|
|
372
|
+
"name": "addListener",
|
|
373
|
+
"signature": "(eventName: 'networksScanned', listenerFunc: () => void) => Promise<PluginListenerHandle>",
|
|
374
|
+
"parameters": [
|
|
375
|
+
{
|
|
376
|
+
"name": "eventName",
|
|
377
|
+
"docs": "- The event name ('networksScanned')",
|
|
378
|
+
"type": "'networksScanned'"
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
"name": "listenerFunc",
|
|
382
|
+
"docs": "- The callback function to execute",
|
|
383
|
+
"type": "() => void"
|
|
384
|
+
}
|
|
385
|
+
],
|
|
386
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
387
|
+
"tags": [
|
|
388
|
+
{
|
|
389
|
+
"name": "param",
|
|
390
|
+
"text": "eventName - The event name ('networksScanned')"
|
|
391
|
+
},
|
|
392
|
+
{
|
|
393
|
+
"name": "param",
|
|
394
|
+
"text": "listenerFunc - The callback function to execute"
|
|
395
|
+
},
|
|
396
|
+
{
|
|
397
|
+
"name": "returns",
|
|
398
|
+
"text": "Promise that resolves with a listener handle"
|
|
399
|
+
},
|
|
400
|
+
{
|
|
401
|
+
"name": "since",
|
|
402
|
+
"text": "7.0.0"
|
|
403
|
+
},
|
|
404
|
+
{
|
|
405
|
+
"name": "example",
|
|
406
|
+
"text": "```typescript\nconst listener = await CapacitorWifi.addListener('networksScanned', async () => {\n const { networks } = await CapacitorWifi.getAvailableNetworks();\n console.log('Found networks:', networks);\n});\n```"
|
|
407
|
+
}
|
|
408
|
+
],
|
|
409
|
+
"docs": "Add a listener for the 'networksScanned' event.\nOnly available on Android.\nThis event is fired when Wi-Fi scan results are available.",
|
|
410
|
+
"complexTypes": [
|
|
411
|
+
"PluginListenerHandle"
|
|
412
|
+
],
|
|
413
|
+
"slug": "addlistenernetworksscanned-"
|
|
414
|
+
},
|
|
415
|
+
{
|
|
416
|
+
"name": "removeAllListeners",
|
|
417
|
+
"signature": "() => Promise<void>",
|
|
418
|
+
"parameters": [],
|
|
419
|
+
"returns": "Promise<void>",
|
|
420
|
+
"tags": [
|
|
421
|
+
{
|
|
422
|
+
"name": "returns",
|
|
423
|
+
"text": "Promise that resolves when all listeners are removed"
|
|
424
|
+
},
|
|
425
|
+
{
|
|
426
|
+
"name": "since",
|
|
427
|
+
"text": "7.0.0"
|
|
428
|
+
},
|
|
429
|
+
{
|
|
430
|
+
"name": "example",
|
|
431
|
+
"text": "```typescript\nawait CapacitorWifi.removeAllListeners();\n```"
|
|
432
|
+
}
|
|
433
|
+
],
|
|
434
|
+
"docs": "Remove all listeners for this plugin.",
|
|
435
|
+
"complexTypes": [],
|
|
436
|
+
"slug": "removealllisteners"
|
|
437
|
+
},
|
|
438
|
+
{
|
|
439
|
+
"name": "getPluginVersion",
|
|
440
|
+
"signature": "() => Promise<{ version: string; }>",
|
|
441
|
+
"parameters": [],
|
|
442
|
+
"returns": "Promise<{ version: string; }>",
|
|
443
|
+
"tags": [
|
|
444
|
+
{
|
|
445
|
+
"name": "returns",
|
|
446
|
+
"text": "Promise that resolves with the plugin version"
|
|
447
|
+
},
|
|
448
|
+
{
|
|
449
|
+
"name": "throws",
|
|
450
|
+
"text": "Error if getting the version fails"
|
|
451
|
+
},
|
|
452
|
+
{
|
|
453
|
+
"name": "since",
|
|
454
|
+
"text": "7.0.0"
|
|
455
|
+
},
|
|
456
|
+
{
|
|
457
|
+
"name": "example",
|
|
458
|
+
"text": "```typescript\nconst { version } = await CapacitorWifi.getPluginVersion();\nconsole.log('Plugin version:', version);\n```"
|
|
459
|
+
}
|
|
460
|
+
],
|
|
461
|
+
"docs": "Get the native plugin version.",
|
|
462
|
+
"complexTypes": [],
|
|
463
|
+
"slug": "getpluginversion"
|
|
464
|
+
}
|
|
465
|
+
],
|
|
466
|
+
"properties": []
|
|
467
|
+
},
|
|
468
|
+
"interfaces": [
|
|
469
|
+
{
|
|
470
|
+
"name": "AddNetworkOptions",
|
|
471
|
+
"slug": "addnetworkoptions",
|
|
472
|
+
"docs": "Options for adding a network",
|
|
473
|
+
"tags": [
|
|
474
|
+
{
|
|
475
|
+
"text": "7.0.0",
|
|
476
|
+
"name": "since"
|
|
477
|
+
}
|
|
478
|
+
],
|
|
479
|
+
"methods": [],
|
|
480
|
+
"properties": [
|
|
481
|
+
{
|
|
482
|
+
"name": "ssid",
|
|
483
|
+
"tags": [
|
|
484
|
+
{
|
|
485
|
+
"text": "7.0.0",
|
|
486
|
+
"name": "since"
|
|
487
|
+
}
|
|
488
|
+
],
|
|
489
|
+
"docs": "The SSID of the network to add",
|
|
490
|
+
"complexTypes": [],
|
|
491
|
+
"type": "string"
|
|
492
|
+
},
|
|
493
|
+
{
|
|
494
|
+
"name": "password",
|
|
495
|
+
"tags": [
|
|
496
|
+
{
|
|
497
|
+
"text": "7.0.0",
|
|
498
|
+
"name": "since"
|
|
499
|
+
}
|
|
500
|
+
],
|
|
501
|
+
"docs": "The password for the network (optional for open networks)",
|
|
502
|
+
"complexTypes": [],
|
|
503
|
+
"type": "string | undefined"
|
|
504
|
+
},
|
|
505
|
+
{
|
|
506
|
+
"name": "isHiddenSsid",
|
|
507
|
+
"tags": [
|
|
508
|
+
{
|
|
509
|
+
"text": "7.0.0",
|
|
510
|
+
"name": "since"
|
|
511
|
+
},
|
|
512
|
+
{
|
|
513
|
+
"text": "false",
|
|
514
|
+
"name": "default"
|
|
515
|
+
}
|
|
516
|
+
],
|
|
517
|
+
"docs": "Whether the network is hidden (Android only)",
|
|
518
|
+
"complexTypes": [],
|
|
519
|
+
"type": "boolean | undefined"
|
|
520
|
+
},
|
|
521
|
+
{
|
|
522
|
+
"name": "securityType",
|
|
523
|
+
"tags": [
|
|
524
|
+
{
|
|
525
|
+
"text": "7.0.0",
|
|
526
|
+
"name": "since"
|
|
527
|
+
},
|
|
528
|
+
{
|
|
529
|
+
"text": "NetworkSecurityType.WPA2_PSK",
|
|
530
|
+
"name": "default"
|
|
531
|
+
}
|
|
532
|
+
],
|
|
533
|
+
"docs": "The security type of the network (Android only)",
|
|
534
|
+
"complexTypes": [
|
|
535
|
+
"NetworkSecurityType"
|
|
536
|
+
],
|
|
537
|
+
"type": "NetworkSecurityType"
|
|
538
|
+
}
|
|
539
|
+
]
|
|
540
|
+
},
|
|
541
|
+
{
|
|
542
|
+
"name": "ConnectOptions",
|
|
543
|
+
"slug": "connectoptions",
|
|
544
|
+
"docs": "Options for connecting to a network",
|
|
545
|
+
"tags": [
|
|
546
|
+
{
|
|
547
|
+
"text": "7.0.0",
|
|
548
|
+
"name": "since"
|
|
549
|
+
}
|
|
550
|
+
],
|
|
551
|
+
"methods": [],
|
|
552
|
+
"properties": [
|
|
553
|
+
{
|
|
554
|
+
"name": "ssid",
|
|
555
|
+
"tags": [
|
|
556
|
+
{
|
|
557
|
+
"text": "7.0.0",
|
|
558
|
+
"name": "since"
|
|
559
|
+
}
|
|
560
|
+
],
|
|
561
|
+
"docs": "The SSID of the network to connect to",
|
|
562
|
+
"complexTypes": [],
|
|
563
|
+
"type": "string"
|
|
564
|
+
},
|
|
565
|
+
{
|
|
566
|
+
"name": "password",
|
|
567
|
+
"tags": [
|
|
568
|
+
{
|
|
569
|
+
"text": "7.0.0",
|
|
570
|
+
"name": "since"
|
|
571
|
+
}
|
|
572
|
+
],
|
|
573
|
+
"docs": "The password for the network (optional for open networks)",
|
|
574
|
+
"complexTypes": [],
|
|
575
|
+
"type": "string | undefined"
|
|
576
|
+
},
|
|
577
|
+
{
|
|
578
|
+
"name": "isHiddenSsid",
|
|
579
|
+
"tags": [
|
|
580
|
+
{
|
|
581
|
+
"text": "7.0.0",
|
|
582
|
+
"name": "since"
|
|
583
|
+
},
|
|
584
|
+
{
|
|
585
|
+
"text": "false",
|
|
586
|
+
"name": "default"
|
|
587
|
+
}
|
|
588
|
+
],
|
|
589
|
+
"docs": "Whether the network is hidden (Android only)",
|
|
590
|
+
"complexTypes": [],
|
|
591
|
+
"type": "boolean | undefined"
|
|
592
|
+
}
|
|
593
|
+
]
|
|
594
|
+
},
|
|
595
|
+
{
|
|
596
|
+
"name": "DisconnectOptions",
|
|
597
|
+
"slug": "disconnectoptions",
|
|
598
|
+
"docs": "Options for disconnecting from a network",
|
|
599
|
+
"tags": [
|
|
600
|
+
{
|
|
601
|
+
"text": "7.0.0",
|
|
602
|
+
"name": "since"
|
|
603
|
+
}
|
|
604
|
+
],
|
|
605
|
+
"methods": [],
|
|
606
|
+
"properties": [
|
|
607
|
+
{
|
|
608
|
+
"name": "ssid",
|
|
609
|
+
"tags": [
|
|
610
|
+
{
|
|
611
|
+
"text": "7.0.0",
|
|
612
|
+
"name": "since"
|
|
613
|
+
}
|
|
614
|
+
],
|
|
615
|
+
"docs": "The SSID of the network to disconnect from (optional)",
|
|
616
|
+
"complexTypes": [],
|
|
617
|
+
"type": "string | undefined"
|
|
618
|
+
}
|
|
619
|
+
]
|
|
620
|
+
},
|
|
621
|
+
{
|
|
622
|
+
"name": "GetAvailableNetworksResult",
|
|
623
|
+
"slug": "getavailablenetworksresult",
|
|
624
|
+
"docs": "Result from getAvailableNetworks()",
|
|
625
|
+
"tags": [
|
|
626
|
+
{
|
|
627
|
+
"text": "7.0.0",
|
|
628
|
+
"name": "since"
|
|
629
|
+
}
|
|
630
|
+
],
|
|
631
|
+
"methods": [],
|
|
632
|
+
"properties": [
|
|
633
|
+
{
|
|
634
|
+
"name": "networks",
|
|
635
|
+
"tags": [
|
|
636
|
+
{
|
|
637
|
+
"text": "7.0.0",
|
|
638
|
+
"name": "since"
|
|
639
|
+
}
|
|
640
|
+
],
|
|
641
|
+
"docs": "List of available networks",
|
|
642
|
+
"complexTypes": [
|
|
643
|
+
"Network"
|
|
644
|
+
],
|
|
645
|
+
"type": "Network[]"
|
|
646
|
+
}
|
|
647
|
+
]
|
|
648
|
+
},
|
|
649
|
+
{
|
|
650
|
+
"name": "Network",
|
|
651
|
+
"slug": "network",
|
|
652
|
+
"docs": "Represents a Wi-Fi network",
|
|
653
|
+
"tags": [
|
|
654
|
+
{
|
|
655
|
+
"text": "7.0.0",
|
|
656
|
+
"name": "since"
|
|
657
|
+
}
|
|
658
|
+
],
|
|
659
|
+
"methods": [],
|
|
660
|
+
"properties": [
|
|
661
|
+
{
|
|
662
|
+
"name": "ssid",
|
|
663
|
+
"tags": [
|
|
664
|
+
{
|
|
665
|
+
"text": "7.0.0",
|
|
666
|
+
"name": "since"
|
|
667
|
+
}
|
|
668
|
+
],
|
|
669
|
+
"docs": "The SSID of the network",
|
|
670
|
+
"complexTypes": [],
|
|
671
|
+
"type": "string"
|
|
672
|
+
},
|
|
673
|
+
{
|
|
674
|
+
"name": "rssi",
|
|
675
|
+
"tags": [
|
|
676
|
+
{
|
|
677
|
+
"text": "7.0.0",
|
|
678
|
+
"name": "since"
|
|
679
|
+
}
|
|
680
|
+
],
|
|
681
|
+
"docs": "The signal strength in dBm",
|
|
682
|
+
"complexTypes": [],
|
|
683
|
+
"type": "number"
|
|
684
|
+
},
|
|
685
|
+
{
|
|
686
|
+
"name": "securityTypes",
|
|
687
|
+
"tags": [
|
|
688
|
+
{
|
|
689
|
+
"text": "7.0.0",
|
|
690
|
+
"name": "since"
|
|
691
|
+
}
|
|
692
|
+
],
|
|
693
|
+
"docs": "The security types supported by this network (Android SDK 33+ only)",
|
|
694
|
+
"complexTypes": [
|
|
695
|
+
"NetworkSecurityType"
|
|
696
|
+
],
|
|
697
|
+
"type": "NetworkSecurityType[] | undefined"
|
|
698
|
+
}
|
|
699
|
+
]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
"name": "GetIpAddressResult",
|
|
703
|
+
"slug": "getipaddressresult",
|
|
704
|
+
"docs": "Result from getIpAddress()",
|
|
705
|
+
"tags": [
|
|
706
|
+
{
|
|
707
|
+
"text": "7.0.0",
|
|
708
|
+
"name": "since"
|
|
709
|
+
}
|
|
710
|
+
],
|
|
711
|
+
"methods": [],
|
|
712
|
+
"properties": [
|
|
713
|
+
{
|
|
714
|
+
"name": "ipAddress",
|
|
715
|
+
"tags": [
|
|
716
|
+
{
|
|
717
|
+
"text": "7.0.0",
|
|
718
|
+
"name": "since"
|
|
719
|
+
}
|
|
720
|
+
],
|
|
721
|
+
"docs": "The device's IP address",
|
|
722
|
+
"complexTypes": [],
|
|
723
|
+
"type": "string"
|
|
724
|
+
}
|
|
725
|
+
]
|
|
726
|
+
},
|
|
727
|
+
{
|
|
728
|
+
"name": "GetRssiResult",
|
|
729
|
+
"slug": "getrssiresult",
|
|
730
|
+
"docs": "Result from getRssi()",
|
|
731
|
+
"tags": [
|
|
732
|
+
{
|
|
733
|
+
"text": "7.0.0",
|
|
734
|
+
"name": "since"
|
|
735
|
+
}
|
|
736
|
+
],
|
|
737
|
+
"methods": [],
|
|
738
|
+
"properties": [
|
|
739
|
+
{
|
|
740
|
+
"name": "rssi",
|
|
741
|
+
"tags": [
|
|
742
|
+
{
|
|
743
|
+
"text": "7.0.0",
|
|
744
|
+
"name": "since"
|
|
745
|
+
}
|
|
746
|
+
],
|
|
747
|
+
"docs": "The signal strength in dBm",
|
|
748
|
+
"complexTypes": [],
|
|
749
|
+
"type": "number"
|
|
750
|
+
}
|
|
751
|
+
]
|
|
752
|
+
},
|
|
753
|
+
{
|
|
754
|
+
"name": "GetSsidResult",
|
|
755
|
+
"slug": "getssidresult",
|
|
756
|
+
"docs": "Result from getSsid()",
|
|
757
|
+
"tags": [
|
|
758
|
+
{
|
|
759
|
+
"text": "7.0.0",
|
|
760
|
+
"name": "since"
|
|
761
|
+
}
|
|
762
|
+
],
|
|
763
|
+
"methods": [],
|
|
764
|
+
"properties": [
|
|
765
|
+
{
|
|
766
|
+
"name": "ssid",
|
|
767
|
+
"tags": [
|
|
768
|
+
{
|
|
769
|
+
"text": "7.0.0",
|
|
770
|
+
"name": "since"
|
|
771
|
+
}
|
|
772
|
+
],
|
|
773
|
+
"docs": "The SSID of the current network",
|
|
774
|
+
"complexTypes": [],
|
|
775
|
+
"type": "string"
|
|
776
|
+
}
|
|
777
|
+
]
|
|
778
|
+
},
|
|
779
|
+
{
|
|
780
|
+
"name": "IsEnabledResult",
|
|
781
|
+
"slug": "isenabledresult",
|
|
782
|
+
"docs": "Result from isEnabled()",
|
|
783
|
+
"tags": [
|
|
784
|
+
{
|
|
785
|
+
"text": "7.0.0",
|
|
786
|
+
"name": "since"
|
|
787
|
+
}
|
|
788
|
+
],
|
|
789
|
+
"methods": [],
|
|
790
|
+
"properties": [
|
|
791
|
+
{
|
|
792
|
+
"name": "enabled",
|
|
793
|
+
"tags": [
|
|
794
|
+
{
|
|
795
|
+
"text": "7.0.0",
|
|
796
|
+
"name": "since"
|
|
797
|
+
}
|
|
798
|
+
],
|
|
799
|
+
"docs": "Whether Wi-Fi is enabled",
|
|
800
|
+
"complexTypes": [],
|
|
801
|
+
"type": "boolean"
|
|
802
|
+
}
|
|
803
|
+
]
|
|
804
|
+
},
|
|
805
|
+
{
|
|
806
|
+
"name": "PermissionStatus",
|
|
807
|
+
"slug": "permissionstatus",
|
|
808
|
+
"docs": "Permission status",
|
|
809
|
+
"tags": [
|
|
810
|
+
{
|
|
811
|
+
"text": "7.0.0",
|
|
812
|
+
"name": "since"
|
|
813
|
+
}
|
|
814
|
+
],
|
|
815
|
+
"methods": [],
|
|
816
|
+
"properties": [
|
|
817
|
+
{
|
|
818
|
+
"name": "location",
|
|
819
|
+
"tags": [
|
|
820
|
+
{
|
|
821
|
+
"text": "7.0.0",
|
|
822
|
+
"name": "since"
|
|
823
|
+
}
|
|
824
|
+
],
|
|
825
|
+
"docs": "Location permission state",
|
|
826
|
+
"complexTypes": [
|
|
827
|
+
"PermissionState"
|
|
828
|
+
],
|
|
829
|
+
"type": "PermissionState"
|
|
830
|
+
}
|
|
831
|
+
]
|
|
832
|
+
},
|
|
833
|
+
{
|
|
834
|
+
"name": "RequestPermissionsOptions",
|
|
835
|
+
"slug": "requestpermissionsoptions",
|
|
836
|
+
"docs": "Options for requesting permissions",
|
|
837
|
+
"tags": [
|
|
838
|
+
{
|
|
839
|
+
"text": "7.0.0",
|
|
840
|
+
"name": "since"
|
|
841
|
+
}
|
|
842
|
+
],
|
|
843
|
+
"methods": [],
|
|
844
|
+
"properties": [
|
|
845
|
+
{
|
|
846
|
+
"name": "permissions",
|
|
847
|
+
"tags": [
|
|
848
|
+
{
|
|
849
|
+
"text": "7.0.0",
|
|
850
|
+
"name": "since"
|
|
851
|
+
}
|
|
852
|
+
],
|
|
853
|
+
"docs": "Permissions to request",
|
|
854
|
+
"complexTypes": [],
|
|
855
|
+
"type": "'location'[] | undefined"
|
|
856
|
+
}
|
|
857
|
+
]
|
|
858
|
+
},
|
|
859
|
+
{
|
|
860
|
+
"name": "PluginListenerHandle",
|
|
861
|
+
"slug": "pluginlistenerhandle",
|
|
862
|
+
"docs": "",
|
|
863
|
+
"tags": [],
|
|
864
|
+
"methods": [],
|
|
865
|
+
"properties": [
|
|
866
|
+
{
|
|
867
|
+
"name": "remove",
|
|
868
|
+
"tags": [],
|
|
869
|
+
"docs": "",
|
|
870
|
+
"complexTypes": [],
|
|
871
|
+
"type": "() => Promise<void>"
|
|
872
|
+
}
|
|
873
|
+
]
|
|
874
|
+
}
|
|
875
|
+
],
|
|
876
|
+
"enums": [
|
|
877
|
+
{
|
|
878
|
+
"name": "NetworkSecurityType",
|
|
879
|
+
"slug": "networksecuritytype",
|
|
880
|
+
"members": [
|
|
881
|
+
{
|
|
882
|
+
"name": "OPEN",
|
|
883
|
+
"value": "0",
|
|
884
|
+
"tags": [
|
|
885
|
+
{
|
|
886
|
+
"text": "7.0.0",
|
|
887
|
+
"name": "since"
|
|
888
|
+
}
|
|
889
|
+
],
|
|
890
|
+
"docs": "Open network with no security"
|
|
891
|
+
},
|
|
892
|
+
{
|
|
893
|
+
"name": "WEP",
|
|
894
|
+
"value": "1",
|
|
895
|
+
"tags": [
|
|
896
|
+
{
|
|
897
|
+
"text": "7.0.0",
|
|
898
|
+
"name": "since"
|
|
899
|
+
}
|
|
900
|
+
],
|
|
901
|
+
"docs": "WEP security"
|
|
902
|
+
},
|
|
903
|
+
{
|
|
904
|
+
"name": "WPA2_PSK",
|
|
905
|
+
"value": "2",
|
|
906
|
+
"tags": [
|
|
907
|
+
{
|
|
908
|
+
"text": "7.0.0",
|
|
909
|
+
"name": "since"
|
|
910
|
+
}
|
|
911
|
+
],
|
|
912
|
+
"docs": "WPA/WPA2 Personal (PSK)"
|
|
913
|
+
},
|
|
914
|
+
{
|
|
915
|
+
"name": "EAP",
|
|
916
|
+
"value": "3",
|
|
917
|
+
"tags": [
|
|
918
|
+
{
|
|
919
|
+
"text": "7.0.0",
|
|
920
|
+
"name": "since"
|
|
921
|
+
}
|
|
922
|
+
],
|
|
923
|
+
"docs": "WPA/WPA2/WPA3 Enterprise (EAP)"
|
|
924
|
+
},
|
|
925
|
+
{
|
|
926
|
+
"name": "SAE",
|
|
927
|
+
"value": "4",
|
|
928
|
+
"tags": [
|
|
929
|
+
{
|
|
930
|
+
"text": "7.0.0",
|
|
931
|
+
"name": "since"
|
|
932
|
+
}
|
|
933
|
+
],
|
|
934
|
+
"docs": "WPA3 Personal (SAE)"
|
|
935
|
+
},
|
|
936
|
+
{
|
|
937
|
+
"name": "WPA3_ENTERPRISE",
|
|
938
|
+
"value": "5",
|
|
939
|
+
"tags": [
|
|
940
|
+
{
|
|
941
|
+
"text": "7.0.0",
|
|
942
|
+
"name": "since"
|
|
943
|
+
}
|
|
944
|
+
],
|
|
945
|
+
"docs": "WPA3 Enterprise"
|
|
946
|
+
},
|
|
947
|
+
{
|
|
948
|
+
"name": "WPA3_ENTERPRISE_192_BIT",
|
|
949
|
+
"value": "6",
|
|
950
|
+
"tags": [
|
|
951
|
+
{
|
|
952
|
+
"text": "7.0.0",
|
|
953
|
+
"name": "since"
|
|
954
|
+
}
|
|
955
|
+
],
|
|
956
|
+
"docs": "WPA3 Enterprise 192-bit mode"
|
|
957
|
+
},
|
|
958
|
+
{
|
|
959
|
+
"name": "PASSPOINT",
|
|
960
|
+
"value": "7",
|
|
961
|
+
"tags": [
|
|
962
|
+
{
|
|
963
|
+
"text": "7.0.0",
|
|
964
|
+
"name": "since"
|
|
965
|
+
}
|
|
966
|
+
],
|
|
967
|
+
"docs": "Passpoint network"
|
|
968
|
+
},
|
|
969
|
+
{
|
|
970
|
+
"name": "OWE",
|
|
971
|
+
"value": "8",
|
|
972
|
+
"tags": [
|
|
973
|
+
{
|
|
974
|
+
"text": "7.0.0",
|
|
975
|
+
"name": "since"
|
|
976
|
+
}
|
|
977
|
+
],
|
|
978
|
+
"docs": "Enhanced Open (OWE)"
|
|
979
|
+
},
|
|
980
|
+
{
|
|
981
|
+
"name": "WAPI_PSK",
|
|
982
|
+
"value": "9",
|
|
983
|
+
"tags": [
|
|
984
|
+
{
|
|
985
|
+
"text": "7.0.0",
|
|
986
|
+
"name": "since"
|
|
987
|
+
}
|
|
988
|
+
],
|
|
989
|
+
"docs": "WAPI PSK"
|
|
990
|
+
},
|
|
991
|
+
{
|
|
992
|
+
"name": "WAPI_CERT",
|
|
993
|
+
"value": "10",
|
|
994
|
+
"tags": [
|
|
995
|
+
{
|
|
996
|
+
"text": "7.0.0",
|
|
997
|
+
"name": "since"
|
|
998
|
+
}
|
|
999
|
+
],
|
|
1000
|
+
"docs": "WAPI Certificate"
|
|
1001
|
+
}
|
|
1002
|
+
]
|
|
1003
|
+
}
|
|
1004
|
+
],
|
|
1005
|
+
"typeAliases": [
|
|
1006
|
+
{
|
|
1007
|
+
"name": "PermissionState",
|
|
1008
|
+
"slug": "permissionstate",
|
|
1009
|
+
"docs": "",
|
|
1010
|
+
"types": [
|
|
1011
|
+
{
|
|
1012
|
+
"text": "'prompt'",
|
|
1013
|
+
"complexTypes": []
|
|
1014
|
+
},
|
|
1015
|
+
{
|
|
1016
|
+
"text": "'prompt-with-rationale'",
|
|
1017
|
+
"complexTypes": []
|
|
1018
|
+
},
|
|
1019
|
+
{
|
|
1020
|
+
"text": "'granted'",
|
|
1021
|
+
"complexTypes": []
|
|
1022
|
+
},
|
|
1023
|
+
{
|
|
1024
|
+
"text": "'denied'",
|
|
1025
|
+
"complexTypes": []
|
|
1026
|
+
}
|
|
1027
|
+
]
|
|
1028
|
+
}
|
|
1029
|
+
],
|
|
1030
|
+
"pluginConfigs": []
|
|
1031
|
+
}
|