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

View Source

Representation of an Error.

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

Summary

Types

attrs()
t()

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

Types

attrs()

@type attrs() ::
  %{
    optional(:error_code) =>
      :active_action_status
      | :completed_action_status
      | :event_cancelled
      | :event_moved_online
      | :event_postponed
      | :event_rescheduled
      | :event_scheduled
      | :failed_action_status
      | :in_force
      | :not_in_force
      | :offline_permanently
      | :offline_temporarily
      | :online
      | :online_full
      | :order_cancelled
      | :order_delivered
      | :order_in_transit
      | :order_payment_due
      | :order_pickup_available
      | :order_problem
      | :order_processing
      | :order_returned
      | :partially_in_force
      | :payment_automatically_applied
      | :payment_complete
      | :payment_declined
      | :payment_due
      | :payment_past_due
      | :potential_action_status
      | :reservation_cancelled
      | :reservation_confirmed
      | :reservation_hold
      | :reservation_pending
      | integer()
      | SEO.JSONLD.DefinedTerm.t()
      | map()
      | String.t(),
    optional(:data) => SEO.JSONLD.Thing.t() | map(),
    optional(:source) => SEO.JSONLD.Thing.t() | map(),
    optional(:timestamp) => DateTime.t() | NaiveDateTime.t() | String.t(),
    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()
  }
  | [
      error_code:
        :active_action_status
        | :completed_action_status
        | :event_cancelled
        | :event_moved_online
        | :event_postponed
        | :event_rescheduled
        | :event_scheduled
        | :failed_action_status
        | :in_force
        | :not_in_force
        | :offline_permanently
        | :offline_temporarily
        | :online
        | :online_full
        | :order_cancelled
        | :order_delivered
        | :order_in_transit
        | :order_payment_due
        | :order_pickup_available
        | :order_problem
        | :order_processing
        | :order_returned
        | :partially_in_force
        | :payment_automatically_applied
        | :payment_complete
        | :payment_declined
        | :payment_due
        | :payment_past_due
        | :potential_action_status
        | :reservation_cancelled
        | :reservation_confirmed
        | :reservation_hold
        | :reservation_pending
        | integer()
        | SEO.JSONLD.DefinedTerm.t()
        | map()
        | String.t(),
      data: SEO.JSONLD.Thing.t() | map(),
      source: SEO.JSONLD.Thing.t() | map(),
      timestamp: DateTime.t() | NaiveDateTime.t() | String.t(),
      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 "Error", 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 Error JSON-LD map.

Fields

  • :error_code - Application or platform dependant error code. One of: :active_action_status, :completed_action_status, :event_cancelled, :event_moved_online, :event_postponed, :event_rescheduled, :event_scheduled, :failed_action_status, :in_force, :not_in_force, :offline_permanently, :offline_temporarily, :online, :online_full, :order_cancelled, :order_delivered, :order_in_transit, :order_payment_due, :order_pickup_available, :order_problem, :order_processing, :order_returned, :partially_in_force, :payment_automatically_applied, :payment_complete, :payment_declined, :payment_due, :payment_past_due, :potential_action_status, :reservation_cancelled, :reservation_confirmed, :reservation_hold, :reservation_pending.

Inherited properties

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