com.google.api.services.forms.v1

Class Forms.FormsOperations.Watches

java.lang.Object

com.google.api.services.forms.v1.Forms.FormsOperations.Watches

Enclosing class:

Forms.FormsOperations

public class Forms.FormsOperations.Watches
extends Object

The "watches" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Forms.FormsOperations.Watches.Create
class	Forms.FormsOperations.Watches.Delete
class	Forms.FormsOperations.Watches.List
class	Forms.FormsOperations.Watches.Renew

Constructor Summary

Constructors

Constructor and Description
Watches()

Method Summary

Modifier and Type	Method and Description
Forms.FormsOperations.Watches.Create	create(String formId, CreateWatchRequest content) Create a new watch.
Forms.FormsOperations.Watches.Delete	delete(String formId, String watchId) Delete a watch.
Forms.FormsOperations.Watches.List	list(String formId) Return a list of the watches owned by the invoking project.
Forms.FormsOperations.Watches.Renew	renew(String formId, String watchId, RenewWatchRequest content) Renew an existing watch for seven days.

Methods inherited from class java.lang.Object

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

Constructor Detail

Watches

public Watches()

Method Detail

create

public Forms.FormsOperations.Watches.Create create(String formId,
                                                   CreateWatchRequest content)
                                            throws IOException

Create a new watch. If a watch ID is provided, it must be unused. For each invoking project, the per form limit is one watch per Watch.EventType. A watch expires seven days after it is created (see Watch.expire_time). Create a request for the method "watches.create". This request holds the parameters needed by the forms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

formId - Required. ID of the Form to watch.

content - the CreateWatchRequest

Returns:

the request

Throws:

IOException

delete

public Forms.FormsOperations.Watches.Delete delete(String formId,
                                                   String watchId)
                                            throws IOException

Delete a watch. Create a request for the method "watches.delete". This request holds the parameters needed by the forms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

formId - Required. The ID of the Form.

watchId - Required. The ID of the Watch to delete.

Returns:

the request

Throws:

IOException

list

public Forms.FormsOperations.Watches.List list(String formId)
                                        throws IOException

Return a list of the watches owned by the invoking project. The maximum number of watches is two: For each invoker, the limit is one for each event type per form. Create a request for the method "watches.list". This request holds the parameters needed by the forms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

formId - Required. ID of the Form whose watches to list.

Returns:

the request

Throws:

IOException

renew

public Forms.FormsOperations.Watches.Renew renew(String formId,
                                                 String watchId,
                                                 RenewWatchRequest content)
                                          throws IOException

Renew an existing watch for seven days. The state of the watch after renewal is `ACTIVE`, and the `expire_time` is seven days from the renewal. Renewing a watch in an error state (e.g. `SUSPENDED`) succeeds if the error is no longer present, but fail otherwise. After a watch has expired, RenewWatch returns `NOT_FOUND`. Create a request for the method "watches.renew". This request holds the parameters needed by the forms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

formId - Required. The ID of the Form.

watchId - Required. The ID of the Watch to renew.

content - the RenewWatchRequest

Returns:

the request

Throws:

IOException