Holodex.Api.Videos (holodex v0.1.3) View Source
Holodex Videos
resource API module.
Includes client functions for interacting with the Video
resource.
Link to this section Summary
Functions
Query videos from Holodex, optionally with given parameters.
Query videos from Holodex, optionally with given parameters.
Returns a single Video
in a tuple, optionally with comments and recommendation.
Returns a single Video
, optionally with comments and recommendations.
Link to this section Types
Specs
opts() :: %{ channel_id: String.t() | nil, id: String.t() | nil, include: [binary()] | String.t() | nil, lang: String.t() | nil, limit: pos_integer() | nil, max_upcoming_hours: number() | nil, mentioned_channel_id: String.t() | nil, offset: integer() | nil, order: String.t() | nil, org: String.t() | nil, paginated: String.t() | nil, sort: String.t() | nil, status: String.t() | nil, topic: String.t() | nil, type: String.t() | nil } | %{}
Specs
Link to this section Functions
Specs
list_videos(opts()) :: {:ok, [Holodex.Model.Video.t()]} | {:error, HTTPoison.Error.t()} | {:error, Exception.t()}
Query videos from Holodex, optionally with given parameters.
Returns a tuple containing the response body or an error.
Specs
Query videos from Holodex, optionally with given parameters.
Raises an exception in case of failure.
Specs
video_info(String.t(), single_opts()) :: {:ok, Holodex.Model.Video.t()} | {:error, HTTPoison.Error.t()} | {:error, Exception.t()}
Returns a single Video
in a tuple, optionally with comments and recommendation.
Specs
video_info!(String.t(), single_opts()) :: Holodex.Model.Video.t()
Returns a single Video
, optionally with comments and recommendations.
Raises an exception in case of failure.