Class Watch

A watch for events for a form. When the designated event happens, a notification will be published to the specified target. The notification's attributes will include a formId key that has the ID of the watched form and an eventType key that has the string of the type. Messages are sent with at-least-once delivery and are only dropped in extraordinary circumstances. Typically all notifications should be reliably delivered within a few seconds; however, in some situations notifications may be delayed. A watch expires seven days after it is created unless it is renewed with watches.renew

Inheritance

object

Watch

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Forms.v1.Data

Assembly: Google.Apis.Forms.v1.dll

Syntax

public class Watch : IDirectResponseSchema

Properties

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

Output only. Timestamp of when this was created.

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

ErrorType

Output only. The most recent error type for an attempted delivery. To begin watching the form again a call can be made to watches.renew which also clears this error information.

Declaration

[JsonProperty("errorType")]
public virtual string ErrorType { get; set; }

Property Value

Type	Description
string

EventType

Required. Which event type to watch for.

Declaration

[JsonProperty("eventType")]
public virtual string EventType { get; set; }

Property Value

Type	Description
string

ExpireTime

object representation of ExpireTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ExpireTimeDateTimeOffset instead.")]
public virtual object ExpireTime { get; set; }

Property Value

Type	Description
object

ExpireTimeDateTimeOffset

DateTimeOffset representation of ExpireTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? ExpireTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

ExpireTimeRaw

Output only. Timestamp for when this will expire. Each watches.renew call resets this to seven days in the future.

Declaration

[JsonProperty("expireTime")]
public virtual string ExpireTimeRaw { get; set; }

Property Value

Type	Description
string

Id

Output only. The ID of this watch. See notes on CreateWatchRequest.watch_id.

Declaration

[JsonProperty("id")]
public virtual string Id { get; set; }

Property Value

Type	Description
string

State

Output only. The current state of the watch. Additional details about suspended watches can be found by checking the error_type.

Declaration

[JsonProperty("state")]
public virtual string State { get; set; }

Property Value

Type	Description
string

Target

Required. Where to send the notification.

Declaration

[JsonProperty("target")]
public virtual WatchTarget Target { get; set; }

Property Value

Type	Description
WatchTarget

Implements

IDirectResponseSchema