REST Resource: registrations

Risorsa: registrazione

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

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)

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

string (Timestamp format)

La data e l'ora fino alle quali il Registration è valido.

Questo è un campo di sola lettura assegnato dal server.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
Campo unione destination. Dove devono essere inviate 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ò registrare per riceverle. Ad esempio: "tutte le modifiche al roster 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 unione info. Parametri aggiuntivi relativi al feed. info può essere solo uno dei seguenti:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

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

object (CourseWorkChangesInfo)

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

FeedType

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

Enum
FEED_TYPE_UNSPECIFIED Non deve mai essere restituito o fornito.
DOMAIN_ROSTER_CHANGES

Tutte le modifiche al roster per un determinato dominio.

Le notifiche verranno generate ogni volta che un utente si iscrive o lascia un corso.

Non verranno generate notifiche quando viene creato o eliminato un invito, ma verranno generate quando un utente partecipa a un corso accettando un invito.
COURSE_ROSTER_CHANGES

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

Le notifiche verranno generate ogni volta che un utente si iscrive o lascia un corso.

Non verranno generate notifiche quando viene creato o eliminato un invito, ma verranno generate quando un utente partecipa a un corso accettando un invito.
COURSE_WORK_CHANGES

Tutte le attività del corso per un determinato corso.

Le notifiche verranno generate quando viene creato o modificato un oggetto Corso o Contenuti inviati dagli studenti. Non verrà generata alcuna notifica quando viene creato un oggetto StudentSubmission in relazione alla creazione o alla modifica del relativo oggetto Coursework principale (ma verrà generata una notifica per la creazione o la modifica dell'oggetto Coursework).

CourseRosterChangesInfo

Informazioni su un Feed con un feedType di COURSE_ROSTER_CHANGES.

Rappresentazione JSON 
{
  "courseId": string
}
Campi
courseId

string

Il courseId del corso per cui vuoi iscriverti alle modifiche dell'elenco.

CourseWorkChangesInfo

Informazioni su un Feed con un feedType di COURSE_WORK_CHANGES.

Rappresentazione JSON 
{
  "courseId": string
}
Campi
courseId

string

Il courseId del corso a cui vuoi abbonarti per apportare modifiche al lavoro.

CloudPubsubTopic

Un riferimento a un argomento Cloud Pub/Sub.

Per registrarsi per 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, in modo che Classroom inizi a inviare notifiche dal feed fornito alla destinazione indicata in cloudPubSubTopic.

delete

 Elimina un Registration, facendo sì che Classroom interrompa l'invio di notifiche per quel Registration.