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

View Source

An entry point, within some Web-based protocol.

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

Summary

Types

attrs()
t()

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

Types

attrs()

@type attrs() ::
  %{
    optional(:action_application) => SEO.JSONLD.SoftwareApplication.t() | map(),
    optional(:action_platform) =>
      String.t()
      | URI.t()
      | :android_platform
      | :desktop_web_platform
      | :generic_web_platform
      | :ios_platform
      | :mobile_web_platform,
    optional(:application) => SEO.JSONLD.SoftwareApplication.t() | map(),
    optional(:content_type) => String.t(),
    optional(:encoding_type) => String.t(),
    optional(:http_method) => String.t(),
    optional(:url_template) => 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()
  }
  | [
      action_application: SEO.JSONLD.SoftwareApplication.t() | map(),
      action_platform:
        String.t()
        | URI.t()
        | :android_platform
        | :desktop_web_platform
        | :generic_web_platform
        | :ios_platform
        | :mobile_web_platform,
      application: SEO.JSONLD.SoftwareApplication.t() | map(),
      content_type: String.t(),
      encoding_type: String.t(),
      http_method: String.t(),
      url_template: 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 "EntryPoint", 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 EntryPoint JSON-LD map.

Fields

  • :action_application - An application that can complete the request.
  • :action_platform - The high level platform(s) where the Action can be performed for the given URL. To specify a specific application or operating system instance, use actionApplication. One of: :android_platform, :desktop_web_platform, :generic_web_platform, :ios_platform, :mobile_web_platform.
  • :application - An application that can complete the request.
  • :content_type - The supported content type(s) for an EntryPoint response.
  • :encoding_type - The supported encoding type(s) for an EntryPoint request.
  • :http_method - An HTTP method that specifies the appropriate HTTP method for a request to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.
  • :url_template - An url template (RFC6570) that will be used to construct the target of the execution of the action.

Inherited properties

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