SEO.JSONLD.TrainTrip (SEO v0.3.0-rc.0)

View Source

A trip on a commercial train line.

Helper for building a Schema.org TrainTrip JSON-LD structure.

Summary

Types

attrs()
t()

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "TrainTrip", plus any camelCased field keys the caller provided (see build/1). "@context" is added at render time by SEO.JSONLD.meta/1 on the top-level node only.

Functions

build(attrs)

Build a TrainTrip JSON-LD map.

Types

attrs()

@type attrs() ::
  %{
    optional(:arrival_platform) => String.t(),
    optional(:arrival_station) => SEO.JSONLD.TrainStation.t() | map(),
    optional(:departure_platform) => String.t(),
    optional(:departure_station) => SEO.JSONLD.TrainStation.t() | map(),
    optional(:train_name) => String.t(),
    optional(:train_number) => String.t(),
    optional(:arrival_time) =>
      DateTime.t() | NaiveDateTime.t() | String.t() | Time.t(),
    optional(:departure_time) =>
      DateTime.t() | NaiveDateTime.t() | String.t() | Time.t(),
    optional(:itinerary) =>
      SEO.JSONLD.Place.t() | map() | SEO.JSONLD.ItemList.t(),
    optional(:offers) => SEO.JSONLD.Offer.t() | map() | SEO.JSONLD.Demand.t(),
    optional(:part_of_trip) => SEO.JSONLD.Trip.t() | map(),
    optional(:provider) =>
      SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
    optional(:sub_trip) => SEO.JSONLD.Trip.t() | map(),
    optional(:trip_origin) => SEO.JSONLD.Place.t() | map(),
    optional(:additional_type) => String.t() | URI.t(),
    optional(:alternate_name) => String.t(),
    optional(:description) => SEO.JSONLD.TextObject.t() | map() | String.t(),
    optional(:disambiguating_description) => String.t(),
    optional(:identifier) =>
      String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
    optional(:image) =>
      URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
    optional(:main_entity_of_page) =>
      SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
    optional(:name) => String.t(),
    optional(:owner) =>
      SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
    optional(:potential_action) => SEO.JSONLD.Action.t() | map(),
    optional(:same_as) => URI.t() | String.t(),
    optional(:subject_of) =>
      SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
    optional(:url) => URI.t() | String.t()
  }
  | [
      arrival_platform: String.t(),
      arrival_station: SEO.JSONLD.TrainStation.t() | map(),
      departure_platform: String.t(),
      departure_station: SEO.JSONLD.TrainStation.t() | map(),
      train_name: String.t(),
      train_number: String.t(),
      arrival_time: DateTime.t() | NaiveDateTime.t() | String.t() | Time.t(),
      departure_time: DateTime.t() | NaiveDateTime.t() | String.t() | Time.t(),
      itinerary: SEO.JSONLD.Place.t() | map() | SEO.JSONLD.ItemList.t(),
      offers: SEO.JSONLD.Offer.t() | map() | SEO.JSONLD.Demand.t(),
      part_of_trip: SEO.JSONLD.Trip.t() | map(),
      provider: SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
      sub_trip: SEO.JSONLD.Trip.t() | map(),
      trip_origin: SEO.JSONLD.Place.t() | map(),
      additional_type: String.t() | URI.t(),
      alternate_name: String.t(),
      description: SEO.JSONLD.TextObject.t() | map() | String.t(),
      disambiguating_description: String.t(),
      identifier: String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
      image: URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
      main_entity_of_page:
        SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
      name: String.t(),
      owner: SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
      potential_action: SEO.JSONLD.Action.t() | map(),
      same_as: URI.t() | String.t(),
      subject_of: SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
      url: URI.t() | String.t()
    ]

t()

@type t() :: %{required(String.t()) => term()}

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "TrainTrip", plus any camelCased field keys the caller provided (see build/1). "@context" is added at render time by SEO.JSONLD.meta/1 on the top-level node only.

Functions

build(attrs)

@spec build(attrs()) :: t()

Build a TrainTrip JSON-LD map.

Fields

  • :arrival_platform - The platform where the train arrives.
  • :arrival_station - The station where the train trip ends.
  • :departure_platform - The platform from which the train departs.
  • :departure_station - The station from which the train departs.
  • :train_name - The name of the train (e.g. The Orient Express).
  • :train_number - The unique identifier for the train.

Inherited properties

Additional properties are available through the inheritance chain. See each ancestor's docs for its properties: