diff options
author | Birte Kristina Friesel <derf@finalrewind.org> | 2024-04-02 19:08:58 +0200 |
---|---|---|
committer | Birte Kristina Friesel <derf@finalrewind.org> | 2024-04-02 19:08:58 +0200 |
commit | 4670348869ad61c33a6d9d9e6eb88587cb8273b3 (patch) | |
tree | 3215d73b41139bd617670122f96bfe8352da12ce | |
parent | f36af4e217753ef145fc8e7e36b2280666e5ae6e (diff) |
Update get_active_service documentation
-rw-r--r-- | lib/Travel/Status/DE/HAFAS.pm | 30 |
1 files changed, 25 insertions, 5 deletions
diff --git a/lib/Travel/Status/DE/HAFAS.pm b/lib/Travel/Status/DE/HAFAS.pm index 204c33a..c21169f 100644 --- a/lib/Travel/Status/DE/HAFAS.pm +++ b/lib/Travel/Status/DE/HAFAS.pm @@ -1375,17 +1375,37 @@ arguments. Otherwise, the caller must specify B<promise> and B<user_agent> =item $status->get_active_service Returns a hashref describing the active service when a service is active and -nothing otherwise. The hashref contains the keys B<url> (URL to the station -board service), B<stopfinder> (URL to the stopfinder service, if supported), -B<name>, and B<productbits> (arrayref describing the supported modes of -transport, may contain duplicates). +nothing otherwise. The hashref contains the following keys. + +=over + +=item B<name> => I<string> + +service name, e.g. Bay Area Rapid Transit or Deutsche Bahn. + +=item B<mgate> => I<string> + +HAFAS backend URL + +=item B<languages> => I<arrayref> + +Languages supported by the backend; see the constructor's B<language> argument. + +=item B<productbits> => I<arrayref> + +MOT bits supported by the backend. I<arrayref> contains either strings +(one string per mode of transit) or arrayrefs (one string pair per mode of +transit, with the first entry referring to the MOT identifier and the second +one containing a slightly longer description of it). + +=back =item Travel::Status::DE::HAFAS::get_services() Returns an array containing all supported HAFAS services. Each element is a hashref and contains all keys mentioned in B<get_active_service>. It also contains a B<shortname> key, which is the service name used by -the constructor's B<service> parameter. +the constructor's B<service> parameter, e.g. BART or DB. =item Travel::Status::DE::HAFAS::get_service(I<$service>) |