Notification.MetricStyle 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 which shows up to 3 metrics when expanded.
[Android.Runtime.Register("android/app/Notification$MetricStyle", ApiSince=37, DoNotGenerateAcw=true)]
public sealed class Notification.MetricStyle : Android.App.Notification.Style[<Android.Runtime.Register("android/app/Notification$MetricStyle", ApiSince=37, DoNotGenerateAcw=true)>]
type Notification.MetricStyle = class
inherit Notification.Style- Inheritance
- Attributes
Remarks
A notification style which shows up to 3 metrics when expanded. Metrics usually represent quantities that change over time, such as fitness information collected by a tracker, timers, weather information, etc.
Notification notif = new Notification.Builder(context)
.setStyle(new MetricStyle()
.addMetric(new Metric(new Metric.FixedInt(1979), "Steps"))
.addMetric(new Metric(
Metric.TimeDifference.forStopwatch(startTime, FORMAT_CHRONOMETER_AUTOMATIC),
"Time elapsed")))
A MetricStyle must contain at least one Metric object to be valid; an invalid style will be rejected when Builder.build() is called.
If a notification with this style is promoted ongoing, then one of its metrics might be displayed in the status bar chip.
Note that this style doesn't display the large icon set via Builder.setLargeIcon(Icon).
Android reference for android.app.Notification.MetricStyle.
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.MetricStyle() | |
Fields
| Name | Description |
|---|---|
| MetricIndexNone |
Special value for setCriticalMetric(int) to indicate that none of the metrics should be considered the "most important" one. |
Properties
| Name | Description |
|---|---|
| Class |
Returns the runtime class of this |
| CriticalMetric |
Returns which, if any, of the metrics is considered the "most important", or null if none are. |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| JniIdentityHashCode |
Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object) |
| JniManagedPeerState | (Inherited from JavaObject) |
| JniPeerMembers | |
| MBuilder | (Inherited from Notification.Style) |
| Metrics |
Returns an immutable view of the list of Metric instances in this MetricStyle. |
| PeerReference |
Gets the JNI object reference for this Java peer. (Inherited from Object) |
| ThresholdClass |
Provides JNI binding infrastructure for Android.App.Notification.Style. (Inherited from Notification.Style) |
| ThresholdType |
Provides JNI binding infrastructure for Android.App.Notification.Style. (Inherited from Notification.Style) |
Methods
| Name | Description |
|---|---|
| AddMetric(Notification+Metric) |
Adds a Metric to this MetricStyle. |
| 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() |
Obsolete.
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 |
| SetCriticalMetric(Int32) |
Indicates which of the metrics is considered the "most important". |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| SetMetrics(IList<Notification.Metric>) |
Sets the list of Metric instances for this MetricStyle, replacing whatever was added before. |
| SetPeerReference(JniObjectReference, JniObjectReferenceOptions) | (Inherited from JavaObject) |
| 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 |