Fluminus.API.Module.ExternalMultimedia.Child (fluminus v2.2.8) View Source

Provides an abstraction over an external multimedia channel's child.

Link to this section Summary

Functions

Downloads the given file in an external multinedia channel's child to the location specified by path.

Obtains the download url for a given file in an external multimedia channel's child.

Link to this section Types

Specs

t() :: %Fluminus.API.Module.ExternalMultimedia.Child{
  client: Fluminus.HTTPClient.t(),
  name: String.t(),
  viewer_url: String.t()
}

Link to this section Functions

Link to this function

download(child, path, verbose)

View Source

Specs

download(t(), String.t(), bool()) :: :ok | {:error, :exists | any()}

Downloads the given file in an external multinedia channel's child to the location specified by path.

This function will return {:error, :exists} if the file already exists in the given path

Specs

from_api(any(), Fluminus.HTTPClient.t()) :: t()

Specs

get_download_url(t()) :: {:ok, String.t()} | {:error, any()}

Obtains the download url for a given file in an external multimedia channel's child.