com.google.api.services.classroom

Class Classroom.Registrations

java.lang.Object

com.google.api.services.classroom.Classroom.Registrations

Enclosing class:

Classroom

public class Classroom.Registrations
extends Object

The "registrations" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Classroom.Registrations.Create
class	Classroom.Registrations.Delete

Constructor Summary

Constructors

Constructor and Description
Registrations()

Method Summary

Modifier and Type	Method and Description
Classroom.Registrations.Create	create(Registration content) Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`.
Classroom.Registrations.Delete	delete(String registrationId) Deletes a `Registration`, causing Classroom to stop sending notifications for that `Registration`.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Registrations

public Registrations()

Method Detail

create

public Classroom.Registrations.Create create(Registration content)
                                      throws IOException

Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`. Returns the created `Registration`. Currently, this will be the same as the argument, but with server-assigned fields such as `expiry_time` and `id` filled in. Note that any value specified for the `expiry_time` or `id` fields will be ignored. While Classroom may validate the `cloudPubSubTopic` and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: * `PERMISSION_DENIED` if: * the authenticated user does not have permission to receive notifications from the requested field; or * the current user has not granted access to the current Cloud project with the appropriate scope for the requested feed. Note that domain-wide delegation of authority is not currently supported for this purpose. If the request has the appropriate scope, but no grant exists, a Request Errors is returned. * another access error is encountered. * `INVALID_ARGUMENT` if: * no `cloudPubsubTopic` is specified, or the specified `cloudPubsubTopic` is not valid; or * no `feed` is specified, or the specified `feed` is not valid. * `NOT_FOUND` if: * the specified `feed` cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified `cloudPubsubTopic` cannot be located, or Classroom has not been granted permission to publish to it. Create a request for the method "registrations.create". This request holds the parameters needed by the classroom server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the Registration

Returns:

the request

Throws:

IOException

delete

public Classroom.Registrations.Delete delete(String registrationId)
                                      throws IOException

Deletes a `Registration`, causing Classroom to stop sending notifications for that `Registration`. Create a request for the method "registrations.delete". This request holds the parameters needed by the classroom server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

registrationId - The `registration_id` of the `Registration` to be deleted.

Returns:

the request

Throws:

IOException