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

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

Struct fields:

  • :id - id of the lesson plan
  • :name - name of the lesson plan
  • :week - which week the lesson plan is for
  • :module_id - the module id to which the lesson plan is from.

Link to this section Summary

Functions

Get files that are contained inside this lesson plan.

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

Link to this section Types

Specs

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

Link to this section Functions

Specs

files(t(), Fluminus.Authorization.t()) ::
  {:ok, [Fluminus.API.File.t()]} | {:error, any()}

Get files that are contained inside this lesson plan.

Specs

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

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