AshSitemap.Sitemaps.Video behaviour (ash_sitemap v1.0.1)

View Source

A struct representing a video sitemap. This module can also be used to implement manual video sitemaps.

See more at https://developers.google.com/search/docs/crawling-indexing/sitemaps/video-sitemaps

Summary

Types

t()

@type t() :: %AshSitemap.Sitemaps.Video{
  allow_embed?: boolean() | nil,
  autoplay?: boolean() | nil,
  category: String.t() | nil,
  content_loc: String.t(),
  description: String.t(),
  duration: non_neg_integer() | nil,
  expiration_date: String.t() | nil,
  family_friendly?: boolean() | nil,
  gallery_loc: String.t() | nil,
  gallery_title: String.t() | nil,
  live?: boolean() | nil,
  platform_list: [String.t()],
  platform_relationship?: boolean() | nil,
  player_loc: String.t(),
  price: String.t() | nil,
  price_currency: String.t() | nil,
  price_resolution: String.t() | nil,
  price_type: String.t() | nil,
  publication_date: String.t() | nil,
  rating: float() | nil,
  relationship?: boolean() | nil,
  requires_subscription?: boolean() | nil,
  restriction: [String.t()],
  show_episode_number: non_neg_integer() | nil,
  show_episode_title: String.t() | nil,
  show_premier_date: String.t() | nil,
  show_season_number: non_neg_integer() | nil,
  show_title: String.t() | nil,
  show_video_type: String.t() | nil,
  thumbnail_loc: String.t(),
  title: String.t(),
  uploader: String.t() | nil,
  uploader_info: String.t() | nil,
  view_count: non_neg_integer() | nil
}

Callbacks

generate(record)

@callback generate(record :: Ash.Resource.t()) :: t()