fluminus v0.1.2 Fluminus.API.File 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.

Link to this section Summary

Functions

Downloads the given file to the location specified by path

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

Obtains the download url for a given file

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

Link to this section Types

Link to this type

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

Link to this section Functions

Link to this function

download(file, auth, path) View Source
download(Fluminus.API.File.t(), Fluminus.Authorization.t(), Path.t()) ::
  :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

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

Link to this function

get_download_url(file, auth) View Source

Obtains the download url for a given file.

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

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