CountdownTimer class
A simple countdown timer that fires events in regular increments until a duration has passed.
CountdownTimer implements Stream and sends itself as the event. From the timer you can get the remaining and elapsed time, or cancel the timer.
- Inheritance
- Object
- Stream<
CountdownTimer> - CountdownTimer
Constructors
- CountdownTimer(Duration duration, Duration increment, { Stopwatch stopwatch })
-
Creates a new CountdownTimer that fires events in increments of
increment
, until theduration
has passed. [...]
Properties
- elapsed → Duration
-
read-only
- increment → Duration
-
The duration between timer events.
final
- isRunning → bool
-
read-only
- remaining → Duration
-
read-only
-
first
→ Future<
CountdownTimer> -
The first element of this stream. [...]
read-only, inherited
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- isBroadcast → bool
-
Whether this stream is a broadcast stream.
read-only, inherited
-
isEmpty
→ Future<
bool> -
Whether this stream contains any elements. [...]
read-only, inherited
-
last
→ Future<
CountdownTimer> -
The last element of this stream. [...]
read-only, inherited
-
length
→ Future<
int> -
The number of elements in this stream. [...]
read-only, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
-
single
→ Future<
CountdownTimer> -
The single element of this stream. [...]
read-only, inherited
Methods
-
cancel(
) → dynamic -
listen(
void onData(CountdownTimer event), { Function onError, void onDone(), bool cancelOnError }) → StreamSubscription< CountdownTimer> -
Adds a subscription to this stream. [...]
override
-
any(
bool test(T element)) → Future< bool> -
Checks whether
test
accepts any element provided by this stream. [...]inherited -
asBroadcastStream(
{void onListen(StreamSubscription< T> subscription), void onCancel(StreamSubscription< T> subscription) }) → Stream< CountdownTimer> -
Returns a multi-subscription stream that produces the same events as this. [...]
inherited
-
asyncExpand<
E>( Stream< E> convert(T event)) → Stream< E> -
Transforms each element into a sequence of asynchronous events. [...]
inherited
-
asyncMap<
E>( FutureOr< E> convert(T event)) → Stream< E> -
Creates a new stream with each data event of this stream asynchronously
mapped to a new event. [...]
inherited
-
cast<
R>( ) → Stream< R> -
Adapt this stream to be a
Stream<R>
. [...]inherited -
contains(
Object needle) → Future< bool> -
Returns whether
needle
occurs in the elements provided by this stream. [...]inherited -
distinct(
[bool equals(T previous, T next) ]) → Stream< CountdownTimer> -
Skips data events if they are equal to the previous data event. [...]
inherited
-
drain<
E>( [E futureValue ]) → Future< E> -
Discards all data on this stream, but signals when it is done or an error
occurred. [...]
inherited
-
elementAt(
int index) → Future< CountdownTimer> -
Returns the value of the
index
th data event of this stream. [...]inherited -
every(
bool test(T element)) → Future< bool> -
Checks whether
test
accepts all elements provided by this stream. [...]inherited -
expand<
S>( Iterable< S> convert(T element)) → Stream< S> -
Transforms each element of this stream into a sequence of elements. [...]
inherited
-
firstWhere(
bool test(T element), { CountdownTimer orElse() }) → Future< CountdownTimer> -
Finds the first element of this stream matching
test
. [...]inherited -
fold<
S>( S initialValue, S combine(S previous, T element)) → Future< S> -
Combines a sequence of values by repeatedly applying
combine
. [...]inherited -
forEach(
void action(T element)) → Future -
Executes
action
on each element of this stream. [...]inherited -
handleError(
Function onError, { bool test(dynamic error) }) → Stream< CountdownTimer> -
Creates a wrapper Stream that intercepts some errors from this stream. [...]
inherited
-
join(
[String separator = "" ]) → Future< String> -
Combines the string representation of elements into a single string. [...]
inherited
-
lastWhere(
bool test(T element), { CountdownTimer orElse() }) → Future< CountdownTimer> -
Finds the last element in this stream matching
test
. [...]inherited -
map<
S>( S convert(T event)) → Stream< S> -
Transforms each element of this stream into a new stream event. [...]
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
pipe(
StreamConsumer< CountdownTimer> streamConsumer) → Future -
Pipes the events of this stream into
streamConsumer
. [...]inherited -
reduce(
CountdownTimer combine(T previous, T element)) → Future< CountdownTimer> -
Combines a sequence of values by repeatedly applying
combine
. [...]inherited -
singleWhere(
bool test(T element), { CountdownTimer orElse() }) → Future< CountdownTimer> -
Finds the single element in this stream matching
test
. [...]inherited -
skip(
int count) → Stream< CountdownTimer> -
Skips the first
count
data events from this stream. [...]inherited -
skipWhile(
bool test(T element)) → Stream< CountdownTimer> -
Skip data events from this stream while they are matched by
test
. [...]inherited -
take(
int count) → Stream< CountdownTimer> -
Provides at most the first
count
data events of this stream. [...]inherited -
takeWhile(
bool test(T element)) → Stream< CountdownTimer> -
Forwards data events while
test
is successful. [...]inherited -
timeout(
Duration timeLimit, { void onTimeout(EventSink< T> sink) }) → Stream< CountdownTimer> -
Creates a new stream with the same events as this stream. [...]
inherited
-
toList(
) → Future< List< CountdownTimer>> -
Collects all elements of this stream in a List. [...]
inherited
-
toSet(
) → Future< Set< CountdownTimer>> -
Collects the data of this stream in a Set. [...]
inherited
-
toString(
) → String -
Returns a string representation of this object.
inherited
-
transform<
S>( StreamTransformer< CountdownTimer, S> streamTransformer) → Stream< S> -
Applies
streamTransformer
to this stream. [...]inherited -
where(
bool test(T event)) → Stream< CountdownTimer> -
Creates a new stream from this stream that discards some elements. [...]
inherited
Operators
-
operator ==(
dynamic other) → bool -
The equality operator. [...]
inherited