REST Resource: registrations

Ressource: Registration

Instruction vers Classroom permettant d'envoyer des notifications depuis le feed vers la destination indiquée.

Représentation JSON 
{
  "registrationId": string,
  "feed": {
    object (Feed)
  },
  "expiryTime": string,

  // Union field destination can be only one of the following:
  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
  // End of list of possible types for union field destination.
}
Champs
registrationId

string

Identifiant unique généré par le serveur pour ce Registration.

En lecture seule.
feed

object (Feed)

Spécification pour la classe des notifications que Classroom doit envoyer à la destination.
expiryTime

string (Timestamp format)

Délai jusqu'à lequel l'Registration est effectif.

Il s'agit d'un champ en lecture seule attribué par le serveur.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
Champ d'union destination. Adresse à laquelle les notifications doivent être envoyées. destination ne peut être qu'un des éléments suivants :
cloudPubsubTopic

object (CloudPubsubTopic)

Le sujet Cloud Pub/Sub auquel les notifications doivent être envoyées.

Flux

Classe de notifications qu'une application peut s'inscrire pour recevoir. Par exemple : "toutes les modifications apportées à la liste d'élèves d'un domaine".

Représentation JSON 
{
  "feedType": enum (FeedType),

  // Union field info can be only one of the following:
  "courseRosterChangesInfo": {
    object (CourseRosterChangesInfo)
  },
  "courseWorkChangesInfo": {
    object (CourseWorkChangesInfo)
  }
  // End of list of possible types for union field info.
}
Champs
feedType

enum (FeedType)

Type de flux.
Champ d'union info. Paramètres supplémentaires concernant le flux. info ne peut être qu'un des éléments suivants :
courseRosterChangesInfo

object (CourseRosterChangesInfo)

Informations sur un Feed avec un feedType de COURSE_ROSTER_CHANGES. Ce champ doit être spécifié si feedType est défini sur COURSE_ROSTER_CHANGES.
courseWorkChangesInfo

object (CourseWorkChangesInfo)

Informations sur un Feed avec un feedType de COURSE_WORK_CHANGES. Ce champ doit être spécifié si feedType est défini sur COURSE_WORK_CHANGES.

FeedType

Type de flux à partir duquel une application peut s'enregistrer pour recevoir des notifications.

Enums
FEED_TYPE_UNSPECIFIED Ne doit jamais être renvoyé ni fourni.
DOMAIN_ROSTER_CHANGES

Toutes les modifications apportées à la liste d'élèves d'un domaine donné.

Des notifications sont générées chaque fois qu'un utilisateur rejoint ou quitte un cours.

Aucune notification n'est générée lors de la création ou de la suppression d'une invitation. En revanche, des notifications sont générées lorsqu'un utilisateur rejoint un cours en acceptant une invitation.
COURSE_ROSTER_CHANGES

Toutes les modifications apportées à la liste des élèves pour un cours donné.

Des notifications sont générées chaque fois qu'un utilisateur rejoint ou quitte un cours.

Aucune notification n'est générée lors de la création ou de la suppression d'une invitation. En revanche, des notifications sont générées lorsqu'un utilisateur rejoint un cours en acceptant une invitation.
COURSE_WORK_CHANGES

Toutes les activités de cours d'un cours particulier.

Des notifications seront générées lorsqu'un objet CourseWork ou StudentSubmission est créé ou modifié. Aucune notification ne sera générée lorsqu'un objet StudentSubmission est créé en lien avec la création ou la modification de son objet CourseWork parent (mais une notification sera générée pour la création ou la modification de cet objet CourseWork).

CourseRosterChangesInfo

Informations sur un Feed avec un feedType de COURSE_ROSTER_CHANGES.

Représentation JSON 
{
  "courseId": string
}
Champs
courseId

string

courseId du cours pour lequel vous souhaitez vous abonner aux modifications de la liste des élèves.

CourseWorkChangesInfo

Informations sur un Feed avec un feedType de COURSE_WORK_CHANGES.

Représentation JSON 
{
  "courseId": string
}
Champs
courseId

string

Le courseId du cours pour lequel s'abonner aux devoirs change.

CloudPubsubTopic

Référence à un sujet Cloud Pub/Sub.

Pour s'inscrire aux notifications, le propriétaire du sujet doit accorder à classroom-notifications@system.gserviceaccount.com l'autorisation projects.topics.publish.

Représentation JSON 
{
  "topicName": string
}
Champs
topicName

string

Champ name d'un sujet Cloud Pub/Sub.

Méthodes

create

 Crée un Registration, de sorte que Classroom commence à envoyer des notifications depuis le feed fourni vers la destination indiquée dans cloudPubSubTopic.

delete

 Supprime un Registration. Classroom n'envoie donc plus de notifications pour ce Registration.