REST Resource: registrations

Risorsa: registrazione

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

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 tempo entro il quale Registration entrerà in vigore.

Questo è un campo di sola lettura assegnato dal server.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

Campo 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ò registrare per ricevere. Ad esempio: "tutte le modifiche agli elenchi 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 unione info. Parametri aggiuntivi del feed. info può essere solo uno dei seguenti:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

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

courseWorkChangesInfo

object (CourseWorkChangesInfo)

Informazioni su un 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ò registrare le notifiche.

Enum
FEED_TYPE_UNSPECIFIED Non deve mai essere restituito o fornito.
DOMAIN_ROSTER_CHANGES

Tutte le modifiche agli elenchi degli studenti per un determinato dominio.

Le notifiche vengono generate ogni volta che un utente si iscrive a un corso o lo abbandona.

Non verranno generate notifiche quando viene creato o eliminato un invito, ma quando un utente accetta un invito per partecipare a un corso.

COURSE_ROSTER_CHANGES

Tutte le modifiche agli elenchi degli studenti per un determinato corso.

Le notifiche vengono generate ogni volta che un utente si iscrive a un corso o lo abbandona.

Non verranno generate notifiche quando viene creato o eliminato un invito, ma quando un utente accetta un invito per partecipare a un corso.

COURSE_WORK_CHANGES

Tutte le attività lavorative di un determinato corso.

Le notifiche verranno generate quando viene creato o modificato un oggetto CourseWork o StudentSubmission. Non verrà generata alcuna notifica quando viene creato un oggetto StudentSubmission in relazione alla creazione o alla modifica dell'oggetto CourseWork principale (ma verrà generata una notifica per la creazione o la modifica dell'oggetto CourseWork).

CourseRosterChangesInfo

Informazioni su un Feed con feedType di COURSE_ROSTER_CHANGES.

Rappresentazione JSON
{
  "courseId": string
}
Campi
courseId

string

I courseId del corso per cui iscriversi alle modifiche all'elenco degli studenti.

CourseWorkChangesInfo

Informazioni su un Feed con feedType di COURSE_WORK_CHANGES.

Rappresentazione JSON
{
  "courseId": string
}
Campi
courseId

string

Il courseId del corso a cui iscriverti per il lavoro cambia.

CloudPubsubTopic

Un riferimento a un argomento di 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 elemento Registration, impedendo a Classroom di iniziare a inviare notifiche dal dispositivo feed fornito alla destinazione indicata in cloudPubSubTopic.

delete

Elimina un Registration, impedendo a Classroom l'invio di notifiche per quel Registration.