gtfs-realtime/dev.sargunv.mobilitydata.gtfs.realtime/Alert

Alert

data class Alert(val activePeriod: List<TimeRange> = emptyList(), val communicationPeriod: List<TimeRange> = emptyList(), val impactPeriod: List<TimeRange> = emptyList(), val informedEntity: List<EntitySelector> = emptyList(), val cause: Alert.Cause = Cause.UnknownCause, val effect: Alert.Effect = Effect.UnknownEffect, val url: TranslatedString? = null, val headerText: TranslatedString? = null, val descriptionText: TranslatedString? = null, val ttsHeaderText: TranslatedString? = null, val ttsDescriptionText: TranslatedString? = null, val severityLevel: Alert.SeverityLevel = SeverityLevel.UnknownSeverity, val image: TranslatedImage? = null, val imageAlternativeText: TranslatedString? = null, val causeDetail: TranslatedString? = null, val effectDetail: TranslatedString? = null)(source)

A service alert in the realtime feed.

Constructors

Alert

constructor(activePeriod: List<TimeRange> = emptyList(), communicationPeriod: List<TimeRange> = emptyList(), impactPeriod: List<TimeRange> = emptyList(), informedEntity: List<EntitySelector> = emptyList(), cause: Alert.Cause = Cause.UnknownCause, effect: Alert.Effect = Effect.UnknownEffect, url: TranslatedString? = null, headerText: TranslatedString? = null, descriptionText: TranslatedString? = null, ttsHeaderText: TranslatedString? = null, ttsDescriptionText: TranslatedString? = null, severityLevel: Alert.SeverityLevel = SeverityLevel.UnknownSeverity, image: TranslatedImage? = null, imageAlternativeText: TranslatedString? = null, causeDetail: TranslatedString? = null, effectDetail: TranslatedString? = null)

Types

Cause

@Serializable

enum Cause : Enum<Alert.Cause>

Root cause for the alert.

Effect

@Serializable

enum Effect : Enum<Alert.Effect>

Rider-visible effect of the alert.

SeverityLevel

@Serializable

enum SeverityLevel : Enum<Alert.SeverityLevel>

Severity level for the alert.

Properties

activePeriod

val ~~activePeriod~~: List<TimeRange>

Time when the alert should be shown to the user. If missing, the alert will be shown as long as it appears in the feed. If multiple ranges are given, the alert will be shown during all of them. Should not be used - for backwards-compatibility only.

cause

@Serializable(with = CauseSerializer::class)

val cause: Alert.Cause

Root cause of the service disruption.

causeDetail

val causeDetail: TranslatedString?

Human-readable description of the cause.

communicationPeriod

val communicationPeriod: List<TimeRange>

Time when the alert should be shown to the user strictly for informative reasons. If missing, the consuming application can decide when it's appropriate to be shown. If multiple ranges are given, the alert will be shown during all of them.

descriptionText

val descriptionText: TranslatedString?

Full description of the alert.

effect

@Serializable(with = EffectSerializer::class)

val effect: Alert.Effect

Rider-visible effect on service.

effectDetail

val effectDetail: TranslatedString?

Human-readable description of the effect.

headerText

val headerText: TranslatedString?

Short summary of the alert.

image

val image: TranslatedImage?

Image to display alongside the alert.

imageAlternativeText

val imageAlternativeText: TranslatedString?

Accessibility alt text for image.

impactPeriod

val impactPeriod: List<TimeRange>

Time when the services are affected by the alert. If communicationPeriod is specified, every time interval in impactPeriod must be fully contained within at least one time interval of communicationPeriod.

informedEntity

val informedEntity: List<EntitySelector>

GTFS entities affected by this alert.

severityLevel

@Serializable(with = SeverityLevelSerializer::class)

val severityLevel: Alert.SeverityLevel

Severity of the alert.

ttsDescriptionText

val ttsDescriptionText: TranslatedString?

Text-to-speech version of descriptionText.

ttsHeaderText

val ttsHeaderText: TranslatedString?

Text-to-speech version of headerText.

url

val url: TranslatedString?

URL with additional alert information.