Skip to content

Commit ec59a35

Browse files
docs: update Public API docs
1 parent cfa0e5c commit ec59a35

File tree

2 files changed

+64
-1
lines changed

2 files changed

+64
-1
lines changed

PublicAPI.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ const tns = require("nativescript");
5858
* [devicesService](#devicesservice)
5959
* [getEmulatorImages](#getemulatorimages)
6060
* [startEmulator](#startemulator)
61+
* [startDeviceDetectionInterval](#startdevicedetectioninterval)
62+
* [stopDeviceDetectionInterval](#stopdevicedetectioninterval)
63+
* [startEmulatorDetectionInterval](#startemulatordetectioninterval)
64+
* [stopEmulatorDetectionInterval](#stopemulatordetectioninterval)
6165
* [deviceEmitter](#deviceemitter)
6266
* [events](#deviceemitterevents)
6367
* [previewDevicesService](#previewdevicesservice)
@@ -1287,6 +1291,59 @@ tns.devicesService.startEmulator({imageIdentifier: "my emulator imageIdentifier"
12871291
.then(errors => { });
12881292
```
12891293
1294+
### startDeviceDetectionInterval
1295+
Starts device detection interval, which is run on specified number of seconds. This allows detection of new attached devices, started emulators/simulators, detection when device/emulator/simulator is disconnected, etc.
1296+
> NOTE: The interval is started automatically when you call `devicesService.initialize` without passing `skipDeviceDetectionInterval: true`.
1297+
1298+
> NOTE: iOS Device detection interval cannot be stopped, so once started, it will always report connected/disconnected devices.
1299+
1300+
* Definition
1301+
```TypeScript
1302+
startDeviceDetectionInterval({ detectionInterval?: number, platform?: string }): void
1303+
```
1304+
1305+
* Usage
1306+
```JavaScript
1307+
tns.devicesService.startDeviceDetectionInterval({ detectionInterval: 1000 });
1308+
```
1309+
1310+
### stopDeviceDetectionInterval
1311+
Stops device detection interval started by `devicesService.initialize` or `devicesService.startDeviceDetectionInterval`.
1312+
* Definition
1313+
```TypeScript
1314+
stopDeviceDetectionInterval(): void
1315+
```
1316+
1317+
* Usage
1318+
```JavaScript
1319+
tns.devicesService.stopDeviceDetectionInterval();
1320+
```
1321+
1322+
### startEmulatorDetectionInterval
1323+
Starts emulator images detection interval, which is run on specified number of seconds. This allows detection of new installed emulator/simulator images.
1324+
1325+
* Definition
1326+
```TypeScript
1327+
startEmulatorDetectionInterval({ detectionInterval?: number }): void
1328+
```
1329+
1330+
* Usage
1331+
```JavaScript
1332+
tns.devicesService.startEmulatorDetectionInterval({ detectionInterval: 1000 });
1333+
```
1334+
1335+
### stopEmulatorDetectionInterval
1336+
Stops device detection interval started by `devicesService.startEmulatorDetectionInterval`.
1337+
* Definition
1338+
```TypeScript
1339+
stopEmulatorDetectionInterval(): void
1340+
```
1341+
1342+
* Usage
1343+
```JavaScript
1344+
tns.devicesService.stopEmulatorDetectionInterval();
1345+
```
1346+
12901347
## deviceEmitter
12911348
This module is used to emit information for devices, applications on them, etc.
12921349

test/nativescript-cli-lib.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,17 @@ describe("nativescript-cli-lib", () => {
3737
"getDebuggableApps",
3838
"getDebuggableViews",
3939
"getDevices",
40+
"getEmulatorImages",
4041
"getInstalledApplications",
4142
"initialize",
4243
"isAppInstalledOnDevices",
4344
"mapAbstractToTcpPort",
44-
"setLogLevel"
45+
"setLogLevel",
46+
"startDeviceDetectionInterval",
47+
"stopDeviceDetectionInterval",
48+
"startEmulator",
49+
"startEmulatorDetectionInterval",
50+
"stopEmulatorDetectionInterval",
4551
],
4652
assetsGenerationService: [
4753
"generateIcons",

0 commit comments

Comments
 (0)