Show / Hide Table of Contents

Class WatchRequest

Set up or update a new push notification watch on this user's mailbox.

Inheritance
object
WatchRequest
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.Gmail.v1.Data
Assembly: Google.Apis.Gmail.v1.dll
Syntax
public class WatchRequest : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

LabelFilterAction

Filtering behavior of labelIds list specified. This field is deprecated because it caused incorrect behavior in some cases; use label_filter_behavior instead.

Declaration
[JsonProperty("labelFilterAction")]
public virtual string LabelFilterAction { get; set; }
Property Value
Type Description
string

LabelFilterBehavior

Filtering behavior of labelIds list specified. This field replaces label_filter_action; if set, label_filter_action is ignored.

Declaration
[JsonProperty("labelFilterBehavior")]
public virtual string LabelFilterBehavior { get; set; }
Property Value
Type Description
string

LabelIds

List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated.

Declaration
[JsonProperty("labelIds")]
public virtual IList<string> LabelIds { get; set; }
Property Value
Type Description
IList<string>

TopicName

A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name must already exist in Cloud Pub/Sub and you must have already granted gmail "publish" permission on it. For example, "projects/my-project-identifier/topics/my-topic-name" (using the Cloud Pub/Sub "v1" topic naming format). Note that the "my-project-identifier" portion must exactly match your Google developer project id (the one executing this watch request).

Declaration
[JsonProperty("topicName")]
public virtual string TopicName { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX