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

View Source

A unique instance of a BroadcastService on a CableOrSatelliteService lineup.

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

Summary

Types

attrs()
t()

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

Types

attrs()

@type attrs() ::
  %{
    optional(:broadcast_channel_id) => String.t(),
    optional(:broadcast_frequency) =>
      String.t() | SEO.JSONLD.BroadcastFrequencySpecification.t() | map(),
    optional(:broadcast_service_tier) => String.t(),
    optional(:genre) =>
      String.t() | URI.t() | SEO.JSONLD.DefinedTerm.t() | map(),
    optional(:in_broadcast_lineup) =>
      SEO.JSONLD.CableOrSatelliteService.t() | map(),
    optional(:provides_broadcast_service) =>
      SEO.JSONLD.BroadcastService.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()
  }
  | [
      broadcast_channel_id: String.t(),
      broadcast_frequency:
        String.t() | SEO.JSONLD.BroadcastFrequencySpecification.t() | map(),
      broadcast_service_tier: String.t(),
      genre: String.t() | URI.t() | SEO.JSONLD.DefinedTerm.t() | map(),
      in_broadcast_lineup: SEO.JSONLD.CableOrSatelliteService.t() | map(),
      provides_broadcast_service: SEO.JSONLD.BroadcastService.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 "BroadcastChannel", 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 BroadcastChannel JSON-LD map.

Fields

  • :broadcast_channel_id - The unique address by which the BroadcastService can be identified in a provider lineup. In US, this is typically a number.
  • :broadcast_frequency - The frequency used for over-the-air broadcasts. Numeric values or simple ranges, e.g. 87-99. In addition a shortcut idiom is supported for frequencies of AM and FM radio channels, e.g. "87 FM".
  • :broadcast_service_tier - The type of service required to have access to the channel (e.g. Standard or Premium).
  • :genre - Genre of the creative work, broadcast channel or group.
  • :in_broadcast_lineup - The CableOrSatelliteService offering the channel.
  • :provides_broadcast_service - The BroadcastService offered on this channel.

Inherited properties

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