fix(): fix tealium jsdoc

This commit is contained in:
Daniel 2018-05-04 10:28:43 +02:00
parent 3fbd475ed2
commit f34b6e6664
3 changed files with 75 additions and 59 deletions

View File

@ -30,12 +30,10 @@ import { Injectable } from '@angular/core';
pluginRef: 'window.tealiumAdIdentifier', // the variable reference to call the plugin, example: navigator.geolocation
repo: 'https://github.com/Tealium/cordova-plugin', // the github repository URL for the plugin
platforms: ['Android', 'iOS'], // Array of platforms supported, example: ['Android', 'iOS']
install: '', // OPTIONAL install command, in case the plugin requires variables
install: '' // OPTIONAL install command, in case the plugin requires variables
})
@Injectable()
export class TealiumAdIdentifier extends IonicNativePlugin {
/**
* This function stores the ad identifier information as persistent data
* @param instanceName {string} Your arbitrary Tealium instance name provided at init time
@ -55,5 +53,4 @@ export class TealiumAdIdentifier extends IonicNativePlugin {
setVolatile(instanceName: string): Promise<any> {
return;
}
}

View File

@ -1,5 +1,5 @@
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
import { Injectable } from '@angular/core';
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
/**
* @paid
@ -30,12 +30,10 @@ import { Injectable } from '@angular/core';
pluginRef: 'window.tealiumInstallReferrer', // the variable reference to call the plugin, example: navigator.geolocation
repo: 'https://github.com/Tealium/cordova-plugin', // the github repository URL for the plugin
platforms: ['Android'], // Array of platforms supported, example: ['Android', 'iOS']
install: '', // OPTIONAL install command, in case the plugin requires variables
install: '' // OPTIONAL install command, in case the plugin requires variables
})
@Injectable()
export class TealiumInstallReferrer extends IonicNativePlugin {
/**
* This function stores the install referrer information as persistent data
* @param instanceName {string} Your arbitrary Tealium instance name provided at init time
@ -55,5 +53,4 @@ export class TealiumInstallReferrer extends IonicNativePlugin {
setVolatile(instanceName: string): Promise<any> {
return;
}
}

View File

@ -1,5 +1,5 @@
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
import { Injectable } from '@angular/core';
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
export interface TealConfig {
/**
@ -76,12 +76,10 @@ export interface TealConfig {
pluginRef: 'window.tealium', // the variable reference to call the plugin, example: navigator.geolocation
repo: 'https://github.com/Tealium/cordova-plugin', // the github repository URL for the plugin
platforms: ['Android', 'iOS'], // Array of platforms supported, example: ['Android', 'iOS']
install: '', // OPTIONAL install command, in case the plugin requires variables
install: '' // OPTIONAL install command, in case the plugin requires variables
})
@Injectable()
export class Tealium extends IonicNativePlugin {
/**
* This function initializes the Tealium Cordova plugin.
* This should usually be done inside the "deviceReady" handler.
@ -123,7 +121,11 @@ export class Tealium extends IonicNativePlugin {
* @return {Promise<any>} Returns a promise that resolves when something happens
*/
@Cordova()
track(eventType: string, dataObject: any, instanceName: string): Promise<any> {
track(
eventType: string,
dataObject: any,
instanceName: string
): Promise<any> {
return;
}
@ -135,7 +137,11 @@ export class Tealium extends IonicNativePlugin {
* @return {Promise<any>} Returns a promise that resolves when something happens
*/
@Cordova()
addPersistent(keyName: string, value: string | string[] | any, instanceName: string): Promise<any> {
addPersistent(
keyName: string,
value: string | string[] | any,
instanceName: string
): Promise<any> {
return;
}
@ -147,7 +153,11 @@ export class Tealium extends IonicNativePlugin {
* @return {Promise<any>} Returns a promise that resolves when something happens
*/
@Cordova()
addVolatile(keyName: string, value: string | string[], instanceName: string): Promise<any> {
addVolatile(
keyName: string,
value: string | string[],
instanceName: string
): Promise<any> {
return;
}
@ -181,9 +191,14 @@ export class Tealium extends IonicNativePlugin {
* @return {Promise<any>} Returns a promise that resolves when something happens
*/
@Cordova()
getPersistent(keyName: string, instanceName: string, callback: any): Promise<any> {
getPersistent(
keyName: string,
instanceName: string,
callback: any
): Promise<any> {
return;
}
/**
* This function retrieves a value from the Tealium Volatile data store
* @param keyName {string} The key name that this data will retrieved from the Tealium data store
@ -192,7 +207,11 @@ export class Tealium extends IonicNativePlugin {
* @return {Promise<any>} Returns a promise that resolves when something happens
*/
@Cordova()
getVolatile(keyName: string, instanceName: string, callback: any): Promise<any> {
getVolatile(
keyName: string,
instanceName: string,
callback: any
): Promise<any> {
return;
}
@ -204,7 +223,11 @@ export class Tealium extends IonicNativePlugin {
* @return {Promise<any>} Returns a promise that resolves when something happens
*/
@Cordova()
addRemoteCommand(commandName: string, instanceName: string, callback: any): Promise<any> {
addRemoteCommand(
commandName: string,
instanceName: string,
callback: any
): Promise<any> {
return;
}
@ -216,5 +239,4 @@ export class Tealium extends IonicNativePlugin {
getVisitorId(): Promise<any> {
return;
}
}