Holodex.Api.Channels (holodex v0.1.3) View Source

Holodex Channel resource API module.

Includes client functions for interacting with the Channel resource.

Link to this section Summary

Types

opts()

Functions

get_channel(channel_id)

Get info about a particular channel by its Youtube channel ID.

get_channel!(channel_id)

Get info about a particular channel by its Youtube channel ID.

list_channels(opts \\ %{})

Get all channels from Holodex, optionally with given parameters.

list_channels!(opts \\ %{})

Get all channels from Holodex, optionally with given parameters.

Link to this section Types

opts()

Specs

opts() ::
  %{
    lang: binary() | nil,
    limit: 0..50 | nil,
    offset: integer() | nil,
    order: binary() | nil,
    org: binary() | nil,
    sort: binary() | nil,
    type: binary() | nil
  }
  | %{}

Link to this section Functions

get_channel(channel_id)

Specs

get_channel(String.t()) ::
  {:ok, Holodex.Model.Channel.t()}
  | {:error, HTTPoison.Error.t()}
  | {:error, Exception.t()}

Get info about a particular channel by its Youtube channel ID.

Returns a tuple containing the channel info or an error.

get_channel!(channel_id)

Specs

get_channel!(String.t()) :: Holodex.Model.Channel.t() | no_return()

Get info about a particular channel by its Youtube channel ID.

Raises an exception in case of failure.

list_channels(opts \\ %{})

Specs

list_channels(opts()) ::
  {:ok, [Holodex.Model.Channel.t()]}
  | {:error, HTTPoison.Error.t()}
  | {:error, Exception.t()}

Get all channels from Holodex, optionally with given parameters.

Returns a tuple containing the response body or an error.

list_channels!(opts \\ %{})

Specs

list_channels!(opts()) :: [Holodex.Model.Channel.t()] | no_return()

Get all channels from Holodex, optionally with given parameters.

Raises an exception in case of failure.