eclass_api 1.0.1 icon indicating copy to clipboard operation
eclass_api: ^1.0.1 copied to clipboard

Dart client for the Open eClass Platform mobile API.

eclass_api #

This is a client for the Open eClass Platform mobile API written in Dart inspired by https://github.com/amoraitis/EclassMobileApi

Features #

  • Retrieve information about the institute, such as the name and the url.
  • Get user's registered courses.
  • Get the available courses in the platform (opencourses).
  • Get the course's tools.
  • Get user's portfolio courses and tools.
  • Get course's announcements.
  • Retrieve user's messages.

Installation #

dart pub add eclass_api

Getting started #

Create an instance of EclassUser:

import 'package:eclass_api/eclass_api.dart' as eclass;

Future<void> main() async {
  final user = eclass.User(instituteId: 'uom');
}

Examples #

Get institute's info:

final info = await user.getInfo();
print(info.toString());

Get institute's name:

final name = await user.institute;
print(name);

Log in (e.g https://eclass.uom.gr):

// Logging in https://eclass.${user.instituteId}.gr...
await user.login(username: 'username', password: 'password');

Check if token is expired:

if (await user.isTokenExpired) {
  // Token is expired
} else {
  // Token is valid
}

Get user's messages:

final messages = await user.getMessages();

Get user's course's announcements:

final announcements = await user.getAnnouncements(courseId: 'courseId');

Get user's registered courses:

final courses = await user.getCourses();

Get course's tools:

final tools = await user.getTools(courseId: 'courseId');

Get user's portfolio courses and tools:

final portfolio = await user.getPortfolio();

Log out of (e.g https://eclass.uom.gr):

// Logging out of https://eclass.${user.instituteId}.gr...
await user.logout();

Additional information #

For a more complete example look in the example folder.

0
likes
120
pub points
0%
popularity

Publisher

unverified uploader

Dart client for the Open eClass Platform mobile API.

Repository (GitHub)

Documentation

API reference

License

Icon for licenses.MIT (LICENSE)

Dependencies

html, http, xml

More

Packages that depend on eclass_api