Summary: Nested Classes | Inherited Fields | Ctors | Methods | Inherited Methods

Notification.ProgressStyle

Kotlin |Java

public static class Notification.ProgressStyle
extends Notification.Style

java.lang.Object
↳	android.app.Notification.Style
	↳	android.app.Notification.ProgressStyle

A Notification Style used to define a notification whose expanded state includes a highly customizable progress bar with segments, points, a custom tracker icon, and custom icons at the start and end of the progress bar. This style is suggested for use cases where the app is showing a tracker to the user of a thing they are interested in: the location of a car on its way to pick them up, food being delivered, or their own progress in a navigation journey. To use this style with your Notification, feed it to Notification.Builder.setStyle(android.app.Notification.Style) like so:

 new Notification.Builder(context)
   .setSmallIcon(R.drawable.ic_notification)
   .setColor(Color.GREEN)
   .setColorized(true)
   .setContentTitle("Arrive 10:08 AM").
   .setContentText("Dominique Ansel Bakery Soho")
   .addAction(new Notification.Action("Exit navigation",...))
   .setStyle(new Notification.ProgressStyle()
       .setStyledByProgress(false)
       .setProgress(456)
       .setProgressTrackerIcon(Icon.createWithResource(R.drawable.ic_driving_tracker))
       .addProgressSegment(new Segment(41).setColor(Color.BLACK))
       .addProgressSegment(new Segment(552).setColor(Color.YELLOW))
       .addProgressSegment(new Segment(253).setColor(Color.YELLOW))
       .addProgressSegment(new Segment(94).setColor(Color.BLUE))
       .addProgressPoint(new Point(60).setColor(Color.RED))
       .addProgressPoint(new Point(560).setColor(Color.YELLOW))
   )

NOTE: The progress bar layout will be mirrored for RTL layout. NOTE: The extras set by Notification.Builder.setProgress will be overridden by the values set on this style object when the notification is built.

Summary

Nested classes
`class`	`Notification.ProgressStyle.Point` A point within the progress bar, defining its position and color.
`class`	`Notification.ProgressStyle.Segment` A segment of the progress bar, which defines its length and color.

Inherited fields

From class android.app.Notification.Style


    protected
    
    
    Notification.Builder

mBuilder

Public constructors
`ProgressStyle()`

Public methods
`Notification.ProgressStyle`	`addProgressPoint(Notification.ProgressStyle.Point point)` Adds another point.
`Notification.ProgressStyle`	`addProgressSegment(Notification.ProgressStyle.Segment segment)` Appends a segment to the end of the progress bar.
`int`	`getProgress()` Gets the progress value of the progress bar.
`Icon`	`getProgressEndIcon()` Gets the progress bar end icon.
`int`	`getProgressMax()` Gets the sum of the lengths of all Segments in the style, which defines the maximum progress.
`List<Notification.ProgressStyle.Point>`	`getProgressPoints()` Gets the points that are displayed on the progress bar.
`List<Notification.ProgressStyle.Segment>`	`getProgressSegments()` Gets the segments that define the background layer of the progress bar.
`Icon`	`getProgressStartIcon()` Gets the progress bar start icon.
`Icon`	`getProgressTrackerIcon()` Gets the progress tracker icon for the progress bar.
`boolean`	`isProgressIndeterminate()` Get indeterminate value of the progress bar.
`boolean`	`isStyledByProgress()` Gets whether the progress bar's style is based on its progress.
`Notification.ProgressStyle`	`setProgress(int progress)` Specifies the progress (in the same units as `Segment.getLength()`) of the tracker along the length of the bar.
`Notification.ProgressStyle`	`setProgressEndIcon(Icon endIcon)` An optional square icon that appears at the end of the progress bar.
`Notification.ProgressStyle`	`setProgressIndeterminate(boolean indeterminate)` Used to indicate an initialization state without a known progress amount.
`Notification.ProgressStyle`	`setProgressPoints(List<Notification.ProgressStyle.Point> points)` Replaces all the progress points.
`Notification.ProgressStyle`	`setProgressSegments(List<Notification.ProgressStyle.Segment> progressSegments)` Sets or replaces the segments of the progress bar.
`Notification.ProgressStyle`	`setProgressStartIcon(Icon startIcon)` An optional square icon that appears at the start of the progress bar.
`Notification.ProgressStyle`	`setProgressTrackerIcon(Icon trackerIcon)` An optional icon that can appear as an overlay on the bar at the point of current progress.
`Notification.ProgressStyle`	`setStyledByProgress(boolean enabled)` Indicates whether the segments and points will be styled differently based on whether they are behind or ahead of the current progress.

Inherited methods

From class


        
          android.app.Notification.Style

`Notification`	`build()` Calls `Notification.Builder.build()` on the Builder this Style is attached to.
`void`	`checkBuilder()`
`RemoteViews`	`getStandardView(int layoutId)`
`void`	`internalSetBigContentTitle(CharSequence title)` Overrides ContentTitle in the expanded form of the template.
`void`	`internalSetSummaryText(CharSequence cs)` Set the first line of text after the detail section in the expanded form of the template.
`void`	`setBuilder(Notification.Builder builder)`

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

ProgressStyle

public ProgressStyle ()

Notification.ProgressStyle

Summary

Nested classes

Inherited fields

Public constructors

Public methods

Inherited methods

Public constructors

ProgressStyle

Public methods

addProgressPoint

addProgressSegment

getProgress

getProgressEndIcon

getProgressMax

getProgressPoints

getProgressSegments

getProgressStartIcon

getProgressTrackerIcon

isProgressIndeterminate

isStyledByProgress

setProgress

setProgressEndIcon

setProgressIndeterminate

setProgressPoints

setProgressSegments

setProgressStartIcon

setProgressTrackerIcon

setStyledByProgress