From 7baeab9feeea6dc3963f4d3f3f25a9bde2174ad0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Franti=C5=A1ek=20Spurn=C3=BD?= <43814366+SenNeonoveNoci@users.noreply.github.com> Date: Mon, 27 Jan 2020 06:25:50 +0100 Subject: [PATCH] docs(smartlook): extended usage sample (#3278) * docs(smartlook): expanded usage sample * docs(smartlook) fixed lint error * Update index.ts Co-authored-by: Daniel Sogl --- src/@ionic-native/plugins/smartlook/index.ts | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/src/@ionic-native/plugins/smartlook/index.ts b/src/@ionic-native/plugins/smartlook/index.ts index 4f9427a73..cb6173521 100644 --- a/src/@ionic-native/plugins/smartlook/index.ts +++ b/src/@ionic-native/plugins/smartlook/index.ts @@ -64,20 +64,23 @@ export class SmartlookGlobalEventPropertyKey { /** * @name Smartlook * @description - * Official Smartlook SDK plugin. For more information visit (www.smartlook.com). + * Official Smartlook SDK plugin. + * Full documentation can be found here: https://smartlook.github.io/docs/sdk/ionic/ * * @usage * ```typescript - * import { Smartlook } from '@ionic-native/smartlook/ngx'; - * - * - * constructor(private smartlook: Smartlook) { } + * import { Smartlook, SmartlookSetupConfig } from '@ionic-native/smartlook/ngx'; * * ... * - * - * this.smartlook.setupAndStartRecording(new SmartlookSetupConfig("key")); - * + * @Component( ... ) + * export class AppComponent { + * constructor(private smartlook: Smartlook) { + * this.platform.ready().then(() => { + * this.smartlook.setupAndStartRecording(new SmartlookSetupConfig("YOUR API KEY")); + * } + * } + * } * ``` * @classes * SmartlookSetupConfig