View Source SEO.OpenGraph.Article (SEO v0.1.11)

Metadata describing an article.

Resources

Summary

Types

t()

Functions

build(attrs, default \\ nil)

Build metadata about an article.

meta(assigns)

Attributes

Types

t()

@type t() :: %SEO.OpenGraph.Article{
  author:
    URI.t()
    | String.t()
    | SEO.OpenGraph.Profile.t()
    | [SEO.OpenGraph.Profile.t()],
  expiration_time: DateTime.t() | NaiveDateTime.t() | Date.t(),
  modified_time: DateTime.t() | NaiveDateTime.t() | Date.t(),
  namespace: String.t(),
  published_time: DateTime.t() | NaiveDateTime.t() | Date.t(),
  section: String.t(),
  tag: String.t() | [String.t()]
}

Functions

build(attrs, default \\ nil)

@spec build(SEO.attrs(), SEO.config()) :: t() | nil

Build metadata about an article.

  • :published_time - when the article was first published.
  • :modified_time - when the article was last changed.
  • :expiration_time - when the article is out of date after.
  • :author - Writers of the article. This can be nested author OpenGraph metadata or URLs that provide the metadata or simply the author's name.
  • :section - A high-level section name. E.g. "Technology"
  • :tag - Tag words associated with this article. E.g. ["Elixir", "Ecto"]

meta(assigns)

Attributes