Skip to content

isradeleon/Notify-Android

Repository files navigation

Notify-Android

Release API API

Android library that simplifies showing system notifications. Use a circle image for the large icon or add a big picture to the notification using a single Notify object.

Installation

Add jitpack.io to your root build.gradle:

allprojects { repositories { ... maven { url 'https://jitpack.io' } } }

Finally add the dependency to your app build.gradle:

dependencies { implementation 'com.github.isradeleon:Notify-Android:1.0.3' }

Notification channel for API >= 26

You'll need to add the default notification channel to your app/res/values/strings.xml file:

<resources> <string name="notify_channel_id">MyDefaultChannelID</string> <string name="notify_channel_name">MyDefaultChannelName</string> <string name="notify_channel_description">MyDefaultChannelDescription</string> </resources>

Basic usage

@Override protected void onCreate(Bundle savedInstanceState) { Notify.create(getApplicationContext()) /*  * Set notification title and content  * */ .setTitle("Jill Zhao") .setContent("Hi! So I meet you today?") /*  * Set notification small icon from drawable resource  * */ .setSmallIcon(R.drawable.ic_notifications_none_white_24dp) .setColor(R.color.colorPrimary) /*  * Set notification large icon from drawable resource or URL  * (INTERNET permission needs to be added to AndroidManifest.xml)  * */ .setLargeIcon("https://images.pexels.com/photos/139829/pexels-photo-139829.jpeg?auto=compress&cs=tinysrgb&dpr=2&h=150&w=440") /*  * Circle shaped large icon  * */ .circleLargeIcon() /*  * Set a big picture from drawable resource or URL  * (INTERNET permission needs to be added to AndroidManifest.xml)  * */ .setBigPicture("https://images.pexels.com/photos/1058683/pexels-photo-1058683.jpeg?auto=compress&cs=tinysrgb&dpr=2&h=650&w=940") .show(); // Finally showing the notification }

Methods

Method Description
Notify.create(context) Creates a Notify object
setId(id) Sets the identifier for the notification
setTitle(title) Sets the notification title
setContent(content) Sets the notification content
setImportance(importance) Handles the importance with a NotificationImportance object
setLargeIcon(largeIcon) Sets the large icon from a drawable or URL resource
circleLargeIcon() Circular image large icon
setSmallIcon(smallIcon) Sets the small icon from a drawable resource
setBigPicture(bigPicture) Sets a big picture from a drawable or URL resource
setChannelId(id) Sets the notification channel id
setChannelName(name) Sets the notification channel name
setChannelDescription(description) Sets the notification channel description
setAutoCancel(autoCancel) Sets the autocancel value
setAction(intent) Sets the action intent for when the notification is clicked
enableVibration(vibration) Enable or disable the vibration
setVibrationPattern(vibrationPattern) Sets the vibration pattern
getNotificationBuilder() Returns the NotificationCompat.Builder object
show() Shows the notification
cancel(context, id) Cancels the notification specified by id
cancelAll(context) Cancels all the notifications

License

This library is licensed under MIT license. View license.