REST Resource: registrations

Ressource : Registration

Instruction demandant à Classroom d'envoyer des notifications depuis le feed vers la destination fournie.

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

  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
}
Champs
registrationId

string

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

Lecture seule.
feed

object (Feed)

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

string (Timestamp format)

Heure jusqu'à laquelle le Registration est effectif.

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

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
Emplacement où les notifications doivent être envoyées. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
cloudPubsubTopic

object (CloudPubsubTopic)

Sujet Cloud Pub/Sub auquel les notifications doivent être envoyées.
Fin des champs mutuellement exclusifs.

Flux

Classe de notifications qu'une application peut s'enregistrer pour recevoir. Par exemple : "toutes les modifications de la liste des élèves pour un domaine".

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

  "courseRosterChangesInfo": {
    object (CourseRosterChangesInfo)
  },
  "courseWorkChangesInfo": {
    object (CourseWorkChangesInfo)
  }
}
Champs
feedType

enum (FeedType)

Type de flux.
Paramètres supplémentaires concernant le flux. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
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.
Fin des champs mutuellement exclusifs.

FeedType

Type de flux auquel 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 des élèves d'un domaine particulier.

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

Aucune notification n'est générée lorsqu'une invitation est créée ou supprimée, mais 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 d'un cours donné.

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

Aucune notification n'est générée lorsqu'une invitation est créée ou supprimée, mais 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 travail scolaire pour un cours particulier.

Des notifications seront générées lorsqu'un objet CourseWork ou StudentSubmission sera créé ou modifié. Aucune notification n'est 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 est 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

courseId du cours pour lequel vous souhaitez vous abonner aux modifications des devoirs.

CloudPubsubTopic

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

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

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

string

Le champ name d'un sujet Cloud Pub/Sub.

Méthodes

create

 Crée un Registration, ce qui amène Classroom à commencer à envoyer des notifications depuis le feed fourni vers la destination fournie dans cloudPubSubTopic.

delete

 Supprime un Registration, ce qui empêche Classroom d'envoyer des notifications pour ce Registration.