docs(firebase-analytics): fix jsdoc

This commit is contained in:
Daniel 2018-04-08 21:45:48 +02:00
parent 1cc7243ef9
commit bee3d639cb

View File

@ -1,5 +1,5 @@
import { Injectable } from '@angular/core'; import { Injectable } from '@angular/core';
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core'; import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
/** /**
* @beta * @beta
@ -35,51 +35,59 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
}) })
@Injectable() @Injectable()
export class FirebaseAnalytics extends IonicNativePlugin { export class FirebaseAnalytics extends IonicNativePlugin {
/** /**
* Logs an app event. * Logs an app event.
* Be aware of automatically collected events. * Be aware of automatically collected events.
* @param name {string} The name of the event * @param {string} name The name of the event
* @param params {any} Some param to configure something * @param {any} params Some param to configure something
* @return {Promise<any>} Returns a promise * @return {Promise<any>} Returns a promise
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
logEvent(name: string, params: any): Promise<any> { return; } logEvent(name: string, params: any): Promise<any> {
return;
}
/** /**
* Sets the user ID property. * Sets the user ID property.
* This feature must be used in accordance with Google's Privacy Policy. * This feature must be used in accordance with Google's Privacy Policy.
* @param id {string} The user ID * @param {string} id The user ID
* @return {Promise<any>} Returns a promise * @return {Promise<any>} Returns a promise
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
setUserId(id: string): Promise<any> { return; } setUserId(id: string): Promise<any> {
return;
}
/** /**
* This feature must be used in accordance with Google's Privacy Policy. * This feature must be used in accordance with Google's Privacy Policy.
* Be aware of automatically collected user properties. * Be aware of automatically collected user properties.
* @param name {string} The property name * @param {string} name The property name
* @param value {string} The property value * @param {string} value The property value
* @return {Promise<any>} Returns a promise * @return {Promise<any>} Returns a promise
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
setUserProperty(name: string, value: string): Promise<any> { return; } setUserProperty(name: string, value: string): Promise<any> {
return;
}
/** /**
* Sets whether analytics collection is enabled for this app on this device. * Sets whether analytics collection is enabled for this app on this device.
* @param enabled {boolean} * @param {boolean} enabled
* @return {Promise<any>} Returns a promise * @return {Promise<any>} Returns a promise
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
setEnabled(enabled: boolean): Promise<any> { return; } setEnabled(enabled: boolean): Promise<any> {
return;
}
/** /**
* Sets the current screen name, which specifies the current visual context in your app. * Sets the current screen name, which specifies the current visual context in your app.
* This helps identify the areas in your app where users spend their time and how they interact with your app. * This helps identify the areas in your app where users spend their time and how they interact with your app.
* @param name {string} The name of the screen * @param {string} name The name of the screen
* @return {Promise<any>} Returns a promise * @return {Promise<any>} Returns a promise
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
setCurrentScreen(name: string): Promise<any> { return; } setCurrentScreen(name: string): Promise<any> {
return;
}
} }