Class ChangesResource.WatchRequest
Subscribes to changes for a user.
Inheritance
Inherited Members
Namespace: Google.Apis.Drive.v3
Assembly: Google.Apis.Drive.v3.dll
Syntax
public class ChangesResource.WatchRequest : DriveBaseServiceRequest<Channel>, IClientServiceRequest<Channel>, IClientServiceRequest
Constructors
WatchRequest(IClientService, Channel, string)
Constructs a new Watch request.
Declaration
public WatchRequest(IClientService service, Channel body, string pageToken)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
Channel | body | |
string | pageToken |
Properties
DriveId
The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.
Declaration
[RequestParameter("driveId", RequestParameterType.Query)]
public virtual string DriveId { get; set; }
Property Value
Type | Description |
---|---|
string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
IncludeCorpusRemovals
Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.
Declaration
[RequestParameter("includeCorpusRemovals", RequestParameterType.Query)]
public virtual bool? IncludeCorpusRemovals { get; set; }
Property Value
Type | Description |
---|---|
bool? |
IncludeItemsFromAllDrives
Whether both My Drive and shared drive items should be included in results.
Declaration
[RequestParameter("includeItemsFromAllDrives", RequestParameterType.Query)]
public virtual bool? IncludeItemsFromAllDrives { get; set; }
Property Value
Type | Description |
---|---|
bool? |
IncludeLabels
A comma-separated list of IDs of labels to include in the labelInfo
part of the response.
Declaration
[RequestParameter("includeLabels", RequestParameterType.Query)]
public virtual string IncludeLabels { get; set; }
Property Value
Type | Description |
---|---|
string |
IncludePermissionsForView
Specifies which additional view's permissions to include in the response. Only 'published' is supported.
Declaration
[RequestParameter("includePermissionsForView", RequestParameterType.Query)]
public virtual string IncludePermissionsForView { get; set; }
Property Value
Type | Description |
---|---|
string |
IncludeRemoved
Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
Declaration
[RequestParameter("includeRemoved", RequestParameterType.Query)]
public virtual bool? IncludeRemoved { get; set; }
Property Value
Type | Description |
---|---|
bool? |
IncludeTeamDriveItems
Deprecated: Use includeItemsFromAllDrives
instead.
Declaration
[RequestParameter("includeTeamDriveItems", RequestParameterType.Query)]
public virtual bool? IncludeTeamDriveItems { get; set; }
Property Value
Type | Description |
---|---|
bool? |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
PageSize
The maximum number of changes to return per page.
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type | Description |
---|---|
int? |
PageToken
The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
RestrictToMyDrive
Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.
Declaration
[RequestParameter("restrictToMyDrive", RequestParameterType.Query)]
public virtual bool? RestrictToMyDrive { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Spaces
A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.
Declaration
[RequestParameter("spaces", RequestParameterType.Query)]
public virtual string Spaces { get; set; }
Property Value
Type | Description |
---|---|
string |
SupportsAllDrives
Whether the requesting application supports both My Drives and shared drives.
Declaration
[RequestParameter("supportsAllDrives", RequestParameterType.Query)]
public virtual bool? SupportsAllDrives { get; set; }
Property Value
Type | Description |
---|---|
bool? |
SupportsTeamDrives
Deprecated: Use supportsAllDrives
instead.
Declaration
[RequestParameter("supportsTeamDrives", RequestParameterType.Query)]
public virtual bool? SupportsTeamDrives { get; set; }
Property Value
Type | Description |
---|---|
bool? |
TeamDriveId
Deprecated: Use driveId
instead.
Declaration
[RequestParameter("teamDriveId", RequestParameterType.Query)]
public virtual string TeamDriveId { get; set; }
Property Value
Type | Description |
---|---|
string |
Methods
GetBody()
Returns the body of the request.
Declaration
protected override object GetBody()
Returns
Type | Description |
---|---|
object |
Overrides
InitParameters()
Initializes Watch parameter list.
Declaration
protected override void InitParameters()