Added in API level 37

Metric


class Metric
kotlin.Any
   ↳ android.app.Notification.Metric

A metric, used with MetricStyle, and which has a value and a label.

Summary

Nested classes

A metric value for showing a date.

Metric corresponding to a floating point value.

Metric corresponding to an integer value.

Metric corresponding to a text value.

A metric value for showing a clock time.

abstract

A superclass for the various value types used by the Metric class.

This represents a timer, a stopwatch, or a countdown to an event.

Public constructors

Creates a Metric with the specified value and label.

Metric(value: Notification.Metric.MetricValue, label: CharSequence, semanticStyle: Int)

Creates a Metric with the specified value, label, and semantic style.

Public methods
Boolean
equals(other: Any?)

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

CharSequence

A label for the metric.

Int

Applies semantics to the metric.

Notification.Metric.MetricValue

A value for the metric.

Int

Returns a hash code value for the object.

String

Returns a string representation of the object.

Public constructors

Metric

Added in API level 37
Metric(
    value: Notification.Metric.MetricValue,
    label: CharSequence)

Creates a Metric with the specified value and label.

Parameters
value Notification.Metric.MetricValue: one of the subclasses of MetricValue, such as FixedInt
This value cannot be null.
label CharSequence: metric label -- should be 10 characters or fewer.
This value cannot be null.

Metric

Added in API level 37
Metric(
    value: Notification.Metric.MetricValue,
    label: CharSequence,
    semanticStyle: Int)

Creates a Metric with the specified value, label, and semantic style.

Parameters
value Notification.Metric.MetricValue: one of the subclasses of MetricValue, such as FixedInt
This value cannot be null.
label CharSequence: metric label -- should be 10 characters or fewer.
This value cannot be null.
semanticStyle Int: semantic style applied to the metric. When the notification is promoted the metric value will be displayed (e.g. colored) according to this style.
Value is one of the following:

Public methods

equals

Added in API level 37
fun equals(other: Any?): Boolean

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 the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getLabel

Added in API level 37
fun getLabel(): CharSequence

A label for the metric.

The space allocated to this will depend on the number of metrics on the notification, but it's recommended to keep this to 10 characters or fewer.

Return
CharSequence This value cannot be null.

getSemanticStyle

Added in API level 37
fun getSemanticStyle(): Int

Applies semantics to the metric. When the notification is promoted the metric value will be displayed (e.g. colored) according to this style.

Return
Int Value is one of the following:

getValue

Added in API level 37
fun getValue(): Notification.Metric.MetricValue

A value for the metric.

Return
Notification.Metric.MetricValue This value cannot be null.

hashCode

Added in API level 37
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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.
Return
Int a hash code value for this object.

toString

Added in API level 37
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.