Fluminus.API.Module.Weblecture (fluminus v2.2.9) View Source

Provides an abstraction over a weblecture in LumiNUS, and operations possible on them using LumiNUS API.

Struct fields:

Link to this section Summary

t()

Downloads the given weblecture to the location specified by path.

Creates Elixir.Fluminus.API.Module.Weblecture struct from LumiNUS API response.

Obtains the download url for a given weblecture.

t() :: %Fluminus.API.Module.Weblecture{
  id: String.t(),
  module_id: String.t(),
  name: String.t()
}

download(t(), Fluminus.Authorization.t(), Path.t(), bool()) ::
  :ok | {:error, :exists | any()}

Downloads the given weblecture to the location specified by path.

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

from_api(api_response :: any(), Fluminus.API.Module.t()) :: t()

Creates Elixir.Fluminus.API.Module.Weblecture struct from LumiNUS API response.

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

Obtains the download url for a given weblecture.