Fluminus.API.File (fluminus v2.2.9) View Source

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

Struct fields:

:id - id of the file
:name - the name of the file
:directory? - whether this file is a directory
:children - nil indicated the need to fetch, otherwise it contains a list of its children. if directory? is false, then this field contains an empty list.
:allow_upload? - whether this is a student submission folder.
:multimedia? - whether this is a multimedia file.

Link to this section Summary

Types

t()

Functions

download(file, auth, path, verbose \\ false)

Downloads the given file to the location specified by path.

from_lesson(api_response)

Creates a Elixir.Fluminus.API.File struct from the API response retrieved by Lesson.

from_module(module, auth)

Creates Elixir.Fluminus.API.File struct from a Module.

get_download_url(file, auth)

Obtains the download url for a given file.

load_children(file, auth)

Loads the children of a given Elixir.Fluminus.API.File struct.

Link to this section Types

t()

Specs

t() :: %Fluminus.API.File{
  allow_upload?: bool(),
  children: [t()] | nil,
  directory?: bool(),
  id: String.t(),
  multimedia?: bool(),
  name: String.t()
}

Link to this section Functions

download(file, auth, path, verbose \\ false)

Specs

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

Downloads the given file to the location specified by path.

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

from_lesson(api_response)

Specs

from_lesson(api_response :: any()) :: t() | nil

Creates a Elixir.Fluminus.API.File struct from the API response retrieved by Lesson.

from_module(module, auth)

Specs

from_module(Fluminus.API.Module.t(), Fluminus.Authorization.t()) ::
  {:ok, t()} | :error

Creates Elixir.Fluminus.API.File struct from a Module.

get_download_url(file, auth)

Specs

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

Obtains the download url for a given file.

Note that the download url of a directory is a url to that directory zipped.

load_children(file, auth)

Specs

load_children(t(), Fluminus.Authorization.t()) ::
  {:ok, t()} | {:error, :forbidden} | :error

Loads the children of a given Elixir.Fluminus.API.File struct.