feat(lets-cooee): add event observer and installation documentation (#4278)
* feat(Cooee): add Cooee plugin * chore(Cooee): update document * Update index.ts * feat(lets-cooee): add event observable * docs(lets-cooee): add lets-cooee documentation Co-authored-by: Daniel Sogl <daniel@sogls.de>
This commit is contained in:
parent
a801c7d305
commit
aef160e418
38
docs/plugins/lets-cooee/README.md
Normal file
38
docs/plugins/lets-cooee/README.md
Normal file
@ -0,0 +1,38 @@
|
|||||||
|
# Ionic Plugin for Cooee SDK
|
||||||
|
|
||||||
|
## What is Cooee?
|
||||||
|
|
||||||
|
Let’s Cooee powers hyper-personalized and real time engagements for mobile apps based on machine learning. The SaaS platform, hosted on
|
||||||
|
cloud infrastructure processes millions of user transactions and data attributes to create unique and contextual user engagement
|
||||||
|
triggers for end users with simple SDK integration that requires no coding at mobile app level.
|
||||||
|
|
||||||
|
For more information visit our [website](https://www.letscooee.com/) and [documentation](https://docs.letscooee.com/developers/cordova/quickstart).
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
1. Plug and Play - Plugin is plug and play for mobile applications. That means it needs to be initialized with the Application Context, and it
|
||||||
|
will work automatically in the background.
|
||||||
|
2. Independent of Application - Plugin is independent of the application. It will collect data points with zero interference from/to the
|
||||||
|
applications. Although applications can send additional data points (if required) to the Plugin using API’s.
|
||||||
|
3. Rendering engagement triggers - Plugin will render the campaign trigger at real-time with the help of server http calls.
|
||||||
|
|
||||||
|
## Platforms
|
||||||
|
|
||||||
|
- Android (Minimum Android 5.0 / API level 21)
|
||||||
|
- iOS (Minimum deployment target iOS 13)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```
|
||||||
|
$ ionic cordova plugin add @letscooee/cordova-plugin --variable COOEE_APP_ID="MY_COOEE_APP_ID"
|
||||||
|
$ npm install @awesome-cordova-plugins/lets-cooee
|
||||||
|
```
|
||||||
|
Replace `MY_COOEE_APP_ID` with the `App ID` which is present at [Cooee Portal](https://dashboard.letscooee.com/app/details).
|
||||||
|
|
||||||
|
## Usage Documentation
|
||||||
|
|
||||||
|
For detailed installation & uses, Refer [Cordova](https://docs.letscooee.com/developers/cordova/quickstart) documentation.
|
||||||
|
|
||||||
|
Plugin Repo: [https://github.com/letscooee/cordova-plugin-cooee](https://github.com/letscooee/cordova-plugin-cooee)
|
||||||
|
|
||||||
|
Requires Cordova plugin: `@letscooee/cordova-plugin` [](https://www.npmjs.com/package/@letscooee/cordova-plugin).
|
@ -1,5 +1,6 @@
|
|||||||
import { Injectable } from '@angular/core';
|
import { Injectable } from '@angular/core';
|
||||||
import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-plugins/core';
|
import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-plugins/core';
|
||||||
|
import { Observable } from 'rxjs';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @name Lets Cooee
|
* @name Lets Cooee
|
||||||
@ -72,4 +73,17 @@ export class Cooee extends AwesomeCordovaNativePlugin {
|
|||||||
getUserID(): Promise<any> {
|
getUserID(): Promise<any> {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides callback for the onCooeeCTAListener event.
|
||||||
|
* @return {Observable<Any>} Returns an observable record.
|
||||||
|
*/
|
||||||
|
@Cordova({
|
||||||
|
eventObservable: true,
|
||||||
|
event: 'onCooeeCTAListener',
|
||||||
|
element: document,
|
||||||
|
})
|
||||||
|
addCooeeCTAListener(): Observable<any> {
|
||||||
|
return;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user