joe/kami-parse-server
Public Access
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Adds documentations for adapters and main constructors (#4951)

Browse Source 
* wip

* Adds documentations for adapters, and constructors

* nits

* nit
This commit is contained in:
Florent Vilmart
2018-08-10 15:51:31 -04:00
parent 0571675fcd
commit 942b9b5b1a
17 changed files with 3316 additions and 2708 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/Adapters/Analytics/AnalyticsAdapter.js
View File

@@ -1,18 +1,24 @@
/*eslint no-unused-vars: "off"*/
/**
* @module Adapters
*/
/**
* @interface AnalyticsAdapter
*/
export class AnalyticsAdapter {
/*
@param parameters: the analytics request body, analytics info will be in the dimensions property
@param req: the original http request
/**
@param {any} parameters: the analytics request body, analytics info will be in the dimensions property
@param {Request} req: the original http request
*/
appOpened(parameters, req) {
return Promise.resolve({});
}
/*
@param eventName: the name of the custom eventName
@param parameters: the analytics request body, analytics info will be in the dimensions property
@param req: the original http request
/**
@param {String} eventName: the name of the custom eventName
@param {any} parameters: the analytics request body, analytics info will be in the dimensions property
@param {Request} req: the original http request
*/
trackEvent(eventName, parameters, req) {
return Promise.resolve({});