ניהול הזמנות לקורסים

משאב הזמנה ב-Classroom מייצג הזמנה למשתמש להצטרף לקורס עם תפקיד ספציפי בקורס.

כל משאב Invitation מכיל את השדות הבאים:

  • id מההזמנה שהוקצו על ידי Classroom.
  • userId של המשתמש שאליו נשלחת ההזמנה.
  • courseId בקורס שאליו המשתמש מוזמן.
  • role התפקיד בקורס שיהיה למשתמש המוזמן בקורס.

יצירת הזמנה

כדי ליצור הזמנה שמאפשרת למשתמש להצטרף לקורס בתפקיד שצוין, צריך להפעיל את השיטה invitations.create(). כוללים את משאב ההזמנה בגוף הבקשה ומציינים את הערכים של courseId,‏ userId ו-role.

Java

classroom/snippets/src/main/java/CreateInvitation.java
Invitation invitation = null;
try {
  /* Set the role the user is invited to have in the course. Possible values of CourseRole can be
  found here: https://developers.google.com/classroom/reference/rest/v1/invitations#courserole.*/
  Invitation content =
      new Invitation().setCourseId(courseId).setUserId(userId).setRole("TEACHER");

  invitation = service.invitations().create(content).execute();

  System.out.printf(
      "User (%s) has been invited to course (%s).\n",
      invitation.getUserId(), invitation.getCourseId());
} catch (GoogleJsonResponseException e) {
  // TODO (developer) - handle error appropriately
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf("The course or user does not exist.\n");
  }
  throw e;
} catch (Exception e) {
  throw e;
}
return invitation;

אחזור הזמנה

כדי לאחזר הזמנה ספציפית, צריך לקרוא ל-method‏ invitations.get() ולציין את הערך של id של ההזמנה.

Java

classroom/snippets/src/main/java/GetInvitation.java
Invitation invitation = null;
try {
  invitation = service.invitations().get(id).execute();
  System.out.printf(
      "Invitation (%s) for user (%s) in course (%s) retrieved.\n",
      invitation.getId(), invitation.getUserId(), invitation.getCourseId());
} catch (GoogleJsonResponseException e) {
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf("The invitation id (%s) does not exist.\n", id);
  }
  throw e;
} catch (Exception e) {
  throw e;
}
return invitation;

אישור הזמנה

כשמאשרים הזמנה לקורס, המערכת מוחקת את ההזמנה ומוסיפה את המשתמש לקורס עם התפקיד שצוין בהזמנה. כדי לאשר הזמנה, צריך להפעיל את השיטה invitations.accept() ולציין את הערך של id בהזמנה.

Java

classroom/snippets/src/main/java/AcceptInvitation.java
try {
  service.invitations().accept(id).execute();
  System.out.printf("Invitation (%s) was accepted.\n", id);
} catch (GoogleJsonResponseException e) {
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf("The invitation id (%s) does not exist.\n", id);
  }
  throw e;
} catch (Exception e) {
  throw e;
}

מחיקת הזמנה

הדרך היחידה לעדכן הזמנה היא למחוק אותה וליצור הזמנה חדשה. כדי למחוק את ההזמנה, מפעילים את השיטה invitations.delete() ומציינים את id.

Java

classroom/snippets/src/main/java/DeleteInvitation.java
try {
  service.invitations().delete(id).execute();
  System.out.printf("Invitation (%s) was deleted.\n", id);
} catch (GoogleJsonResponseException e) {
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf("The invitation id (%s) does not exist.\n", id);
  }
  throw e;
} catch (Exception e) {
  throw e;
}