Class FormsResource.WatchesResource
The "watches" collection of methods.
Inherited Members
Namespace: Google.Apis.Forms.v1
Assembly: Google.Apis.Forms.v1.dll
Syntax
public class FormsResource.WatchesResource
Constructors
WatchesResource(IClientService)
Constructs a new resource.
Declaration
public WatchesResource(IClientService service)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service |
Methods
Create(CreateWatchRequest, string)
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).
Declaration
public virtual FormsResource.WatchesResource.CreateRequest Create(CreateWatchRequest body, string formId)
Parameters
Type | Name | Description |
---|---|---|
CreateWatchRequest | body | The body of the request. |
string | formId | Required. ID of the Form to watch. |
Returns
Type | Description |
---|---|
FormsResource.WatchesResource.CreateRequest |
Delete(string, string)
Delete a watch.
Declaration
public virtual FormsResource.WatchesResource.DeleteRequest Delete(string formId, string watchId)
Parameters
Type | Name | Description |
---|---|---|
string | formId | Required. The ID of the Form. |
string | watchId | Required. The ID of the Watch to delete. |
Returns
Type | Description |
---|---|
FormsResource.WatchesResource.DeleteRequest |
List(string)
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.
Declaration
public virtual FormsResource.WatchesResource.ListRequest List(string formId)
Parameters
Type | Name | Description |
---|---|---|
string | formId | Required. ID of the Form whose watches to list. |
Returns
Type | Description |
---|---|
FormsResource.WatchesResource.ListRequest |
Renew(RenewWatchRequest, string, string)
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
.
Declaration
public virtual FormsResource.WatchesResource.RenewRequest Renew(RenewWatchRequest body, string formId, string watchId)
Parameters
Type | Name | Description |
---|---|---|
RenewWatchRequest | body | The body of the request. |
string | formId | Required. The ID of the Form. |
string | watchId | Required. The ID of the Watch to renew. |
Returns
Type | Description |
---|---|
FormsResource.WatchesResource.RenewRequest |