REST Resource: registrations

Risorsa: registrazione

Un'istruzione a Classroom per inviare notifiche da feed alla destinazione specificata.

Rappresentazione 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.
}
Campi
registrationId

string

Un identificatore univoco generato dal server per questo Registration.

Sola lettura.
feed

object (Feed)

Specifica per la classe di notifiche che Classroom deve inviare alla destinazione.
expiryTime

string (Timestamp format)

Il periodo di validità della Registration.

Si tratta di un campo di sola lettura assegnato dal server.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
Campo di unione destination. Indirizzo a cui inviare le notifiche. destination può essere solo uno dei seguenti:
cloudPubsubTopic

object (CloudPubsubTopic)

L'argomento Cloud Pub/Sub a cui devono essere inviate le notifiche.

Feed

Una classe di notifiche che un'applicazione può registrarsi per ricevere. Ad esempio: "tutte le modifiche all'elenco degli studenti per un dominio".

Rappresentazione 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.
}
Campi
feedType

enum (FeedType)

Il tipo di feed.
Campo di unione info. Parametri aggiuntivi relativi al feed. info può essere solo uno dei seguenti:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

Informazioni su Feed con feedType di COURSE_ROSTER_CHANGES. Questo campo deve essere specificato se feedType è COURSE_ROSTER_CHANGES.
courseWorkChangesInfo

object (CourseWorkChangesInfo)

Informazioni su Feed con feedType di COURSE_WORK_CHANGES. Questo campo deve essere specificato se feedType è COURSE_WORK_CHANGES.

FeedType

Un tipo di feed da cui un'applicazione può registrarsi per le notifiche.

Enum
FEED_TYPE_UNSPECIFIED Non deve mai essere restituito o fornito.
DOMAIN_ROSTER_CHANGES

Tutte le modifiche dell'elenco degli studenti per un determinato dominio.

Le notifiche verranno generate ogni volta che un utente partecipa a un corso o lo abbandona.

Non vengono generate notifiche quando viene creato o eliminato un invito, ma quando un utente si iscrive a un corso accettando un invito.
COURSE_ROSTER_CHANGES

Tutte le modifiche dell'elenco degli studenti per un determinato corso.

Le notifiche verranno generate ogni volta che un utente partecipa a un corso o lo abbandona.

Non vengono generate notifiche quando viene creato o eliminato un invito, ma quando un utente si iscrive a un corso accettando un invito.
COURSE_WORK_CHANGES

Tutte le attività lavorative del corso relative a un determinato corso.

Le notifiche verranno generate quando viene creato o modificato un oggetto CourseWork o StudentSubmission. Quando viene creato un oggetto StudentSubmission, non verrà generata alcuna notifica in relazione alla creazione o alla modifica dell'oggetto CourseWork principale, ma ne verrà generata una per la creazione o la modifica di quell'oggetto CourseWork.

CourseRosterChangesInfo

Informazioni su Feed con feedType di COURSE_ROSTER_CHANGES.

Rappresentazione JSON 
{
  "courseId": string
}
Campi
courseId

string

courseId del corso per cui richiedere l'iscrizione alle modifiche dell'elenco degli studenti.

CourseWorkChangesInfo

Informazioni su Feed con feedType di COURSE_WORK_CHANGES.

Rappresentazione JSON 
{
  "courseId": string
}
Campi
courseId

string

La courseId del corso per cui iscriverti alle modifiche al lavoro.

CloudPubsubTopic

Un riferimento a un argomento Cloud Pub/Sub.

Per ricevere le notifiche, il proprietario dell'argomento deve concedere a classroom-notifications@system.gserviceaccount.com l'autorizzazione projects.topics.publish.

Rappresentazione JSON 
{
  "topicName": string
}
Campi
topicName

string

Il campo name di un argomento Cloud Pub/Sub.

Metodi

create

 Crea un Registration e quindi Classroom inizia a inviare notifiche dal feed indicato alla destinazione indicata in cloudPubSubTopic.

delete

 Elimina un Registration, causando l'interruzione dell'invio di notifiche per quel Registration in Classroom.