Merge pull request #4168 from NativeScript/fatme/public-api

Docs for the public api for preview

Author: Fatme

PublicAPI.md

@@ -36,6 +36,7 @@ const tns = require("nativescript");
 	* [debug](#debug)
 * [liveSyncService](#livesyncservice)
 	* [liveSync](#livesync)
+	* [liveSyncToPreviewApp](#livesynctopreviewapp)
 	* [stopLiveSync](#stopLiveSync)
 	* [enableDebugging](#enableDebugging)
 	* [attachDebugger](#attachDebugger)
@@ -58,6 +59,12 @@ const tns = require("nativescript");
 	* [startEmulator](#startemulator)
 * [deviceEmitter](#deviceemitter)
 	* [events](#deviceemitterevents)
+* [previewDevicesService](#previewdevicesservice)
+	* [deviceFound](#devicefound)
+	* [deviceLost](#devicelost)
+	* [deviceLog](#devicelog)
+* [previewQrCodeService](#previewqrcodeservice)
+	* [getPlaygroundAppQrCode](#getplaygroundappqrcode)
 
 ## Module projectService
 
@@ -768,6 +775,33 @@ tns.liveSyncService.liveSync([ androidDeviceDescriptor, iOSDeviceDescriptor ], l
 	});
 ```
 
+### liveSyncToPreviewApp
+Starts a LiveSync operation to the Preview app. After scanning the QR code with the scanner provided in the NativeScript Playground app, the app will be launched on a device through the Preview app. Additionally, any changes made to the project will be automatically synchronized with the deployed app.
+
+* Definition
+```TypeScript
+/**
+ * Starts LiveSync operation by producting a QR code and starting watcher.
+ * @param {IPreviewAppLiveSyncData} liveSyncData Describes the LiveSync operation - for which project directory is the operation and other settings.
+ * @returns {Promise<IQrCodeImageData>}
+ */
+liveSyncToPreviewApp(liveSyncData: IPreviewAppLiveSyncData): Promise<IQrCodeImageData>;
+```
+
+* Usage:
+```JavaScript
+const liveSyncData = {
+	projectDir,
+	bundle: false,
+	useHotModuleReload: false,
+	env: { }
+};
+tns.liveSyncService.liveSyncToPreviewApp(liveSyncData)
+	.then(qrCodeImageData => {
+		console.log("The qrCodeImageData is: " + qrCodeImageData);
+	});
+```
+
 ### stopLiveSync
 Stops LiveSync operation. In case deviceIdentifires are passed, the operation will be stopped only for these devices.
 
@@ -1341,6 +1375,50 @@ tns.deviceEmitter.on("emulatorImageLost", (emulatorImageInfo) => {
 ```
 `emulatorImageInfo` is of type [Moble.IDeviceInfo](https://github.com/telerik/mobile-cli-lib/blob/61cdaaaf7533394afbbe84dd4eee355072ade2de/definitions/mobile.d.ts#L9-L86).
 
+## previewDevicesService
+The `previewDevicesService` module allows interaction with preview devices. You can get a list of the connected preview devices and logs from specified device.
+
+### previewDevicesEmitterEvents
+
+* `deviceFound` - Raised when the QR code is scanned with any device. The callback function will receive one argument - `device`.
+Sample usage:
+```JavaScript
+tns.previewDevicesService.on("deviceFound", device => {
+	console.log("Attached device with identifier: " + device.id);
+});
+```
+
+* `deviceLost` - Raised when the Preview app is stopped on a specified device. The callback function will receive one argument - `device`.
+Sample usage:
+```JavaScript
+tns.previewDevicesService.on("deviceLost", device => {
+	console.log("Detached device with identifier: " + device.id);
+});
+```
+
+* `deviceLog` - Raised when the app deployed in Preview app reports any information. The event is raised for any device that reports data. The callback function has two arguments - `device` and `message`. <br/><br/>
+Sample usage:
+```JavaScript
+tns.previewDevicesService.on("deviceLogData", (device, message) => {
+	console.log("Device " + device.id + " reports: " + message);
+});
+```
+
+## previewQrCodeService
+The `previewQrCodeService` exposes methods for getting information about the QR of the Playground app and deployed app in Preview app.
+
+### getPlaygroundAppQrCode
+Returns information used to generate the QR code of the Playground app.
+
+* Usage:
+```TypeScript
+tns.previewQrCodeService.getPlaygroundAppQrCode()
+	.then(result => {
+		console.log("QR code data for iOS platform: " + result.ios);
+		console.log("QR code data for Android platform: " + result.android);
+	});
+```
+
 ## How to add a new method to Public API
 CLI is designed as command line tool and when it is used as a library, it does not give you access to all of the methods. This is mainly implementation detail. Most of the CLI's code is created to work in command line, not as a library, so before adding method to public API, most probably it will require some modification.
 For example the `$options` injected module contains information about all `--` options passed on the terminal. When the CLI is used as a library, the options are not populated. Before adding method to public API, make sure its implementation does not rely on `$options`.