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: 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.
Android reference 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
| Name | Description |
|---|---|
| Notification.ProgressStyle() | |
| Notification.ProgressStyle(IntPtr, JniHandleOwnership) |
Initializes a managed representation of an existing Java Native Interface object. |
Properties
| Name | Description |
|---|---|
| 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 |
Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object) |
| JniManagedPeerState | (Inherited from JavaObject) |
| JniPeerMembers |
Provides JNI binding infrastructure for Android.App.Notification.ProgressStyle. |
| MBuilder | (Inherited from Notification.Style) |
| PeerReference |
Gets the JNI object reference for this Java peer. (Inherited from Object) |
| Progress |
Gets the progress value of the progress bar. |
| ProgressEndIcon |
Gets the progress bar end icon. |
| ProgressMax |
Gets the sum of the lengths of all Segments in the style, which defines the maximum progress. |
| ProgressPoints |
Gets the points that are displayed on the progress bar. |
| ProgressSegments |
Gets the segments that define the background layer of the progress bar. |
| ProgressStartIcon |
Gets the progress bar start icon. |
| ProgressTrackerIcon |
Gets the progress tracker icon for the progress bar. |
| ThresholdClass |
Provides JNI binding infrastructure for Android.App.Notification.ProgressStyle. |
| ThresholdType |
Provides JNI binding infrastructure for Android.App.Notification.ProgressStyle. |
Methods
| Name | Description |
|---|---|
| AddProgressPoint(Notification+ProgressStyle+Point) |
Adds another point. |
| AddProgressSegment(Notification+ProgressStyle+Segment) |
Appends a segment to the end of the progress bar. |
| Build() |
Calls Notification.Builder.build() on the Builder this Style is attached to. (Inherited from Notification.Style) |
| CheckBuilder() | (Inherited from Notification.Style) |
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Construct(JniObjectReference, JniObjectReferenceOptions) | (Inherited from JavaObject) |
| Dispose() |
Releases the resources held by this Java peer. (Inherited from Object) |
| Dispose(Boolean) |
Releases the resources held by this Java peer. (Inherited from Object) |
| DisposeUnlessReferenced() | (Inherited from JavaObject) |
| Equals(Object) | (Inherited from JavaObject) |
| 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 expanded form of the template. (Inherited from Notification.Style) |
| InternalSetBigContentTitle(String) |
Overrides ContentTitle in the expanded form of the template. (Inherited from Notification.Style) |
| InternalSetSummaryText(ICharSequence) |
Set the first line of text after the detail section in the expanded form of the template. (Inherited from Notification.Style) |
| InternalSetSummaryText(String) |
Set the first line of text after the detail section in the expanded 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) |
| SetPeerReference(JniObjectReference, JniObjectReferenceOptions) | (Inherited from JavaObject) |
| SetProgress(Int32) |
Specifies the progress (in the same units as Segment.getLength()) of the tracker along the length of the bar. |
| SetProgressEndIcon(Icon) |
An optional square icon that appears at the end of the progress bar. |
| SetProgressIndeterminate(Boolean) |
Used to indicate an initialization state without a known progress amount. |
| SetProgressPoints(IList<Notification.ProgressStyle.Point>) |
Replaces all the progress points. |
| SetProgressSegments(IList<Notification.ProgressStyle.Segment>) |
Sets or replaces the segments of the progress bar. |
| SetProgressStartIcon(Icon) |
An optional square icon that appears at the start of the progress bar. |
| SetProgressTrackerIcon(Icon) |
An optional icon that can appear as an overlay on the bar at the point of current progress. |
| SetStyledByProgress(Boolean) |
Indicates whether the segments and points will be styled differently based on whether they are behind or ahead of the current progress. |
| ToArray<T>() |
Creates a managed array from this Java array wrapper. (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| UnregisterFromRuntime() |
Unregisters this Java peer from the interop runtime. (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
| Name | Description |
|---|---|
| IJavaPeerable.Disposed() | (Inherited from JavaObject) |
| IJavaPeerable.Finalized() | (Inherited from JavaObject) |
| IJavaPeerable.JniObjectReferenceControlBlock | (Inherited from JavaObject) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) | (Inherited from JavaObject) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from JavaObject) |
| IJavaPeerable.SetPeerReference(JniObjectReference) | (Inherited from JavaObject) |
Extension Methods
| Name | Description |
|---|---|
| GetJniTypeName(IJavaPeerable) |
Gets the JNI name of the type of the instance |
| JavaAs<TResult>(IJavaPeerable) |
Try to coerce |
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) | |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
Try to coerce |