Notification.ProgressStyle Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.
[Android.Runtime.Register("android/app/Notification$ProgressStyle", ApiSince=36, DoNotGenerateAcw=true)]
public class Notification.ProgressStyle : Android.App.Notification.Style
[<Android.Runtime.Register("android/app/Notification$ProgressStyle", ApiSince=36, DoNotGenerateAcw=true)>]
type Notification.ProgressStyle = class
inherit Notification.Style
- Inheritance
- Attributes
Remarks
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. Therefore, that method is not used with this style.
Java documentation for android.app.Notification.ProgressStyle
.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Constructors
Notification.ProgressStyle() | |
Notification.ProgressStyle(IntPtr, JniHandleOwnership) |
Properties
Class |
Returns the runtime class of this |
Handle |
The handle to the underlying Android instance. (Inherited from Object) |
IsProgressIndeterminate |
Get indeterminate value of the progress bar. |
IsStyledByProgress |
Gets whether the progress bar's style is based on its progress. |
JniIdentityHashCode | (Inherited from Object) |
JniPeerMembers | |
MBuilder | (Inherited from Notification.Style) |
PeerReference | (Inherited from Object) |
Progress |
Gets the progress value of the progress bar. |
ProgressEndIcon | |
ProgressMax |
Gets the sum of the lengths of all Segments in the style, which defines the maximum progress. |
ProgressPoints | |
ProgressSegments | |
ProgressStartIcon | |
ProgressTrackerIcon | |
ThresholdClass | |
ThresholdType |
Methods
AddProgressPoint(Notification+ProgressStyle+Point) | |
AddProgressSegment(Notification+ProgressStyle+Segment) | |
Build() |
Calls |
CheckBuilder() | (Inherited from Notification.Style) |
Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
Dispose() | (Inherited from Object) |
Dispose(Boolean) | (Inherited from Object) |
Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
GetStandardView(Int32) | (Inherited from Notification.Style) |
InternalSetBigContentTitle(ICharSequence) |
Overrides ContentTitle in the big form of the template. (Inherited from Notification.Style) |
InternalSetBigContentTitle(String) |
Overrides ContentTitle in the big form of the template. (Inherited from Notification.Style) |
InternalSetSummaryText(ICharSequence) |
Set the first line of text after the detail section in the big form of the template. (Inherited from Notification.Style) |
InternalSetSummaryText(String) |
Set the first line of text after the detail section in the big form of the template. (Inherited from Notification.Style) |
JavaFinalize() |
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
Notify() |
Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object) |
NotifyAll() |
Wakes up all threads that are waiting on this object's monitor. (Inherited from Object) |
SetBuilder(Notification+Builder) |
Attaches a |
SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
SetProgress(Int32) | |
SetProgressEndIcon(Icon) | |
SetProgressIndeterminate(Boolean) | |
SetProgressPoints(IList<Notification.ProgressStyle.Point>) | |
SetProgressSegments(IList<Notification.ProgressStyle.Segment>) | |
SetProgressStartIcon(Icon) | |
SetProgressTrackerIcon(Icon) | |
SetStyledByProgress(Boolean) | |
ToArray<T>() | (Inherited from Object) |
ToString() |
Returns a string representation of the object. (Inherited from Object) |
UnregisterFromRuntime() | (Inherited from Object) |
Wait() |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object) |
Wait(Int64, Int32) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
Wait(Int64) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
Explicit Interface Implementations
IJavaPeerable.Disposed() | (Inherited from Object) |
IJavaPeerable.DisposeUnlessReferenced() | (Inherited from Object) |
IJavaPeerable.Finalized() | (Inherited from Object) |
IJavaPeerable.JniManagedPeerState | (Inherited from Object) |
IJavaPeerable.SetJniIdentityHashCode(Int32) | (Inherited from Object) |
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from Object) |
IJavaPeerable.SetPeerReference(JniObjectReference) | (Inherited from Object) |
Extension Methods
JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
JavaCast<TResult>(IJavaObject) | |
GetJniTypeName(IJavaPeerable) |
Gets the JNI name of the type of the instance |
JavaAs<TResult>(IJavaPeerable) |
Try to coerce |
TryJavaCast<TResult>(IJavaPeerable, TResult) |
Try to coerce |