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

View Source

A means for accessing a service, e.g. a government office location, web site, or phone number.

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

Summary

Types

attrs()
t()

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

Types

attrs()

@type attrs() ::
  %{
    optional(:available_language) =>
      String.t() | SEO.JSONLD.Language.t() | map(),
    optional(:processing_time) => Duration.t() | String.t(),
    optional(:provides_service) => SEO.JSONLD.Service.t() | map(),
    optional(:service_location) => SEO.JSONLD.Place.t() | map(),
    optional(:service_phone) => SEO.JSONLD.ContactPoint.t() | map(),
    optional(:service_postal_address) => SEO.JSONLD.PostalAddress.t() | map(),
    optional(:service_sms_number) => SEO.JSONLD.ContactPoint.t() | map(),
    optional(:service_url) => URI.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()
  }
  | [
      available_language: String.t() | SEO.JSONLD.Language.t() | map(),
      processing_time: Duration.t() | String.t(),
      provides_service: SEO.JSONLD.Service.t() | map(),
      service_location: SEO.JSONLD.Place.t() | map(),
      service_phone: SEO.JSONLD.ContactPoint.t() | map(),
      service_postal_address: SEO.JSONLD.PostalAddress.t() | map(),
      service_sms_number: SEO.JSONLD.ContactPoint.t() | map(),
      service_url: URI.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 "ServiceChannel", 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 ServiceChannel JSON-LD map.

Fields

  • :available_language - A language someone may use with or at the item, service or place. Please use one of the language codes from the IETF BCP 47 standard. See also inLanguage.
  • :processing_time - Estimated processing time for the service using this channel.
  • :provides_service - The service provided by this channel.
  • :service_location - The location (e.g. civic structure, local business, etc.) where a person can go to access the service.
  • :service_phone - The phone number to use to access the service.
  • :service_postal_address - The address for accessing the service by mail.
  • :service_sms_number - The number to access the service by text message.
  • :service_url - The website to access the service.

Inherited properties

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