-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat(pollfish): add Pollfish plugin * docs(pollfish): update import example Co-authored-by: Daniel Sogl <[email protected]>
- Loading branch information
1 parent
104cad1
commit 8a00ccc
Showing
1 changed file
with
170 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,170 @@ | ||
import { Injectable } from '@angular/core'; | ||
import { Plugin, Cordova, CordovaProperty, IonicNativePlugin } from '@ionic-native/core'; | ||
|
||
/** | ||
* @name Pollfish | ||
* @description | ||
* Pollfish Ionic Native plugin wrapper | ||
* | ||
* @usage | ||
* ```typescript | ||
* import { Pollfish } from '@ionic-native/pollfish/ngx'; | ||
* | ||
* | ||
* constructor(private pollfish: Pollfish) { } | ||
* | ||
* ... | ||
* | ||
* this.pollfish.init(false, false, 'YOUR_API_KEY', 1, 8, 'REQUEST_UUID', false); | ||
* | ||
* this.pollfish.initWithUserAttributes(false, false, 'YOUR_API_KEY', 1, 8, 'REQUEST_UUID', false, { | ||
* 'gender': '1', | ||
* ... | ||
* }); | ||
* | ||
* this.pollfish.showPollfish(); | ||
* | ||
* this.pollfish.hidePollfish(); | ||
* | ||
* // Event Listeners | ||
* | ||
* this.pollfish.setEventCallback(pollfish.EventListener.OnPollfishSurveyReceived, (surveyInfo) => { | ||
* console.log("Survey Received: " + JSON.stringify(surveyInfo)); | ||
* }); | ||
* | ||
* this.pollfish.setEventCallback(pollfish.EventListener.OnPollfishSurveyCompleted, (result) => { | ||
* console.log("Survey Completed: " + JSON.stringify(surveyInfo)); | ||
* }); | ||
* | ||
* this.pollfish.setEventCallback(pollfish.EventListener.OnPollfishUserNotEligible, (_) => { | ||
* console.log("Pollfish User Not Eligible"); | ||
* }); | ||
* | ||
* this.pollfish.setEventCallback(pollfish.EventListener.OnPollfishSurveyNotAvailable, (_) => { | ||
* console.log("Pollfish Survey not available"); | ||
* }); | ||
* | ||
* this.pollfish.setEventCallback(pollfish.EventListener.OnPollfishOpened, (_) => { | ||
* console.log("Pollfish Survey panel is open"); | ||
* }); | ||
* | ||
* this.pollfish.setEventCallback(pollfish.EventListener.OnPollfishClosed, (_) => { | ||
* console.log("Pollfish Survey panel is closed"); | ||
* }); | ||
* | ||
* this.pollfish.setEventCallback(pollfish.EventListener.OnPollfishUserRejectedSurvey, (_) => { | ||
* console.log("Pollfish User Rejected Survey"); | ||
* }); | ||
* | ||
* ``` | ||
*/ | ||
@Plugin({ | ||
pluginName: 'Pollfish', | ||
plugin: 'com.pollfish.cordova_plugin', | ||
pluginRef: 'pollfishplugin', | ||
repo: 'https://github.com/pollfish/cordova-plugin-pollfish', | ||
platforms: ['Android', 'iOS'], | ||
}) | ||
@Injectable() | ||
export class Pollfish extends IonicNativePlugin { | ||
@CordovaProperty() | ||
EventListener: { | ||
OnPollfishClosed: string; | ||
OnPollfishOpened: string; | ||
OnPollfishSurveyReceived: string; | ||
OnPollfishSurveyCompleted: string; | ||
OnPollfishUserNotEligible: string; | ||
OnPollfishUserRejectedSurvey: string; | ||
OnPollfishSurveyNotAvailable: string; | ||
}; | ||
|
||
@CordovaProperty() | ||
Position: { | ||
TOP_LEFT: number; | ||
TOP_RIGHT: number; | ||
MIDDLE_LEFT: number; | ||
MIDDLE_RIGHT: number; | ||
BOTTOM_LEFT: number; | ||
BOTTOM_RIGHT: number; | ||
}; | ||
|
||
/** | ||
* Function to init Pollfish | ||
* @param releaseMode {boolean} | ||
* @param rewardMode {boolean} | ||
* @param apiKey {string} | ||
* @param position {number} | ||
* @param padding {number} | ||
* @param requestUUID {string} | ||
* @param offerwallMode {boolean} | ||
*/ | ||
@Cordova() | ||
init( | ||
releaseMode: boolean, | ||
rewardMode: boolean, | ||
apiKey: string, | ||
position: number, | ||
padding: number, | ||
requestUUID: string, | ||
offerwallMode: boolean | ||
): any { | ||
return; | ||
} | ||
|
||
/** | ||
* Function to init Pollfish with user attributes | ||
* @param releaseMode {boolean} | ||
* @param rewardMode {boolean} | ||
* @param apiKey {string} | ||
* @param position {number} | ||
* @param padding {number} | ||
* @param requestUUID {string} | ||
* @param offerwallMode {boolean} | ||
* @param userAttributes {Json} | ||
*/ | ||
|
||
@Cordova() | ||
initWithUserAttributes( | ||
releaseMode: boolean, | ||
rewardMode: boolean, | ||
apiKey: string, | ||
position: number, | ||
padding: number, | ||
requestUUID: string, | ||
offerwallMode: boolean, | ||
userAttributes: {} | ||
) { | ||
return; | ||
} | ||
|
||
/** | ||
* Function to manually show Pollfish | ||
*/ | ||
|
||
@Cordova() | ||
showPollfish() { | ||
return; | ||
} | ||
|
||
/** | ||
* Function to manually hide Pollfish | ||
*/ | ||
|
||
@Cordova() | ||
hidePollfish() { | ||
return; | ||
} | ||
|
||
/** | ||
* Function to set event callbacks | ||
* @param eventName | ||
* @param callback | ||
*/ | ||
|
||
@Cordova({ | ||
sync: true, | ||
}) | ||
setEventCallback(eventName: string, callback: (info?: any) => void) { | ||
return; | ||
} | ||
} |