API References 🚫
Important Announcement
AppsOnAir will soon be discontinued and replaced by the new AppSync integration, offering enhanced features and performance.
For the latest updates and more details, please refer to the "AppSync Guide".
By calling checkForAppUpdate method you will get response object as mentioned in below tables, using this reference properties user can customize alert for an app updates and maintenance dialogues.
properties​
| prop | default | type | Description |
|---|---|---|---|
| appName | "" | string | Application name |
| appLogo | null | string | Application logo |
| id | "" | string | Application id |
| isMaintenance | false | boolean | if true, show maintenance dialog using below maintenance props |
Maintenance props​
| prop | default | type | Description |
|---|---|---|---|
| title | "" | string | Show as title |
| image | null | string | Show image url |
| description | "" | string | Show as description |
| textColorCode | "" | string | Color code for text color |
| backgroundColorCode | "" | string | Color code for background color |
Android props​
| prop | default | type | Description |
|---|---|---|---|
| isAndroidUpdate | false | boolean | if true, Show Update dialog with option |
| androidBuildNumber | null | string | Android build number |
| androidMinBuildVersion | null | string | Android build VersionCode |
| androidUpdateLink | null | string | redirect to link ed: playstore |
| isAndroidForcedUpdate | false | boolean | if true, show force-fully update dialog |
iOS props​
| prop | default | type | Description |
|---|---|---|---|
| isIOSUpdate | false | boolean | if true, Show Update dialog |
| iosBuildNumber | false | string | iOS build number |
| iosMinBuildVersion | false | string | iOs build version code |
| iosUpdateLink | null | url | it will redirect to particular url |
| isIOSForcedUpdate | false | boolean | if true, show force-fully update dialog |