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

View Source

A trip or journey. An itinerary of visits to one or more places.

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

Summary

Types

attrs()
t()

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "Trip", 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 Trip JSON-LD map.

Types

attrs()

@type attrs() ::
  %{
    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) => t() | map(),
    optional(:provider) =>
      SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
    optional(:sub_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_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: t() | map(),
      provider: SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
      sub_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 "Trip", 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 Trip JSON-LD map.

Fields

  • :arrival_time - The expected arrival time.
  • :departure_time - The expected departure time.
  • :itinerary - Destination(s) ( SEO.JSONLD.Place ) that make up a trip. For a trip where destination order is important use SEO.JSONLD.ItemList to specify that order (see examples).
  • :offers - An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use businessFunction to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a SEO.JSONLD.Demand. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
  • :part_of_trip - Identifies that this SEO.JSONLD.Trip is a subTrip of another Trip. For example Day 1, Day 2, etc. of a multi-day trip.
  • :provider - The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
  • :sub_trip - Identifies a SEO.JSONLD.Trip that is a subTrip of this Trip. For example Day 1, Day 2, etc. of a multi-day trip.
  • :trip_origin - The location of origin of the trip, prior to any destination(s).

Inherited properties

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