Push Notifications¶
Non-Visible componentCategory | Requires | Version |
---|---|---|
Social | API 21, Android 5.0 Lollipop | 6 |
Overview¶
A non-visible component that remotely sends notifications to the device.
Powered by OneSignal.
Permissions
- android.permission.READ_APP_BADGE
- com.sonyericsson.home.permission.BROADCAST_BADGE
- com.htc.launcher.permission.READ_SETTINGS
- android.permission.VIBRATE
- com.huawei.android.launcher.permission.CHANGE_BADGE
- android.permission.RECEIVE_BOOT_COMPLETED
- com.huawei.android.launcher.permission.WRITE_SETTINGS
- com.majeur.launcher.permission.UPDATE_BADGE
- com.sonymobile.home.permission.PROVIDER_INSERT_BADGE
- com.htc.launcher.permission.UPDATE_SHORTCUT
- me.everything.badger.permission.BADGE_COUNT_READ
- android.permission.INTERNET
- 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
- com.huawei.android.launcher.permission.READ_SETTINGS
- com.google.android.c2dm.permission.RECEIVE
- com.oppo.launcher.permission.WRITE_SETTINGS
- me.everything.badger.permission.BADGE_COUNT_WRITE
- com.oppo.launcher.permission.READ_SETTINGS
Events¶
Got Available Tags¶
Event to detect available one signal tags.
Params | |
---|---|
tags As String | Text |
tags As List | List |
Got Value¶
Event to receive value for a tag.
Params | |
---|---|
tag | Text |
value | Text |
Notification Opened¶
User opened a notification.
Params | |
---|---|
id | Text |
title | Text |
message | Text |
Notification Received¶
User received a notification.
Params | |
---|---|
id | Text |
title | Text |
message | Text |
Send Message Done¶
Returns true if your message was send with success out of your app to all users.
Params | |
---|---|
success | Boolean |
Methods¶
Clear All Notifications¶
Clear All Notifications.
Delete Tag¶
Deletes a single tag that was previously set on a user.
Params | |
---|---|
key | Text |
Get Available Tags¶
Get a list of available tags.
Get Value¶
Get value for tag.
Params | |
---|---|
tag | Text |
value If Tag Not There | Text |
Send Message¶
Send a message to all users. The message and your REST Api Key can not be empty! You will find your REST Api Key in your OneSignal account settings.
Params | |
---|---|
title | Text |
message | Text |
rest API Key | Text |
Send Tag¶
Tag a user based on an app event of your choosing so later you can create segments in to target these users.
Params | |
---|---|
key | Text |
value | Text |
Properties¶
Enable Log¶
Boolean Write - Blocks
If you want to enable the log then set it to true.
Enable Sound¶
Boolean Write - Blocks
Enable Sound.
Enable Vibration¶
Boolean Write - Blocks
Enable Vibration.
Get Email Subscription Email Address¶
Text Read - Blocks
Get the email subscription email address.
Get Email Subscription User Id¶
Text Read - Blocks
Get the email subscription user id.
Get Permission Status¶
Boolean Read - Blocks
Get Permission Status
Get Subscription Status¶
Boolean Read - Blocks
Get the subscription Status
Get User Id¶
Text Read - Blocks
Get the User ID. If there is no user id it will return '-1'.
OneSignal App ID¶
Text Write - Designer
Set here your One Signal App ID
Set Subscription¶
Boolean Write - Blocks
If you want to subscribe then set it to true.