1. var ptagent = require('./js/libs/ptagent.js');

var ptagent = require('./js/libs/ptagent.js');

1. /**
2. * Start PtAgent engine, you should invoke it in onShow() lifecyle function of App,
3. * make sure our module can be inited everytime, even though your app is actived from background mode.
4. * @param ptApp ID: String, you can get it as soon as registered an application in our web management backend.
5. * @param appVersion: String, your mini program version number.
6. */
7. PtInit: function(ptAppKey, appVersion){
8. _ptagent_core.init(ptAppKey, appVersion);
9. }

/**
  * Start PtAgent engine, you should invoke it in onShow() lifecyle function of App,
  * make sure our module can be inited everytime, even though your app is actived from background mode.
  * @param ptApp ID: String, you can get it as soon as registered an application in our web management backend.
  * @param appVersion: String, your mini program version number.
  */
 PtInit: function(ptAppKey, appVersion){
   _ptagent_core.init(ptAppKey,  appVersion);
 }

1. /**
2. * If you want to collect app events by yourself, you can invoke this API
3. * @param eventName: String, this value can't be nil or empty
4. * @param properties: {} or undefined, you can bind some event properties for every event,
5. * if you don't need it, just pass undefined.
6. */
7. PtTrackEvent: function (eventName, properties){
8. _ptagent_core.trackEvent(eventName, properties);
9. }

/**
  * If you want to collect app events by yourself, you can invoke this API
  * @param eventName: String, this value can't be nil or empty
  * @param properties: {} or undefined, you can bind some event properties for every event,
  * if you don't need it, just pass undefined.
  */
 PtTrackEvent: function (eventName, properties){
   _ptagent_core.trackEvent(eventName, properties);
 }

1. /**
2. * Track the shared event if you need, event name is defined by SDK
3. * you just need to pass the event properties
4. * @param properties: {}, the properties that you want to describe the event
5. */
6. PtTrackSharedEventForMiniProgram: function (properties) {
7. _ptagent_core.trackSharedEventForMiniProgram(properties);
8. }

/**
  * Track the shared event if you need, event name is defined by SDK
  * you just need to pass the event properties
  * @param properties: {}, the properties that you want to describe the event
  */
 PtTrackSharedEventForMiniProgram: function (properties) {
   _ptagent_core.trackSharedEventForMiniProgram(properties);
 }

1. /**
2. * You can invoke this method to mark the begin time for the defined event.
3. * @param eventName: String, this value can't be nil or empty
4. */
5. PtBeginEvent: function (eventName){
6. _ptagent_core.beginEvent(eventName);
7. }

/**
  * You can invoke this method to mark the begin time for the defined event.
  * @param eventName: String, this value can't be nil or empty
  */
 PtBeginEvent: function (eventName){
   _ptagent_core.beginEvent(eventName);
 }

1. /**
2. * Mark the end time for defined event, and send event package to server.
3. * You can specific the event properties for yourself at this moment.
4. * @param eventName: String, this value can't be nil or empty,
5. * and must be same with the value passed in PtBeginEvent()
6. * @param properties: {} or undefined.
7. */
8. PtEndEvent: function(eventName, properties){
9. _ptagent_core.endEvent(eventName, properties);}

/**
  * Mark the end time for defined event, and send event package to server.
  * You can specific the event properties for yourself at this moment.
  * @param eventName: String, this value can't be nil or empty,
  * and must be same with the value passed in PtBeginEvent()
  * @param properties: {} or undefined.
  */
 PtEndEvent: function(eventName, properties){
   _ptagent_core.endEvent(eventName, properties);}

1. /**
2. * Track the user info if you need, you can also pass the openid, union id by yourself.
3. * @param userID: String, the account info of your mini program.
4. * @param wxOpenID: String, openid that acquired from weixin.
5. * @param wxUnionID: String, unionid that acquired from weixin.
6. * @param userProfiles: {} or undefined, the other info of the account, such as, email, address...
7. */
8. PtTrackUserInfo: function(userID, wxOpenID, wxUnionID, userProfiles){
9. _ptagent_core.trackUserInfo(userID, wxOpenID, wxUnionID, userProfiles);
10. }

/**
  * Track the user info if you need, you can also pass the openid, union id by yourself.
  * @param userID: String, the account info of your mini program.
  * @param wxOpenID: String, openid that acquired from weixin.
  * @param wxUnionID: String, unionid that acquired from weixin.
  * @param userProfiles: {} or undefined, the other info of the account, such as, email, address...
  */
 PtTrackUserInfo: function(userID, wxOpenID, wxUnionID, userProfiles){
   _ptagent_core.trackUserInfo(userID, wxOpenID, wxUnionID, userProfiles);
 }

1. /**
2. * If you need to track some error info package, just invoke it.
3. * @param exceptionCode: String, error code that you want to defined.
4. * @param exceptionInfo: String, error or stack/heap info
5. */
6. PtTrackException: function (exceptionCode, exceptionInfo){
7. _ptagent_core.trackException(exceptionCode, exceptionInfo);
8. }

/**
  * If you need to track some error info package, just invoke it.
  * @param exceptionCode: String, error code that you want to defined.
  * @param exceptionInfo: String, error or stack/heap info
  */
 PtTrackException: function (exceptionCode, exceptionInfo){
   _ptagent_core.trackException(exceptionCode, exceptionInfo);
 }

1. /**
2. * For all the Page containers, we have already collected as "pv" data automatically,
3. * so you DON't need to invoke this API to collect the Page's "pv" data by youself,
4. * otherwise, pv data will be collected twice with the different name for one Page.
5. * But in some cases, you can invoke it to define a value as "pv" based on some bussiness for the other view containers (NOT Page), for example ...
6. * @param pageViewName: String page name, this value can't be empty and nil
7. * @param pageProperties: {} or undefined, you can pass some info as the properties for the Page
8. */
9. PtTrackPVForCustomView: function (pageViewName, pageProperties){
10. _ptagent_core.trackPVForCustomView(pageViewName, pageProperties);
11. }

/**
  * For all the Page containers, we have already collected as "pv" data automatically,
  * so you DON't need to invoke this API to collect the Page's "pv" data by youself,
  * otherwise, pv data will be collected twice with the different name for one Page.
  * But in some cases, you can invoke it to define a value as "pv" based on some bussiness for the other view containers (NOT Page), for example ...
  * @param pageViewName: String page name, this value can't be empty and nil
  * @param pageProperties: {} or undefined, you can pass some info as the properties for the Page
  */
 PtTrackPVForCustomView: function (pageViewName, pageProperties){
   _ptagent_core.trackPVForCustomView(pageViewName, pageProperties);
 }

1. /**
2. * Return PtAgent SDK version
3. */
4. PtSDKVersion: function(){
5. return _ptagent_core.getSDKVersion();
6. }

/**
  * Return PtAgent SDK version
  */
 PtSDKVersion: function(){
   return _ptagent_core.getSDKVersion();
 }

1. /**
2. * Enable PtAgent SDK log output.
3. */
4. PtEnableLogOutput: function(){
5. _ptagent_core.enableLogOutput();
6. }

/**
  * Enable PtAgent SDK log output.
  */
 PtEnableLogOutput: function(){
   _ptagent_core.enableLogOutput();
 }