gis-tools-ts - v0.6.0
    Preparing search index...

    Class GTFSRealtimeAlert

    An alert, indicating some sort of incident in the public transit network.

    Index

    Constructors

    constructor

    Properties

    activePeriods cause causeDetail? descriptionText? effect effectDetail? headerText? image? imageAlternativeText? informedEntities severityLevel ttsDescriptionText? ttsHeaderText? url?

    Constructors

    • Parameters

      • pbf: PbfReader

        The Protobuf object to read from

      • end: number

        The end position of the message in the buffer

      Returns GTFSRealtimeAlert

    Properties

    activePeriods: GTFSRealtimeTimeRange[] = []

    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.

    cause: GTFSRealtimeCause = GTFSRealtimeCause.UNKNOWN_CAUSE

    Cause of this alert. If cause_detail is included, then Cause must also be included.

    causeDetail?: GTFSRealtimeTranslatedString

    Description of the cause of the alert that allows for agency-specific language; more specific than the Cause. If cause_detail is included, then Cause must also be included. NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.

    descriptionText?: GTFSRealtimeTranslatedString

    Full description for the alert as plain-text. The information in the description should add to the information of the header.

    effect: GTFSRealtimeEffect = GTFSRealtimeEffect.UNKNOWN_EFFECT

    What is the effect of this problem on the affected entity. If effect_detail is included, then Effect must also be included.

    effectDetail?: GTFSRealtimeTranslatedString

    Description of the effect of the alert that allows for agency-specific language; more specific than the Effect. If effect_detail is included, then Effect must also be included. NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.

    headerText?: GTFSRealtimeTranslatedString

    Alert header. Contains a short summary of the alert text as plain-text.

    image?: GTFSRealtimeTranslatedString

    TranslatedImage to be displayed along the alert text. Used to explain visually the alert effect of a detour, station closure, etc. The image must enhance the understanding of the alert. Any essential information communicated within the image must also be contained in the alert text. The following types of images are discouraged : image containing mainly text, marketing or branded images that add no additional information. NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.

    imageAlternativeText?: GTFSRealtimeTranslatedString

    Text describing the appearance of the linked image in the image field (e.g., in case the image can't be displayed or the user can't see the image for accessibility reasons). See the HTML spec for alt image text - https://html.spec.whatwg.org/#alt. NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future

    informedEntities: GTFSRealtimeEntitySelector[] = []

    Entities whose users we should notify of this alert.

    severityLevel: GTFSRealtimeSeverityLevel = GTFSRealtimeSeverityLevel.UNKNOWN_SEVERITY

    Severity of this alert.

    ttsDescriptionText?: GTFSRealtimeTranslatedString

    Text for full description for the alert to be used in text-to-speech implementations. This field is the text-to-speech version of description_text.

    ttsHeaderText?: GTFSRealtimeTranslatedString

    Text for alert header to be used in text-to-speech implementations. This field is the text-to-speech version of header_text.

    url?: GTFSRealtimeTranslatedString

    The URL which provides additional information about the alert.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties