{"_id":"58d0f45a7c58e80f00039fc7","project":"54aa7f773b56130b0056c86e","version":{"_id":"55781fe25129590d003ff4f7","project":"54aa7f773b56130b0056c86e","forked_from":"54aa7f773b56130b0056c871","__v":8,"createdAt":"2015-06-10T11:30:42.700Z","releaseDate":"2015-06-10T11:30:42.700Z","categories":["55781fe35129590d003ff4f8","55781fe35129590d003ff4f9","55781fe35129590d003ff4fa","55781fe35129590d003ff4fb","55781fe35129590d003ff4fc","55781fe35129590d003ff4fd","55781fe35129590d003ff4fe","564bbc7e8841060d00abb2ee","565b66c446118c0d00dcb0bb","56898269f8dc340d00308c13","582318b23b961a0f009516a1","594a848c9f4771001a43c959","5c73dd27e8fdc000572a206a","5c77ac5af94a920045cb80ca"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Developers","version_clean":"2.0.0","version":"2.0"},"category":{"_id":"55781fe35129590d003ff4fc","pages":["55781fe45129590d003ff50d","55781fe45129590d003ff50e","55781fe45129590d003ff50f","55781fe45129590d003ff510","55781fe45129590d003ff511","55781fe45129590d003ff512","55781fe45129590d003ff513","55781fe45129590d003ff514","55781fe45129590d003ff515","55781fe45129590d003ff516","55f692b4fe4cce21005c78b0","55f7e91e60cc850d008a7a45","56333cab9c607719001b85e4","564462ed9ce94c0d00068ce9","564f54fa48a1df1700836653","565ee9e7413e06170093dde0","5661a8fdb401c70d00dde6fa","5671348860c8e70d006c96a1","568ce9707d3bf02300aa7734"],"version":"55781fe25129590d003ff4f7","__v":10,"project":"54aa7f773b56130b0056c86e","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-01-05T12:44:00.338Z","from_sync":false,"order":4,"slug":"android-sdk","title":"Android SDK"},"user":"57bc3654b9c7f0220009c77b","__v":0,"githubsync":"","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-03-21T09:37:30.688Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"The *setPushNotificationEnabled(boolean enabled)* method allows you to easily opt in or opt out an user from Pulsate Push Notifications. This effects only pushes that Pulsate sends.\nBy default all users are opted into receiving push notifications.\n\nExample usage\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"manager.setPushNotificationEnabled(true); // Opt In\\nmanager.setPushNotificationEnabled(false); // Opt Out\",\n \"language\": \"java\"\n }\n ]\n}\n[/block]\nTo check if the current user is opt in or opt out of Push Notifications you can use the *isPushNotificationEnabled* method.\n\nWhen the push notification opt out is turned on, users who have opted out of push notifications will not receive any push notifications from Pulsate. This includes both Campaigns and Converse Messages. Users that have opted out of push notifications will still be able to receive In App Notifications and they will also receive campaign cards in the Pulsate feed, including any cards that are sent in push notification campaigns.\n\nIf you wish to retrieve a list of users that have opted out of push notifications, you can use the [Push Opt Outs: Get All](doc:push-opt-outs-get-all) API endpoint.","excerpt":"","slug":"push-notification-opt-in-opt-out-1","type":"basic","title":"Push Notification Opt In / Opt Out"}

FAQ

Resources

Push Notification Opt In / Opt Out

The *setPushNotificationEnabled(boolean enabled)* method allows you to easily opt in or opt out an user from Pulsate Push Notifications. This effects only pushes that Pulsate sends.
By default all users are opted into receiving push notifications.
Example usage
[block:code]
{
"codes": [
{
"code": "manager.setPushNotificationEnabled(true); // Opt In\nmanager.setPushNotificationEnabled(false); // Opt Out",
"language": "java"
}
]
}
[/block]
To check if the current user is opt in or opt out of Push Notifications you can use the *isPushNotificationEnabled* method.
When the push notification opt out is turned on, users who have opted out of push notifications will not receive any push notifications from Pulsate. This includes both Campaigns and Converse Messages. Users that have opted out of push notifications will still be able to receive In App Notifications and they will also receive campaign cards in the Pulsate feed, including any cards that are sent in push notification campaigns.
If you wish to retrieve a list of users that have opted out of push notifications, you can use the [Push Opt Outs: Get All](doc:push-opt-outs-get-all) API endpoint.