Gérer les invitations aux cours

Une ressource Invitation dans Classroom représente une invitation pour un utilisateur à rejoindre un cours avec un rôle de cours spécifique : élève, enseignant ou propriétaire.

Chaque ressource Invitation contient les champs suivants :

  • id : identifiant attribué par Classroom à l'invitation.
  • userId : ID de l'utilisateur invité au cours.
  • courseId : cours auquel l'utilisateur est invité.
  • role : rôle dans le cours que l'utilisateur invité aura dans le cours.

Créer une invitation

La méthode invitations.create() permet d'inviter un utilisateur à un cours avec un rôle spécifique. Incluez la ressource Invitation dans le corps de la requête et spécifiez courseId, userId et 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;

Récupérer une invitation

Récupérez une invitation spécifique en appelant la méthode invitations.get() et en spécifiant le id de l'invitation.

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;

Accepter une invitation

Si vous acceptez une invitation, elle est supprimée et l'utilisateur invité est ajouté au cours avec le rôle spécifié dans l'invitation. Acceptez une invitation en appelant la méthode invitations.accept() et en spécifiant le id de l'invitation.

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

Supprimer une invitation

Pour modifier une invitation, vous devez la supprimer et en créer une autre. Pour supprimer l'invitation, appelez la méthode invitations.delete() et spécifiez le 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;
}
Précédent
Créer et gérer des enseignants et des élèves
Suivant
Créer et gérer des représentants légaux