{"_id":"5c33ccdedd558f004bc56d31","project":"55e67aaa9cc7c62b00c4a1ea","version":{"_id":"5b720760c44b7600034b7a08","project":"55e67aaa9cc7c62b00c4a1ea","__v":0,"forked_from":"5b1f2cbdfd653400031d8d9f","createdAt":"2015-09-02T04:27:23.612Z","releaseDate":"2015-09-02T04:27:23.612Z","categories":["5b720760c44b7600034b79a7","5b720760c44b7600034b79a8","5b720760c44b7600034b79a9","5b720760c44b7600034b79aa","5b720760c44b7600034b79ab","561c61b4ad272c0d00a892df","586c014c0abf1d0f000d04d4","58991d2ad207df0f0002186b","5b720760c44b7600034b79ac","5b720760c44b7600034b79ad","5af0fe494ca2730003cbc98a","5af0fe55ec80af0003804ca2"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"API V6","version_clean":"1.4.0","version":"1.4"},"category":{"_id":"5b720760c44b7600034b79ac","project":"55e67aaa9cc7c62b00c4a1ea","__v":0,"version":"5b720760c44b7600034b7a08","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-02-08T21:31:11.878Z","from_sync":false,"order":6,"slug":"advanced-techniques","title":"Advanced Techniques"},"user":"5b0b7a46a26e6400036604fd","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-01-07T22:04:14.862Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":27,"body":"The push status is used to display whether push notifications can be sent to the given device, and how they will be displayed. As a rule of thumb, if the user has opted in banners, sounds and/or badges then the device will be push enabled. If they only want to receive notifications direct to the notification tray/notification center then the device will be push quiet enabled. If they have refused or have turned notifications off completely then the device will be push disabled:\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"State\",\n    \"h-1\": \"iOS Settings\",\n    \"h-2\": \"Android Settings\",\n    \"0-0\": \"Push Enabled\",\n    \"0-1\": \"Banners, sounds, badges and/or lock screen enabled\",\n    \"0-2\": \"At least one notification channel enabled with interrupting importance\",\n    \"1-0\": \"Push Quiet Enabled\",\n    \"1-1\": \"Notification Center only enabled\",\n    \"1-2\": \"All channels set to non-interrupting importance level\",\n    \"2-0\": \"Push Disabled\",\n    \"2-1\": \"Notifications off or all settings turned off\",\n    \"2-2\": \"Notifications off / no channels enabled\",\n    \"3-0\": \"Unknown\",\n    \"3-1\": \"Push notification authorization has not been requested\",\n    \"3-2\": \"N/A\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\nDevices in the device log have labels to indicate what push enabled state they are in. If there is no visible state label present then the device is push disabled.\n\n## Unknown\nThis state is iOS only and represents that the app has not requested any form of push notification authorization yet.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Note\",\n  \"body\": \"From iOS SDK version 8.2.0+, for devices running iOS 12+ the SDK will always request authorization of some kind so this state will be less common. This is due to the addition of provisional authorization in iOS 12.\"\n}\n[/block]\n## Push Disabled\nThis indicates that push notifications cannot be sent to the device.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/b347bba-Screen_Shot_2019-01-08_at_11.21.03_AM.png\",\n        \"Screen Shot 2019-01-08 at 11.21.03 AM.png\",\n        978,\n        60,\n        \"#dbe3eb\"\n      ],\n      \"caption\": \"No visible push enabled state\"\n    }\n  ]\n}\n[/block]\n### iOS\nIf the user has not accepted push notifications, permission has not been requested yet or the user has turned off notifications for the app completely then the device is considered push disabled.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/a5965a6-Screen_Shot_2019-01-08_at_10.55.37_AM.png\",\n        \"Screen Shot 2019-01-08 at 10.55.37 AM.png\",\n        680,\n        674,\n        \"#ececf4\"\n      ],\n      \"caption\": \"Notifications turned off in App Settings\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/f5ffb3d-Screen_Shot_2019-01-08_at_10.56.20_AM.png\",\n        \"Screen Shot 2019-01-08 at 10.56.20 AM.png\",\n        686,\n        356,\n        \"#ededf5\"\n      ],\n      \"caption\": \"Notifications turned off in Notifications Settings\"\n    }\n  ]\n}\n[/block]\n### Android\nIf the user has turned off push notifications for the app, or has disabled all notification channels then the device is considered push disabled.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/d36e928-Screen_Shot_2019-01-08_at_10.57.47_AM.png\",\n        \"Screen Shot 2019-01-08 at 10.57.47 AM.png\",\n        520,\n        230,\n        \"#fafafa\"\n      ],\n      \"caption\": \"Notifications turned off for app\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9caf15b-Screen_Shot_2019-01-08_at_10.58.25_AM.png\",\n        \"Screen Shot 2019-01-08 at 10.58.25 AM.png\",\n        524,\n        494,\n        \"#077d6f\"\n      ],\n      \"caption\": \"All channels disabled for app\"\n    }\n  ]\n}\n[/block]\n## Push Enabled\nThis indicates that push messages can be sent to the device and that the user has opted in to a certain level of interruption.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/0e8dbee-Screen_Shot_2019-01-08_at_11.22.33_AM.png\",\n        \"Screen Shot 2019-01-08 at 11.22.33 AM.png\",\n        977,\n        60,\n        \"#dbe2ea\"\n      ],\n      \"caption\": \"Push Enabled label\"\n    }\n  ]\n}\n[/block]\n### iOS\nIf the user has enabled alerts, badges, sounds or lock screen in the notification settings for the app then the app is considered fully push enabled. If the notifications are only allowed in the Notification Center, this will be considered Push Quiet Enabled.\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/fe382a2-Screen_Shot_2019-01-08_at_10.59.09_AM.png\",\n        \"Screen Shot 2019-01-08 at 10.59.09 AM.png\",\n        682,\n        590,\n        \"#ececf4\"\n      ],\n      \"caption\": \"Banners, Sounds and Badges enabled in App Settings\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/8a89bf4-Screen_Shot_2019-01-08_at_10.43.43_AM.png\",\n        \"Screen Shot 2019-01-08 at 10.43.43 AM.png\",\n        682,\n        1340,\n        \"#ebebf3\"\n      ],\n      \"caption\": \"Banners, Sounds and Badges enabled in Notification Settings\"\n    }\n  ]\n}\n[/block]\n### Android\nIf the user has at least one notification channel active in the app that is set to an importance level that will interrupt the user then it is considered fully push enabled.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/bc8e6fa-Screen_Shot_2019-01-08_at_11.18.37_AM.png\",\n        \"Screen Shot 2019-01-08 at 11.18.37 AM.png\",\n        522,\n        424,\n        \"#088071\"\n      ],\n      \"caption\": \"Notifications turned on and at least one channel enabled\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/31a98b2-Screen_Shot_2019-01-08_at_11.18.04_AM.png\",\n        \"Screen Shot 2019-01-08 at 11.18.04 AM.png\",\n        518,\n        582,\n        \"#f8f8f8\"\n      ],\n      \"caption\": \"Channel enabled with interrupting behaviour setting\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e1c16da-Screen_Shot_2019-01-08_at_11.11.26_AM.png\",\n        \"Screen Shot 2019-01-08 at 11.11.26 AM.png\",\n        522,\n        700,\n        \"#626262\"\n      ],\n      \"caption\": \"Interrupting behaviour set for notification channel\"\n    }\n  ]\n}\n[/block]\n## Push Quiet Enabled\nThis setting indicates that push notifications can be sent to the device but that the user has opted out of interrupting behaviour. It will appear in a minimal way but will not be presented in a banner and will not make sounds or update badges.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/cef6b29-Screen_Shot_2019-01-22_at_12.08.03_PM.png\",\n        \"Screen Shot 2019-01-22 at 12.08.03 PM.png\",\n        920,\n        60,\n        \"#dae2ea\"\n      ]\n    }\n  ]\n}\n[/block]\n### iOS\nIf the app has only requested provisional permission to use push notifications, or the user has set the notifications to only appear in the notification center (Quiet mode) then this device is considered Push Quiet Enabled.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/64efbb5-Screen_Shot_2019-01-08_at_11.08.11_AM.png\",\n        \"Screen Shot 2019-01-08 at 11.08.11 AM.png\",\n        682,\n        630,\n        \"#ececf4\"\n      ],\n      \"caption\": \"Deliver Quietly in App Settings\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/522a5da-Screen_Shot_2019-01-08_at_11.10.01_AM.png\",\n        \"Screen Shot 2019-01-08 at 11.10.01 AM.png\",\n        680,\n        1134,\n        \"#ebebf3\"\n      ],\n      \"caption\": \"Notification Center only enabled in Notification Settings\"\n    }\n  ]\n}\n[/block]\n### Android\nIf the user sets all of the enabled notification channels to a non-interrupting importance level then this device is considered Push Quiet Enabled.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/273f60a-Screen_Shot_2019-01-08_at_11.13.56_AM.png\",\n        \"Screen Shot 2019-01-08 at 11.13.56 AM.png\",\n        520,\n        466,\n        \"#078172\"\n      ],\n      \"caption\": \"Notifications turned on and at least one channel enabled\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/f79c40e-Screen_Shot_2019-01-08_at_11.14.21_AM.png\",\n        \"Screen Shot 2019-01-08 at 11.14.21 AM.png\",\n        520,\n        608,\n        \"#f8f8f8\"\n      ],\n      \"caption\": \"Channel enabled with non-interrupting behaviour\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/b7bc6aa-Screen_Shot_2019-01-08_at_11.14.55_AM.png\",\n        \"Screen Shot 2019-01-08 at 11.14.55 AM.png\",\n        528,\n        750,\n        \"#626262\"\n      ],\n      \"caption\": \"Non-interrupting behaviour set for channel\"\n    }\n  ]\n}\n[/block]","excerpt":"Breakdown of the push status values for devices in the log","slug":"push-enabled-state","type":"basic","title":"Push Status"}

Push Status

Breakdown of the push status values for devices in the log

The push status is used to display whether push notifications can be sent to the given device, and how they will be displayed. As a rule of thumb, if the user has opted in banners, sounds and/or badges then the device will be push enabled. If they only want to receive notifications direct to the notification tray/notification center then the device will be push quiet enabled. If they have refused or have turned notifications off completely then the device will be push disabled: [block:parameters] { "data": { "h-0": "State", "h-1": "iOS Settings", "h-2": "Android Settings", "0-0": "Push Enabled", "0-1": "Banners, sounds, badges and/or lock screen enabled", "0-2": "At least one notification channel enabled with interrupting importance", "1-0": "Push Quiet Enabled", "1-1": "Notification Center only enabled", "1-2": "All channels set to non-interrupting importance level", "2-0": "Push Disabled", "2-1": "Notifications off or all settings turned off", "2-2": "Notifications off / no channels enabled", "3-0": "Unknown", "3-1": "Push notification authorization has not been requested", "3-2": "N/A" }, "cols": 3, "rows": 4 } [/block] Devices in the device log have labels to indicate what push enabled state they are in. If there is no visible state label present then the device is push disabled. ## Unknown This state is iOS only and represents that the app has not requested any form of push notification authorization yet. [block:callout] { "type": "info", "title": "Note", "body": "From iOS SDK version 8.2.0+, for devices running iOS 12+ the SDK will always request authorization of some kind so this state will be less common. This is due to the addition of provisional authorization in iOS 12." } [/block] ## Push Disabled This indicates that push notifications cannot be sent to the device. [block:image] { "images": [ { "image": [ "https://files.readme.io/b347bba-Screen_Shot_2019-01-08_at_11.21.03_AM.png", "Screen Shot 2019-01-08 at 11.21.03 AM.png", 978, 60, "#dbe3eb" ], "caption": "No visible push enabled state" } ] } [/block] ### iOS If the user has not accepted push notifications, permission has not been requested yet or the user has turned off notifications for the app completely then the device is considered push disabled. [block:image] { "images": [ { "image": [ "https://files.readme.io/a5965a6-Screen_Shot_2019-01-08_at_10.55.37_AM.png", "Screen Shot 2019-01-08 at 10.55.37 AM.png", 680, 674, "#ececf4" ], "caption": "Notifications turned off in App Settings" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/f5ffb3d-Screen_Shot_2019-01-08_at_10.56.20_AM.png", "Screen Shot 2019-01-08 at 10.56.20 AM.png", 686, 356, "#ededf5" ], "caption": "Notifications turned off in Notifications Settings" } ] } [/block] ### Android If the user has turned off push notifications for the app, or has disabled all notification channels then the device is considered push disabled. [block:image] { "images": [ { "image": [ "https://files.readme.io/d36e928-Screen_Shot_2019-01-08_at_10.57.47_AM.png", "Screen Shot 2019-01-08 at 10.57.47 AM.png", 520, 230, "#fafafa" ], "caption": "Notifications turned off for app" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/9caf15b-Screen_Shot_2019-01-08_at_10.58.25_AM.png", "Screen Shot 2019-01-08 at 10.58.25 AM.png", 524, 494, "#077d6f" ], "caption": "All channels disabled for app" } ] } [/block] ## Push Enabled This indicates that push messages can be sent to the device and that the user has opted in to a certain level of interruption. [block:image] { "images": [ { "image": [ "https://files.readme.io/0e8dbee-Screen_Shot_2019-01-08_at_11.22.33_AM.png", "Screen Shot 2019-01-08 at 11.22.33 AM.png", 977, 60, "#dbe2ea" ], "caption": "Push Enabled label" } ] } [/block] ### iOS If the user has enabled alerts, badges, sounds or lock screen in the notification settings for the app then the app is considered fully push enabled. If the notifications are only allowed in the Notification Center, this will be considered Push Quiet Enabled. [block:image] { "images": [ { "image": [ "https://files.readme.io/fe382a2-Screen_Shot_2019-01-08_at_10.59.09_AM.png", "Screen Shot 2019-01-08 at 10.59.09 AM.png", 682, 590, "#ececf4" ], "caption": "Banners, Sounds and Badges enabled in App Settings" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/8a89bf4-Screen_Shot_2019-01-08_at_10.43.43_AM.png", "Screen Shot 2019-01-08 at 10.43.43 AM.png", 682, 1340, "#ebebf3" ], "caption": "Banners, Sounds and Badges enabled in Notification Settings" } ] } [/block] ### Android If the user has at least one notification channel active in the app that is set to an importance level that will interrupt the user then it is considered fully push enabled. [block:image] { "images": [ { "image": [ "https://files.readme.io/bc8e6fa-Screen_Shot_2019-01-08_at_11.18.37_AM.png", "Screen Shot 2019-01-08 at 11.18.37 AM.png", 522, 424, "#088071" ], "caption": "Notifications turned on and at least one channel enabled" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/31a98b2-Screen_Shot_2019-01-08_at_11.18.04_AM.png", "Screen Shot 2019-01-08 at 11.18.04 AM.png", 518, 582, "#f8f8f8" ], "caption": "Channel enabled with interrupting behaviour setting" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/e1c16da-Screen_Shot_2019-01-08_at_11.11.26_AM.png", "Screen Shot 2019-01-08 at 11.11.26 AM.png", 522, 700, "#626262" ], "caption": "Interrupting behaviour set for notification channel" } ] } [/block] ## Push Quiet Enabled This setting indicates that push notifications can be sent to the device but that the user has opted out of interrupting behaviour. It will appear in a minimal way but will not be presented in a banner and will not make sounds or update badges. [block:image] { "images": [ { "image": [ "https://files.readme.io/cef6b29-Screen_Shot_2019-01-22_at_12.08.03_PM.png", "Screen Shot 2019-01-22 at 12.08.03 PM.png", 920, 60, "#dae2ea" ] } ] } [/block] ### iOS If the app has only requested provisional permission to use push notifications, or the user has set the notifications to only appear in the notification center (Quiet mode) then this device is considered Push Quiet Enabled. [block:image] { "images": [ { "image": [ "https://files.readme.io/64efbb5-Screen_Shot_2019-01-08_at_11.08.11_AM.png", "Screen Shot 2019-01-08 at 11.08.11 AM.png", 682, 630, "#ececf4" ], "caption": "Deliver Quietly in App Settings" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/522a5da-Screen_Shot_2019-01-08_at_11.10.01_AM.png", "Screen Shot 2019-01-08 at 11.10.01 AM.png", 680, 1134, "#ebebf3" ], "caption": "Notification Center only enabled in Notification Settings" } ] } [/block] ### Android If the user sets all of the enabled notification channels to a non-interrupting importance level then this device is considered Push Quiet Enabled. [block:image] { "images": [ { "image": [ "https://files.readme.io/273f60a-Screen_Shot_2019-01-08_at_11.13.56_AM.png", "Screen Shot 2019-01-08 at 11.13.56 AM.png", 520, 466, "#078172" ], "caption": "Notifications turned on and at least one channel enabled" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/f79c40e-Screen_Shot_2019-01-08_at_11.14.21_AM.png", "Screen Shot 2019-01-08 at 11.14.21 AM.png", 520, 608, "#f8f8f8" ], "caption": "Channel enabled with non-interrupting behaviour" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/b7bc6aa-Screen_Shot_2019-01-08_at_11.14.55_AM.png", "Screen Shot 2019-01-08 at 11.14.55 AM.png", 528, 750, "#626262" ], "caption": "Non-interrupting behaviour set for channel" } ] } [/block]