PlayReleaseStatus enum

Play's status for one release on a track.

The question most callers have is PlayReleaseEntry.serving, which is derived from this — but serving is not sufficient on its own, and the consumer this was built for needs both. halted and draft are both "not serving" and call for different advice: one was stopped by a person, the other never started. Reach for the status when the next action differs.

Inheritance
Available extensions
Annotations
  • @JsonEnum.new(valueField: 'wire')

Values

completed → const PlayReleaseStatus

Fully rolled out to the track's audience.

const PlayReleaseStatus('completed', 'completed')
inProgress → const PlayReleaseStatus

A staged rollout is under way — some of the audience has it. The fraction is not in this document.

const PlayReleaseStatus('inProgress', 'inProgress')
halted → const PlayReleaseStatus

A rollout that was started and stopped. The release still exists and still names its versionCodes.

const PlayReleaseStatus('halted', 'halted')
draft → const PlayReleaseStatus

Prepared and not sent.

const PlayReleaseStatus('draft', 'draft')
statusUnspecified → const PlayReleaseStatus

Play's own "no status", which it sends rather than omitting the field.

Named, and still not an answer: PlayReleaseEntry.serving is null here for the same reason it is null for unknown. Play saying "unspecified" and Play saying nothing are the same amount of information.

const PlayReleaseStatus('statusUnspecified', 'statusUnspecified')
unknown → const PlayReleaseStatus

Play sent a value this version does not name. See PlayReleaseEntry.statusRaw.

const PlayReleaseStatus('unknown', null)

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
playValue → String?
Play's spelling, or null for unknown.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
wire → String
This package's spelling. See ProcessingState.wire.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

audienceFraction(PlayReleaseStatus? status, {required double? userFraction}) → double?
The fraction of the track's audience a release in status has been given.
read(String? playValue) → PlayReleaseStatus?
See ProcessingState.read.
serving(PlayReleaseStatus? status) → bool?
Whether a release in status is in front of any of the track's audience.

Constants

values → const List<PlayReleaseStatus>
A constant List of the values in this enum, in order of their declaration.