OEmbedProviders.Provider (OEmbed Providers v0.1.0) View Source

Represents an OEmbed provider.

Link to this section Summary

Types

t()

Functions

find_endpoint(provider, url)

Get the OEmbedProviders.Provider.Endpoint for a Provider.

from_map(data)

Convert a map into a OEmbedProviders.Provider struct.

matches?(provider, url)

Check if the given URL matches this Provider.

oembed_url(provider, url)

Construct the OEmbed endpoint URL for the given Provider and URL.

Link to this section Types

t()

Specs

t() :: %OEmbedProviders.Provider{
  endpoints: [OEmbedProviders.Provider.Endpoint.t()],
  provider_name: String.t() | nil,
  provider_url: String.t() | nil
}

Link to this section Functions

find_endpoint(provider, url)

Specs

find_endpoint(provider :: t(), url :: String.t()) ::
  OEmbedProviders.Provider.Endpoint.t() | nil

Get the OEmbedProviders.Provider.Endpoint for a Provider.

from_map(data)

Specs

from_map(data :: map()) :: t()

Convert a map into a OEmbedProviders.Provider struct.

matches?(provider, url)

Specs

matches?(provider :: t(), url :: String.t()) :: boolean()

Check if the given URL matches this Provider.

oembed_url(provider, url)

Specs

oembed_url(provider :: t(), url :: String.t()) ::
  {:ok, String.t()} | {:error, any()}

Construct the OEmbed endpoint URL for the given Provider and URL.