mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-01-20 01:22:52 +08:00
docs(google-analytics): add missing docs
This commit is contained in:
parent
77b0277290
commit
7dba41cbe1
@ -23,6 +23,7 @@ export class GoogleAnalytics {
|
|||||||
* In your 'deviceready' handler, set up your Analytics tracker.
|
* In your 'deviceready' handler, set up your Analytics tracker.
|
||||||
* https://developers.google.com/analytics/devguides/collection/analyticsjs/
|
* https://developers.google.com/analytics/devguides/collection/analyticsjs/
|
||||||
* @param {string} id Your Google Analytics Mobile App property
|
* @param {string} id Your Google Analytics Mobile App property
|
||||||
|
* @return {Promise<any>}
|
||||||
*/
|
*/
|
||||||
@Cordova()
|
@Cordova()
|
||||||
static startTrackerWithId(id: string): Promise<any> { return; }
|
static startTrackerWithId(id: string): Promise<any> { return; }
|
||||||
@ -38,7 +39,7 @@ export class GoogleAnalytics {
|
|||||||
/**
|
/**
|
||||||
* Set a UserId
|
* Set a UserId
|
||||||
* https://developers.google.com/analytics/devguides/collection/analyticsjs/user-id
|
* https://developers.google.com/analytics/devguides/collection/analyticsjs/user-id
|
||||||
* @param {string} id
|
* @param {string} id User ID
|
||||||
* @return {Promise<any>}
|
* @return {Promise<any>}
|
||||||
*/
|
*/
|
||||||
@Cordova()
|
@Cordova()
|
||||||
@ -46,38 +47,43 @@ export class GoogleAnalytics {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Set a anonymize Ip address
|
* Set a anonymize Ip address
|
||||||
* @param anonymize
|
* @param anonymize {boolean} Set to true to anonymize the IP Address
|
||||||
|
* @return {Promise<any>}
|
||||||
*/
|
*/
|
||||||
@Cordova()
|
@Cordova()
|
||||||
static setAnonymizeIp(anonymize: boolean): Promise<any> { return; }
|
static setAnonymizeIp(anonymize: boolean): Promise<any> { return; }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets the app version
|
* Sets the app version
|
||||||
* @param appVersion
|
* @param appVersion {string} App version
|
||||||
|
* @return {Promise<any>}
|
||||||
*/
|
*/
|
||||||
@Cordova()
|
@Cordova()
|
||||||
static setAppVersion(appVersion: string): Promise<any> { return; }
|
static setAppVersion(appVersion: string): Promise<any> { return; }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
* Set OptOut
|
||||||
* @param oputout
|
* @param optout {boolean}
|
||||||
|
* @return {Promise<any>}
|
||||||
*/
|
*/
|
||||||
@Cordova()
|
@Cordova()
|
||||||
static setOptOut(oputout: boolean): Promise<any> { return; }
|
static setOptOut(optout: boolean): Promise<any> { return; }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Enable verbose logging
|
* Enable verbose logging
|
||||||
|
* @return {Promise<any>}
|
||||||
*/
|
*/
|
||||||
@Cordova()
|
@Cordova()
|
||||||
static debugMode(): Promise<any> { return; }
|
static debugMode(): Promise<any> { return; }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
* Track custom metric
|
||||||
* @param key
|
* @param key {string}
|
||||||
* @param value
|
* @param value {any}
|
||||||
|
* @return {Promise<any>}
|
||||||
*/
|
*/
|
||||||
@Cordova()
|
@Cordova()
|
||||||
static trackMetric(key, value): Promise<any> { return; }
|
static trackMetric(key: string, value?: any): Promise<any> { return; }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Track a screen
|
* Track a screen
|
||||||
@ -85,6 +91,7 @@ export class GoogleAnalytics {
|
|||||||
*
|
*
|
||||||
* @param {string} title Screen title
|
* @param {string} title Screen title
|
||||||
* @param {string} campaignUrl Campaign url for measuring referrals
|
* @param {string} campaignUrl Campaign url for measuring referrals
|
||||||
|
* @return {Promise<any>}
|
||||||
*/
|
*/
|
||||||
@Cordova()
|
@Cordova()
|
||||||
static trackView(title: string, campaignUrl?: string): Promise<any> { return; }
|
static trackView(title: string, campaignUrl?: string): Promise<any> { return; }
|
||||||
@ -94,6 +101,7 @@ export class GoogleAnalytics {
|
|||||||
* https://developers.google.com/analytics/devguides/platform/customdimsmets
|
* https://developers.google.com/analytics/devguides/platform/customdimsmets
|
||||||
* @param {string} key
|
* @param {string} key
|
||||||
* @param {string} value
|
* @param {string} value
|
||||||
|
* @return {Promise<any>}
|
||||||
*/
|
*/
|
||||||
@Cordova()
|
@Cordova()
|
||||||
static addCustomDimension(key: number, value: string): Promise<any> { return; }
|
static addCustomDimension(key: number, value: string): Promise<any> { return; }
|
||||||
@ -105,6 +113,7 @@ export class GoogleAnalytics {
|
|||||||
* @param {string} action
|
* @param {string} action
|
||||||
* @param {string} label
|
* @param {string} label
|
||||||
* @param {number} value
|
* @param {number} value
|
||||||
|
* @return {Promise<any>}
|
||||||
*/
|
*/
|
||||||
@Cordova()
|
@Cordova()
|
||||||
static trackEvent(category: string, action: string, label?: string, value?: number): Promise<any> { return; }
|
static trackEvent(category: string, action: string, label?: string, value?: number): Promise<any> { return; }
|
||||||
@ -113,6 +122,7 @@ export class GoogleAnalytics {
|
|||||||
* Track an exception
|
* Track an exception
|
||||||
* @param {string} description
|
* @param {string} description
|
||||||
* @param {boolean} fatal
|
* @param {boolean} fatal
|
||||||
|
* @return {Promise<any>}
|
||||||
*/
|
*/
|
||||||
@Cordova()
|
@Cordova()
|
||||||
static trackException(description: string, fatal: boolean): Promise<any> { return; }
|
static trackException(description: string, fatal: boolean): Promise<any> { return; }
|
||||||
@ -123,6 +133,7 @@ export class GoogleAnalytics {
|
|||||||
* @param {number} intervalInMilliseconds
|
* @param {number} intervalInMilliseconds
|
||||||
* @param {string} variable
|
* @param {string} variable
|
||||||
* @param {string} label
|
* @param {string} label
|
||||||
|
* @return {Promise<any>}
|
||||||
*/
|
*/
|
||||||
@Cordova()
|
@Cordova()
|
||||||
static trackTiming(category: string, intervalInMilliseconds: number, variable: string, label: string): Promise<any> { return; }
|
static trackTiming(category: string, intervalInMilliseconds: number, variable: string, label: string): Promise<any> { return; }
|
||||||
@ -136,6 +147,7 @@ export class GoogleAnalytics {
|
|||||||
* @param {number} tax
|
* @param {number} tax
|
||||||
* @param {number} shipping
|
* @param {number} shipping
|
||||||
* @param {string} currencyCode
|
* @param {string} currencyCode
|
||||||
|
* @return {Promise<any>}
|
||||||
*/
|
*/
|
||||||
@Cordova()
|
@Cordova()
|
||||||
static addTransaction(id: string, affiliation: string, revenue: number, tax: number, shipping: number, currencyCode: string): Promise<any> { return; }
|
static addTransaction(id: string, affiliation: string, revenue: number, tax: number, shipping: number, currencyCode: string): Promise<any> { return; }
|
||||||
@ -150,6 +162,7 @@ export class GoogleAnalytics {
|
|||||||
* @param {number} price
|
* @param {number} price
|
||||||
* @param {number} quantity
|
* @param {number} quantity
|
||||||
* @param {string} currencyCode
|
* @param {string} currencyCode
|
||||||
|
* @return {Promise<any>}
|
||||||
*/
|
*/
|
||||||
@Cordova()
|
@Cordova()
|
||||||
static addTransactionItem(id: string, name: string, sku: string, category: string, price: number, quantity: number, currencyCode: string): Promise<any> { return; }
|
static addTransactionItem(id: string, name: string, sku: string, category: string, price: number, quantity: number, currencyCode: string): Promise<any> { return; }
|
||||||
@ -157,6 +170,7 @@ export class GoogleAnalytics {
|
|||||||
/**
|
/**
|
||||||
* Enable/disable automatic reporting of uncaught exceptions
|
* Enable/disable automatic reporting of uncaught exceptions
|
||||||
* @param {boolean} shouldEnable
|
* @param {boolean} shouldEnable
|
||||||
|
* @return {Promise<any>}
|
||||||
*/
|
*/
|
||||||
@Cordova()
|
@Cordova()
|
||||||
static enableUncaughtExceptionReporting(shouldEnable: boolean): Promise<any> { return; }
|
static enableUncaughtExceptionReporting(shouldEnable: boolean): Promise<any> { return; }
|
||||||
|
Loading…
Reference in New Issue
Block a user