OneSignal InApp Messages¶
Non-Visible component| Category | Requires | Version |
|---|---|---|
| Social | API 21, Android 5.0 Lollipop | 1 |
Overview¶
A non-visible component for displaying and controlling in-app messages sent remotely using OneSignal. In-app messages are customizable, targeted messages that display within your mobile app.
Permissions
- com.sonyericsson.home.permission.BROADCAST_BADGE
- com.htc.launcher.permission.READ_SETTINGS
- android.permission.FOREGROUND_SERVICE
- android.permission.RECEIVE_BOOT_COMPLETED
- com.huawei.android.launcher.permission.WRITE_SETTINGS
- me.everything.badger.permission.BADGE_COUNT_READ
- com.sec.android.provider.badge.permission.WRITE
- com.sec.android.provider.badge.permission.READ
- android.permission.ACCESS_NETWORK_STATE
- android.permission.WAKE_LOCK
- com.anddoes.launcher.permission.UPDATE_COUNT
- android.permission.POST_NOTIFICATIONS
- com.google.android.c2dm.permission.RECEIVE
- com.oppo.launcher.permission.WRITE_SETTINGS
- android.permission.READ_APP_BADGE
- %packageName%.permission.C2D_MESSAGE
- android.permission.VIBRATE
- com.huawei.android.launcher.permission.CHANGE_BADGE
- com.majeur.launcher.permission.UPDATE_BADGE
- com.sonymobile.home.permission.PROVIDER_INSERT_BADGE
- com.htc.launcher.permission.UPDATE_SHORTCUT
- android.permission.INTERNET
- com.huawei.android.launcher.permission.READ_SETTINGS
- me.everything.badger.permission.BADGE_COUNT_WRITE
- com.oppo.launcher.permission.READ_SETTINGS
Events¶
Message Clicked¶
Called when the message is clicked.
| Params | |
|---|---|
| message ID | Text |
| action ID | Text |
| url | Text |
| is Closing Message | Boolean |
Message Did Dismiss¶
Called after an in-app message has been dismissed.
| Params | |
|---|---|
| message ID | Text |
Message Did Display¶
Called after an in-app message has finished displaying.
| Params | |
|---|---|
| message ID | Text |
Message Will Dismiss¶
Called right before an in-app message is dismissed.
| Params | |
|---|---|
| message ID | Text |
Message Will Display¶
Called right before an in-app message is displayed.
| Params | |
|---|---|
| message ID | Text |
Methods¶
Add Trigger¶
Adds a new trigger with provided key-value pair for the current user.
| Params | |
|---|---|
| key | Text |
| value | Text |
Remove Trigger¶
Removes the trigger with provided key for the current user.
| Params | |
|---|---|
| key | Text |
Properties¶
Pause InApp Messages¶
Boolean 
Write - Blocks
Prevent In-app messages from being displayed to the user. When set to true, no in-app messages will be presented. When set to false, any messages the user qualifies for will be presented to them at the appropriate time.