Status
class Status : TimeDependentText
Base class to represent the status of an Ongoing Activity and render it.
A status is composed of Parts, and they are joined together with a template.
Note that for backwards compatibility reasons the code rendering this status message may not have all of the [Part] classes that are available in later versions of the library. Templates that do not have values for all of the named parts will not be used. The template list will be iterated through looking for the first template with all matching named parts available, this will be selected for rendering the status.
To provide for backwards compatibility, you should provide one (or more) fallback templates which use status parts from earlier versions of the API. e.g. TextPart, TimerPart &StopwatchPart
The status and part classes here use timestamps for updating the displayed representation of the status, in cases when this is needed (chronometers), as returned by elapsedRealtime
Summary
Nested types |
|---|
class Status.BuilderHelper to Build OngoingActivityStatus instances. |
abstract class Status.Part : TimeDependentTextAbstract class to represent An Ongoing activity status or part of it. |
|
An Ongoing activity status (or part of it) representing a stopwatch |
class Status.TextPart : Status.PartAn Ongoing activity status (or part of it) representing a plain, static text. |
abstract class Status.TimerOrStopwatchPart : Status.PartBase class for |
|
An Ongoing activity status (or part of it) representing a timer. |
Public functions |
|
|---|---|
java-static Status |
forPart(part: Status.Part)Convenience method for creating a Status with no template and a single Part. |
Long |
getNextChangeTimeMillis(fromTimeMillis: Long)Returns the next time this status could have a different rendering. |
Status.Part? |
Returns the value of the part with the given name. |
(Mutable)Set<String!> |
|
(Mutable)List<CharSequence!> |
|
CharSequence |
Returns a textual representation of this status at the given time. |
Public functions
forPart
java-static fun forPart(part: Status.Part): Status
Convenience method for creating a Status with no template and a single Part.
| Parameters | |
|---|---|
part: Status.Part |
The only Part that composes this status. |
getNextChangeTimeMillis
fun getNextChangeTimeMillis(fromTimeMillis: Long): Long
Returns the next time this status could have a different rendering. There is no guarantee that the rendering will change at the returned time (for example, if some information in the status is not rendered).
| Parameters | |
|---|---|
fromTimeMillis: Long |
current time, usually now as returned by |
| Returns | |
|---|---|
Long |
the next time (counting from fromTimeMillis) that this status may produce a different result when calling getText(). |
getPart
fun getPart(name: String): Status.Part?
Returns the value of the part with the given name.
| Parameters | |
|---|---|
name: String |
the name to lookup. |
| Returns | |
|---|---|
Status.Part? |
the part with the given name, can be null. |
getTemplates
fun getTemplates(): (Mutable)List<CharSequence!>
| Returns | |
|---|---|
(Mutable)List<CharSequence!> |
the list of templates that this status has. |
getText
fun getText(context: Context, timeNowMillis: Long): CharSequence
Returns a textual representation of this status at the given time. The first template that has all required information will be used, and each part will be used in their respective placeholder/s.
| Parameters | |
|---|---|
context: Context |
may be used for internationalization. Only used while this method executed. |
timeNowMillis: Long |
the timestamp of the time we want to display, usually now, as |
| Returns | |
|---|---|
CharSequence |
the rendered text, for best compatibility, display using a TextView. |