Repository URL to install this package:
|
Version:
1.1.1 ▾
|
Title: de-apprating-plugin Description: Dynamic Engine App Rating Plugin. Author: Vipera 2017
de-apprating-plugin API reference
- AppRating
- .initialize(domain, app, assetVersion, success, error)
- .startRating(success, error)
- .canRequireFeedback(success, error)
- .sendFeedbackWithMessage(message, rating, success, error)
- .declineRequest(type, success, error)
- .rateInStore(success, error)
- .isStoreReviewSupported(success, error)
- .updateFeedbackStatus(status, success, error)
- .getFeedbackStatus(success, error)
- .getApiModel(success, error)
- .setSessionInfo(userName, sessionId, success, error)
- .setTranslations(translations, success, error)
- .KeyValuePair : Object
AppRating
AppRating.initialize(domain, app, assetVersion, success, error)
This function initializes the plugin it must be called before any other method
Kind: static method of AppRating
| Param | Type | Description |
|---|---|---|
| domain | String | the current app Domain |
| app | String | the current app Name |
| assetVersion | String | the current assets version |
| success | function | A success callback function called on success |
| error | function | The error callback function called when the method fails |
AppRating.startRating(success, error)
This function starts the native rating UI
Kind: static method of AppRating
| Param | Type | Description |
|---|---|---|
| success | function | A success callback function called on success |
| error | function | The error callback function called when the method fails |
AppRating.canRequireFeedback(success, error)
This function returns TRUE if the feedback can be required to the user, FALSE otherwise (feedback already asked to the user)
Kind: static method of AppRating
| Param | Type | Description |
|---|---|---|
| success | function | A success callback function called on success |
| error | function | The error callback function called when the method fails |
AppRating.sendFeedbackWithMessage(message, rating, success, error)
This function sends a feedback to MOTIF
Kind: static method of AppRating
| Param | Type | Description |
|---|---|---|
| message | String | The user feedback message |
| rating | Number | The user feedback value (the number of stars) |
| success | function | A success callback function called on success |
| error | function | The error callback function called when the method fails |
AppRating.declineRequest(type, success, error)
Declines the feedback request and notifies MOTIF for decline
Kind: static method of AppRating
| Param | Type | Description |
|---|---|---|
| type | String | The current feedback type (admitted values are: (p)ositive , (n)egative, (u)nknown) |
| success | function | A success callback function called on success |
| error | function | The error callback function called when the method fails |
AppRating.rateInStore(success, error)
Launches the store app. For iOS only: if you want to use the in-app rating introduced by iOS 10.3 you can use optional param { inAppReview:true } if the OS does not support the in-app review, automatically the store will open
Kind: static method of AppRating
| Param | Type | Description |
|---|---|---|
| success | function | A success callback function called on success |
| error | function | The error callback function called when the method fails |
AppRating.isStoreReviewSupported(success, error)
For iOS only Indicates if the current platform supports in-app ratings dialog, i.e. calling LaunchReview.rating(). Will return true if current platform is iOS 10.3 or above. For Android platform always will return FALSE
Kind: static method of AppRating
| Param | Type | Description |
|---|---|---|
| success | function | A success callback function called on success |
| error | function | The error callback function called when the method fails |
AppRating.updateFeedbackStatus(status, success, error)
Update locally the current feddback status
Kind: static method of AppRating
| Param | Type | Description |
|---|---|---|
| status | String | New Status value (n)everAsked, (o)k, (d)eclined, (s)ent |
| success | function | A success callback function called on success |
| error | function | The error callback function called when the method fails |
AppRating.getFeedbackStatus(success, error)
Returns the current feddback status Status values are: (N)everAsked, (O)k, (D)eclined, (S)ent
Kind: static method of AppRating
| Param | Type | Description |
|---|---|---|
| success | function | A success callback function called on success |
| error | function | The error callback function called when the method fails |
AppRating.getApiModel(success, error)
Returns the current API Model used by this API
Kind: static method of AppRating
| Param | Type | Description |
|---|---|---|
| success | function | A success callback function called on success |
| error | function | The error callback function called when the method fails |
AppRating.setSessionInfo(userName, sessionId, success, error)
Set the session info
Kind: static method of AppRating
| Param | Type | Description |
|---|---|---|
| userName | String | The current userName |
| sessionId | String | The current session id |
| success | function | A success callback function called on success |
| error | function | The error callback function called when the method fails |
AppRating.setTranslations(translations, success, error)
Set native translations
Kind: static method of AppRating
| Param | Type | Description |
|---|---|---|
| translations | Array.<AppRating.KeyValuePair> | the transaltions array |
| success | function | A success callback function called on success |
| error | function | The error callback function called when the method fails |
AppRating.KeyValuePair : Object
A key,value pair object
Kind: static typedef of AppRating
Properties
| Name | Type | Description |
|---|---|---|
| key | string | the key |
| value | string | the value |