Kurseinladungen verwalten

Eine Invitation-Ressource in Classroom stellt eine Einladung für einen Nutzer dar, einem Kurs mit einer bestimmten Kursrolle beizutreten: Schüler/Student, Lehrkraft oder Inhaber.

Jede Invitation-Ressource enthält die folgenden Felder:

  • id: Die Classroom-zugewiesene Kennung für die Einladung.
  • userId: Die ID des Nutzers, der zum Kurs eingeladen wurde.
  • courseId: Der Kurs, zu dem der Nutzer eingeladen wird.
  • role: Die Kursrolle, die der eingeladene Nutzer im Kurs haben wird.

Einladung erstellen

Mit der Methode invitations.create() können Sie einen Nutzer mit einer bestimmten Rolle zu einem Kurs einladen. Fügen Sie die Invitation-Ressource in den Anfragetext ein und geben Sie courseId, userId und role an.

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;

Einladung abrufen

Rufen Sie eine bestimmte Einladung ab, indem Sie die Methode invitations.get() aufrufen und die id der Einladung angeben.

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;

Einladung annehmen

Wenn Sie eine Einladung annehmen, wird die Einladung gelöscht und der eingeladene Nutzer wird dem Kurs mit der in der Einladung angegebenen Rolle hinzugefügt. Nehmen Sie eine Einladung an, indem Sie die Methode invitations.accept() aufrufen und die id der Einladung angeben.

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;
}

Einladung löschen

Einladungen können nur aktualisiert werden, indem Sie sie löschen und eine neue Einladung erstellen. Rufen Sie zum Löschen der Einladung die Methode invitations.delete() auf und geben Sie die id an.

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;
}