summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorBirte Kristina Friesel <derf@finalrewind.org>2023-11-11 09:01:16 +0100
committerBirte Kristina Friesel <derf@finalrewind.org>2023-11-11 09:01:16 +0100
commit9acb5d56b1ebd80c45956cb1d5f8a0e881321ec3 (patch)
tree651459d70b97f66670ab0c292ba799782530b6bc /lib
parenteaf4de9b5bb6003007cff9c150614fd5fda5376d (diff)
Message: document ->code and ->type
Diffstat (limited to 'lib')
-rw-r--r--lib/Travel/Status/DE/HAFAS/Message.pm50
1 files changed, 50 insertions, 0 deletions
diff --git a/lib/Travel/Status/DE/HAFAS/Message.pm b/lib/Travel/Status/DE/HAFAS/Message.pm
index a9802eb..f8ce478 100644
--- a/lib/Travel/Status/DE/HAFAS/Message.pm
+++ b/lib/Travel/Status/DE/HAFAS/Message.pm
@@ -92,6 +92,56 @@ string such as "Information". Does not contain newlines.
Detailed message content. Does not contain newlines.
+=item $message->code
+
+Two-digit message code, seems to be only used with messages of type "A".
+Details unknown.
+
+=item $message->type
+
+A single character indicating the message type.
+The following types are known:
+
+=over
+
+=item A
+
+Generic information about a specific trip such as "WiFi available", "air
+conditioning", "DB tickets are not valid here", or "from here on as [line]
+towards [destination]".
+
+=item C
+
+"Current information available", possibly more.
+
+=item D
+
+Large-scale disruption, e.g. medical emergency on line.
+
+=item G
+
+Platform change, possibly more.
+
+=item H
+
+Misc stuff such as "Journey contains trains with mandatory reservation" or
+"ICE Sprinter".
+
+=item L
+
+Replacement journey
+
+=item M
+
+Free-text infos about construction sites, broken elevators, large events and
+similar occasions.
+
+=item P
+
+Journey has been cancelled, possibly more.
+
+=back
+
=item $message->ref_count
Counter indicating how often this message is used by the requested