Notification.MetricStyle | API reference

Notification.MetricStyle | API reference | Android Developers

public static final class Notification.MetricStyle
extends Notification.Style

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.

To use this style with your Notification, feed it to Notification.Builder.setStyle(android.app.Notification.Style) like so:

 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).

Summary

Constants
`int`	`METRIC_INDEX_NONE` Special value for `setCriticalMetric(int)` to indicate that none of the metrics should be considered the "most important" one.

Inherited fields

From class android.app.Notification.Style

protected Notification.Builder mBuilder

Public constructors
`MetricStyle()`

Public methods
`Notification.MetricStyle`	`addMetric(Notification.Metric metric)` Adds a `Metric` to this `MetricStyle`.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`Notification.Metric`	`getCriticalMetric()` Returns which, if any, of the metrics is considered the "most important", or `null` if none are.
`List<Notification.Metric>`	`getMetrics()` Returns an immutable view of the list of `Metric` instances in this `MetricStyle`.
`int`	`hashCode()` Returns a hash code value for the object.
`Notification.MetricStyle`	`setCriticalMetric(int index)` Indicates which of the metrics is considered the "most important".
`Notification.MetricStyle`	`setMetrics(List<Notification.Metric> metrics)` Sets the list of `Metric` instances for this `MetricStyle`, replacing whatever was added before.
`String`	`toString()` Returns a string representation of the object.

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.

Constants

METRIC_INDEX_NONE

public static final int METRIC_INDEX_NONE

Special value for setCriticalMetric(int) to indicate that none of the metrics should be considered the "most important" one.

Constant Value: -1 (0xffffffff)

Public constructors

MetricStyle

public MetricStyle ()

Public methods

equals

public boolean equals (Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
`obj`	`Object`: the reference object with which to compare.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getCriticalMetric

public Notification.Metric getCriticalMetric ()

Returns which, if any, of the metrics is considered the "most important", or null if none are. This may be used when the notification is displayed in other surfaces (such as a status bar chip).

By default, unless setCriticalMetric(int) has been set, the first metric in the list is considered the critical one.

Returns
`Notification.Metric`

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
`int`	a hash code value for this object.

setCriticalMetric

public Notification.MetricStyle setCriticalMetric (int index)

Indicates which of the metrics is considered the "most important". This may be used when the notification is displayed in other surfaces (such as a status bar chip).

Parameters
`index`	`int`: either the index (0-based) of an item in `getMetrics()`, or `METRIC_INDEX_NONE` to indicate no `Metric` should be used for this purpose

Returns
`Notification.MetricStyle`	This value cannot be `null`.

toString

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.