该 google-classroom1 库允许访问 Google 课堂服务的所有功能。

本文档是从 classroom crate 版本 5.0.5+20240617 生成的，其中 20240617 是由 mako 代码生成器 v5.0.5 构建的 classroom:v1 架构的确切修订。

有关 classroom v1 API 的其他所有信息，请参阅 官方文档网站。

功能

从中央 中心轻松处理以下 资源 ...

• 课程
• aliases create, aliases delete, aliases list, announcements add on attachments create, announcements add on attachments delete, announcements add on attachments get, announcements add on attachments list, announcements add on attachments patch, announcements create, announcements delete, announcements get, announcements get add on context, announcements list, announcements modify assignees, announcements patch, course work add on attachments create, course work add on attachments delete, course work add on attachments get, course work add on attachments list, course work add on attachments patch, course work add on attachments student submissions get, course work add on attachments student submissions patch, course work create, course work delete, course work get, course work get add on context, course work list, course work modify assignees, course work patch, course work student submissions get, course work student submissions list, course work student submissions modify attachments, course work student submissions patch, course work student submissions reclaim, course work student submissions return, course work student submissions turn in, course work materials add on attachments create, course work materials add on attachments delete, course work materials add on attachments get, course work materials add on attachments list, course work materials add on attachments patch, course work materials create, course work materials delete, course work materials get, course work materials get add on context, course work materials list, course work materials patch, create, delete, get, list, patch, posts add on attachments create, posts add on attachments delete, posts add on attachments get, posts add on attachments list, posts add on attachments patch, posts add on attachments student submissions get, posts add on attachments student submissions patch, posts get add on context, students create, students delete, students get, students list, teachers create, teachers delete, teachers get, teachers list, topics create, topics delete, topics get, topics list, topics patch and update
• 邀请
• 接受、创建、删除、获取和 列出
• 注册
• 创建和 删除
• 用户资料
• 获取、创建监护人邀请、获取监护人邀请、列出监护人邀请、修补监护人邀请、删除监护人、获取监护人和 列出监护人

本库结构

API结构如下主要项

• 中心
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建方法构建器，这些构建器反过来可以访问单个调用构建器
• 资源
  • 你可以将活动应用到这些主要类型上
  • 一组属性和部分
  • 部分
    • 一组属性
    • 从不直接在活动中使用
• 活动
  • 应用于资源的操作

所有结构都带有适用特性，以进一步分类它们并简化浏览。

一般来说，你可以这样调用活动

let r = hub.resource().activity(...).doit().await

或者具体...

let r = hub.courses().aliases_create(...).doit().await
let r = hub.courses().aliases_delete(...).doit().await
let r = hub.courses().aliases_list(...).doit().await
let r = hub.courses().announcements_add_on_attachments_create(...).doit().await
let r = hub.courses().announcements_add_on_attachments_delete(...).doit().await
let r = hub.courses().announcements_add_on_attachments_get(...).doit().await
let r = hub.courses().announcements_add_on_attachments_list(...).doit().await
let r = hub.courses().announcements_add_on_attachments_patch(...).doit().await
let r = hub.courses().announcements_create(...).doit().await
let r = hub.courses().announcements_delete(...).doit().await
let r = hub.courses().announcements_get(...).doit().await
let r = hub.courses().announcements_get_add_on_context(...).doit().await
let r = hub.courses().announcements_list(...).doit().await
let r = hub.courses().announcements_modify_assignees(...).doit().await
let r = hub.courses().announcements_patch(...).doit().await
let r = hub.courses().course_work_add_on_attachments_student_submissions_get(...).doit().await
let r = hub.courses().course_work_add_on_attachments_student_submissions_patch(...).doit().await
let r = hub.courses().course_work_add_on_attachments_create(...).doit().await
let r = hub.courses().course_work_add_on_attachments_delete(...).doit().await
let r = hub.courses().course_work_add_on_attachments_get(...).doit().await
let r = hub.courses().course_work_add_on_attachments_list(...).doit().await
let r = hub.courses().course_work_add_on_attachments_patch(...).doit().await
let r = hub.courses().course_work_student_submissions_get(...).doit().await
let r = hub.courses().course_work_student_submissions_list(...).doit().await
let r = hub.courses().course_work_student_submissions_modify_attachments(...).doit().await
let r = hub.courses().course_work_student_submissions_patch(...).doit().await
let r = hub.courses().course_work_student_submissions_reclaim(...).doit().await
let r = hub.courses().course_work_student_submissions_return(...).doit().await
let r = hub.courses().course_work_student_submissions_turn_in(...).doit().await
let r = hub.courses().course_work_create(...).doit().await
let r = hub.courses().course_work_delete(...).doit().await
let r = hub.courses().course_work_get(...).doit().await
let r = hub.courses().course_work_get_add_on_context(...).doit().await
let r = hub.courses().course_work_list(...).doit().await
let r = hub.courses().course_work_modify_assignees(...).doit().await
let r = hub.courses().course_work_patch(...).doit().await
let r = hub.courses().course_work_materials_add_on_attachments_create(...).doit().await
let r = hub.courses().course_work_materials_add_on_attachments_delete(...).doit().await
let r = hub.courses().course_work_materials_add_on_attachments_get(...).doit().await
let r = hub.courses().course_work_materials_add_on_attachments_list(...).doit().await
let r = hub.courses().course_work_materials_add_on_attachments_patch(...).doit().await
let r = hub.courses().course_work_materials_create(...).doit().await
let r = hub.courses().course_work_materials_delete(...).doit().await
let r = hub.courses().course_work_materials_get(...).doit().await
let r = hub.courses().course_work_materials_get_add_on_context(...).doit().await
let r = hub.courses().course_work_materials_list(...).doit().await
let r = hub.courses().course_work_materials_patch(...).doit().await
let r = hub.courses().posts_add_on_attachments_student_submissions_get(...).doit().await
let r = hub.courses().posts_add_on_attachments_student_submissions_patch(...).doit().await
let r = hub.courses().posts_add_on_attachments_create(...).doit().await
let r = hub.courses().posts_add_on_attachments_delete(...).doit().await
let r = hub.courses().posts_add_on_attachments_get(...).doit().await
let r = hub.courses().posts_add_on_attachments_list(...).doit().await
let r = hub.courses().posts_add_on_attachments_patch(...).doit().await
let r = hub.courses().posts_get_add_on_context(...).doit().await
let r = hub.courses().students_create(...).doit().await
let r = hub.courses().students_delete(...).doit().await
let r = hub.courses().students_get(...).doit().await
let r = hub.courses().students_list(...).doit().await
let r = hub.courses().teachers_create(...).doit().await
let r = hub.courses().teachers_delete(...).doit().await
let r = hub.courses().teachers_get(...).doit().await
let r = hub.courses().teachers_list(...).doit().await
let r = hub.courses().topics_create(...).doit().await
let r = hub.courses().topics_delete(...).doit().await
let r = hub.courses().topics_get(...).doit().await
let r = hub.courses().topics_list(...).doit().await
let r = hub.courses().topics_patch(...).doit().await
let r = hub.courses().create(...).doit().await
let r = hub.courses().delete(...).doit().await
let r = hub.courses().get(...).doit().await
let r = hub.courses().list(...).doit().await
let r = hub.courses().patch(...).doit().await
let r = hub.courses().update(...).doit().await

resource()和activity(...)调用创建了构建器。第二个处理活动，支持配置即将进行的操作的各种方法（此处未显示）。它被设计成所有必需的参数都必须立即指定（即(...)），而所有可选的都可以按需构建。doit()方法执行与服务器实际通信并返回相应结果。

用法

设置你的项目

要使用这个库，你需要在你的Cargo.toml文件中放入以下几行

[dependencies]
google-classroom1 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的例子

extern crate hyper;
extern crate hyper_rustls;
extern crate google_classroom1 as classroom1;
use classroom1::api::AddOnAttachmentStudentSubmission;
use classroom1::{Result, Error};
use std::default::Default;
use classroom1::{Classroom, oauth2, hyper, hyper_rustls, chrono, FieldMask};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = Classroom::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = AddOnAttachmentStudentSubmission::default();

// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.courses().course_work_add_on_attachments_student_submissions_patch(req, "courseId", "itemId", "attachmentId", "submissionId")
             .update_mask(FieldMask::new::<&str>(&[]))
             .post_id("voluptua.")
             .doit().await;

match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::Io(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

处理错误

系统产生的所有错误都作为Result()枚举提供，作为doit()方法的返回值，或者作为可能的中间结果传递给Hub Delegate()或Authenticator Delegate()。

当代理处理错误或中间值时，它们可能会有机会指示系统重试。这使得系统可能对所有类型的错误都具有弹性。

上传和下载

如果方法支持下载，你应该读取响应体（它是Result()的一部分），以获取媒体。如果此类方法也支持ResponseResult()，则默认返回该值。你可以将其视为实际媒体的元数据。要触发媒体下载，你必须通过执行此调用来设置构建器：.param("alt", "media")。