-
Notifications
You must be signed in to change notification settings - Fork 60
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #25 from Karn/develop
- Loading branch information
Showing
24 changed files
with
170 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,104 @@ | ||
| ## Advanced Usage | ||
| > **Note:** This page is still a work-in-progress. You can help complete the documentation by contributing to the project. | ||
| #### NOTIFICATION ANATOMY | ||
|
|
||
|  | ||
|
|
||
| | ID | Name | Description | | ||
| | --- | --- | --- | | ||
| | 1 | Icon | Set using the `Header#icon` field. | | ||
| | 2 | App Name | Application name, immutable. | | ||
| | 3 | Header Text | Optional description text. Set using the `Header#headerText` field. | | ||
| | 4 | Timestamp | Timestamp of the notification. | | ||
| | 5 | Expand Icon | Indicates that the notification is expandable. | | ||
| | 6 | Content | The "meat" of the notification set using of of the `NotifyCreator#as[Type]((Type) -> Unit)` scoped functions. | | ||
| | 7 | Actions | Set using the `NotifyCreator#actions((ArrayList<Action>) -> Unit)` scoped function. | | ||
|
|
||
| #### RESPONDING TO CLICKS | ||
| The `Payload.Meta` object provides `clickIntent` and `clearIntent` members which when not `null` will be fired when clicked or dismissed. | ||
|
|
||
| The `Payload.Meta` object provides `clickIntent` and `clearIntent` members which when not `null`, will be fired when clicked or dismissed. | ||
|
|
||
| ```Kotlin | ||
| Notify | ||
| .with(context) | ||
| .meta { // this: Payload.Meta | ||
| // Launch the MainActivity once the notification is clicked. | ||
| clickIntent = PendingIntent.getActivity(this@MainActivity, | ||
| 0, | ||
| Intent(this@MainActivity, MainActivity::class.java), | ||
| 0) | ||
| // Start a service which clears the badge count once the notification is dismissed. | ||
| clearIntent = PendingIntent.getService(this@MainActivity, | ||
| 0, | ||
| Intent(this@MainActivity, MyNotificationService::class.java) | ||
| .putExtra("action", "clear_badges"), | ||
| 0) | ||
| } | ||
| .content { // this: Payload.Content.Default | ||
| title = "New dessert menu" | ||
| text = "The Cheesecake Factory has a new dessert for you to try!" | ||
| } | ||
| .show() | ||
| ``` | ||
|
|
||
|
|
||
| #### ACTIONS | ||
|
|
||
| Similarly, we can construct actions which can be used to quickly perform tasks without opening your app. The actions are the collection of buttons that are shown below the notification to quickly perform tasks. | ||
|
|
||
| ```Kotlin | ||
| Notify | ||
| .with(context) | ||
| .content { // this: Payload.Content.Default | ||
| title = "New dessert menu" | ||
| text = "The Cheesecake Factory has a new dessert for you to try!" | ||
| } | ||
| .actions { // this: ArrayList<Action> | ||
| add(Action( | ||
| // The icon corresponding to the action. | ||
| R.drawable.ic_app_icon, | ||
| // The text corresponding to the action -- this is what shows . | ||
| "Clear", | ||
| // Swap this PendingIntent for whatever Intent is to be processed when the action is clicked. | ||
| PendingIntent.getService(this@MainActivity, | ||
| 0, | ||
| Intent(this@MainActivity, MyNotificationService::class.java) | ||
| .putExtra("action", "clear_badges"), | ||
| 0) | ||
| )) | ||
| } | ||
| .show() | ||
| ``` | ||
|
|
||
|
|
||
| #### STACKABLE NOTIFICATIONS | ||
|
|
||
| #### ACTIONS | ||
| Notify provides a solution to the idea of grouping notifications into a "stack". I.e the notifications are grouped into a single notification when there is more than one of the same type as defined by `stackable.key`. | ||
| This is a particularly effective method of reducing the clutter of the notification tray while also providing the relevant information. | ||
|
|
||
| ```Kotlin | ||
| Notify | ||
| .with(this) | ||
| .content { // this: Payload.Content.Default | ||
| title = "New dessert menu" | ||
| text = "The Cheesecake Factory has a new dessert for you to try!" | ||
| } | ||
| // Define the notification as being stackable. This block should be the same for all notifications which | ||
| // are to be grouped together. | ||
| .stackable { // this: Payload.Stackable | ||
| // In particular, this key should be the same. The properties of this stackable notification as | ||
| // taken from the latest stackable notification's stackable block. | ||
| key = "test_key" | ||
| // This is the summary of this notification as it appears when it is as part of a stacked notification. This | ||
| // String value is what is shown as a single line in the stacked notification. | ||
| summaryContent = "test summary content" | ||
| // The number of notifications with the same key is passed as the 'count' argument. We happen not to | ||
| // use it, but it is there if needed. | ||
| summaryTitle = { count -> "Summary title" } | ||
| // ... here as well, but we instead choose to use to to update the summary for when the notification | ||
| // is collapsed. | ||
| summaryDescription = { count -> count.toString() + " new notifications." } | ||
| } | ||
| .show() | ||
| ``` |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| #Sun Dec 30 15:40:11 BRST 2018 | ||
| distributionBase=GRADLE_USER_HOME | ||
| distributionPath=wrapper/dists | ||
| distributionUrl=https\://services.gradle.org/distributions/gradle-4.6-bin.zip | ||
| zipStoreBase=GRADLE_USER_HOME | ||
| zipStorePath=wrapper/dists | ||
| distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.2-all.zip |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| package io.karn.notify.internal.utils | ||
|
|
||
| import android.support.v4.app.NotificationCompat | ||
| import androidx.core.app.NotificationCompat | ||
|
|
||
| typealias Action = NotificationCompat.Action |
2 changes: 1 addition & 1 deletion
2
library/src/main/java/io/karn/notify/internal/utils/Annotations.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
library/src/test/java/io/karn/notify/NotificationInterlopTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.