Flutter教育类API集成插件eclass_api的使用

Flutter教育类API集成插件eclass_api的使用

这是用Dart编写的针对Open eClass平台移动API的客户端，灵感来源于https://github.com/amoraitis/EclassMobileApi。

功能

• 获取有关学院的信息，例如名称和URL。
• 获取用户注册的课程。
• 获取平台上的可用课程（开放课程）。
• 获取课程的工具。
• 获取用户的个人作品集课程和工具。
• 获取课程的公告。
• 获取用户的邮件信息。

安装

dart pub add eclass_api

开始使用

创建一个EclassUser实例：

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

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

示例代码

获取学院的信息：

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

获取学院的名称：

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

登录（例如：https://eclass.uom.gr）：

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

检查令牌是否过期：

if (await user.isTokenExpired) {
  // 令牌已过期
} else {
  // 令牌有效
}

获取用户的邮件信息：

final messages = await user.getMessages();

获取用户课程的公告：

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

获取用户注册的课程：

final courses = await user.getCourses();

获取课程的工具：

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

获取用户的个人作品集课程和工具：

final portfolio = await user.getPortfolio();

从（例如：https://eclass.uom.gr）登出：

// 从 https://eclass.${user.instituteId}.gr... 登出
try {
  await user.logout();
  // 已登出
} on Exception {
  // 处理登出请求失败的情况
}

完整示例代码

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

Future<void> main() async {
  // 创建一个EclassUser实例
  final user = eclass.User(instituteId: "instituteId");
  // 学院：${await user.institute}.

  // 获取学院的信息
  final info = await user.getInfo();
  print(info.toString());

  // 登录到 https://eclass.${user.instituteId}.gr...
  try {
    await user.login(username: 'username', password: 'password');
  } on Exception {
    // 处理登录请求失败的情况
  }

  // 检查令牌是否过期
  if (await user.isTokenExpired) {
    // 令牌已过期
  } else {
    // 令牌有效
  }

  // 获取用户的邮件信息
  final messages = await user.getMessages();
  // 邮件信息：
  for (var message in messages) {
    print(message.toString());
  }

  // 获取用户课程的公告
  final announcements = await user.getAnnouncements(courseId: 'courseId');
  // 公告：
  for (final announcement in announcements) {
    print(announcement.toString());
  }

  // 获取用户的个人作品集课程和工具
  final portfolio = await user.getPortfolio();
  // 个人作品集课程：
  for (var course in portfolio.courses) {
    print(course.toString());
  }
  // 个人作品集工具：
  for (var tool in portfolio.tools) {
    print(tool.toString());
  }
  // 个人作品集工具配置文件：
  for (var profileTool in portfolio.profileTools) {
    print(profileTool.toString());
  }

  // 获取用户注册的课程
  final courses = await user.getCourses();
  // 课程：
  for (var course in courses) {
    print(course.toString());
  }

  // 获取课程的工具
  final tools = await user.getTools(courseId: 'courseId');
  // 工具：
  for (var tool in tools) {
    print(tool.toString());
  }

  // 从 https://eclass.${user.instituteId}.gr... 登出
  try {
    await user.logout();
    // 已登出
  } on Exception {
    // 处理登出请求失败的情况
  }
}