Language

Notification.Metric.TimeDifference Class

Definition

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

[Android.Runtime.Register("android/app/Notification$Metric$TimeDifference", ApiSince=37, DoNotGenerateAcw=true)]
public sealed class Notification.Metric.TimeDifference : Android.App.Notification.Metric.MetricValue
[<Android.Runtime.Register("android/app/Notification$Metric$TimeDifference", ApiSince=37, DoNotGenerateAcw=true)>]
type Notification.Metric.TimeDifference = class
    inherit Notification.Metric.MetricValue
Inheritance
Notification.Metric.TimeDifference
Attributes

Remarks

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

When representing a running timer (or stopwatch, etc), this value specifies a reference instant for when that timer will hit zero (or the stopwatch was at zero, respectively), called the "zero time". In this case the time displayed is defined as the difference between the "zero time" and the current time, meaning it will show a live-updated timer.

The zero time can be specified as an Instant (in which case it corresponds to a "real-world" point in time, from InstantSource.system), or as milliseconds since boot (from SystemClock.elapsedRealtime()). The latter might be suitable when the timer is tied to an AlarmManager.ELAPSED_REALTIME alarm in AlarmManager.

When representing a paused timer (or stopwatch, etc), this value specifies the duration as a fixed value.

This value can also specify its formatting, whether as a "chronometer" (e.g. 43:21) or an adaptive time (e.g. 1h 43m).

Android reference for android.app.Notification.Metric.TimeDifference.

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.

Fields

Name Description
FormatAdaptive
Obsolete.

Formatting option: adaptive (e.g. 1h 5m; 15m; 1m 30s; 5s).

FormatChronometer
Obsolete.

Formatting option: chronometer-style, (e.g. two hours = "2:00:00").

Properties

Name Description
Class

Returns the runtime class of this Object.

(Inherited from Object)
Format

Formatting option for the timer/stopwatch.

Handle

The handle to the underlying Android instance.

(Inherited from Object)
IsStopwatch

Whether this TimeDifference value represents a stopwatch -- when running, it counts up from getZeroTime() (or getZeroElapsedRealtime()).

IsTimer

Whether this TimeDifference value represents a timer -- when running, it counts down to getZeroTime() (or getZeroElapsedRealtime()).

JniIdentityHashCode

Gets the identity hash code assigned to this Java peer by the interop runtime.

(Inherited from Object)
JniManagedPeerState (Inherited from JavaObject)
JniPeerMembers
PausedDuration

The fixed time difference, for a paused timer or stopwatch.

PeerReference

Gets the JNI object reference for this Java peer.

(Inherited from Object)
ThresholdClass (Inherited from Notification.Metric.MetricValue)
ThresholdType (Inherited from Notification.Metric.MetricValue)
ZeroElapsedRealtime

The elapsed realtime at which the time difference is zero.

ZeroTime

The Instant at which the time difference is zero.

Methods

Name Description
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)
ForPausedStopwatch(Duration, Int32)

Creates a "paused stopwatch" metric, showing the elapsedTime.

ForPausedTimer(Duration, Int32)

Creates a "paused timer" metric, showing the remainingTime.

ForStopwatch(Instant, Int32)

Creates a "running stopwatch" metric, which will show the time elapsed since startTime.

ForStopwatch(Int64, Int32)

Creates a "running stopwatch" metric, which will show the time elapsed since startTime, specified in the SystemClock.elapsedRealtime() frame of reference.

ForTimer(Instant, Int32)

Creates a "running timer" metric, which will show a countdown to endTime.

ForTimer(Int64, Int32)

Creates a "running timer" metric, which will show a countdown to endTime, specified in the SystemClock.elapsedRealtime() frame of reference.

GetHashCode()

Returns a hash code value for the object.

(Inherited from Object)
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)
SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
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 self.

JavaAs<TResult>(IJavaPeerable)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)
TryJavaCast<TResult>(IJavaPeerable, TResult)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

Applies to