All Downloads are FREE. Search and download functionalities are using the official Maven repository.

target.apidocs.com.google.api.services.drive.Drive.Changes.Watch.html Maven / Gradle / Ivy

Go to download

There is a newer version: v3-rev20241027-2.0.0
Show newest version






Drive.Changes.Watch (Google Drive API v3-rev20240123-2.0.0)













Skip navigation links
































com.google.api.services.drive


Class Drive.Changes.Watch



















    

  • 


      

    • 



      Constructor Detail
      




        

      • 

        Watch
        

        protected Watch(String pageToken,
                Channel content)
        

        Subscribes to changes for a user.

 Create a request for the method "changes.watch".

 This request holds the parameters needed by the the drive server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation. 
         Drive.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must
 be called to initialize this instance immediately after invoking the constructor. 
        

        

        Parameters:
        

        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.
        

        content - the Channel
        

        Since:
        

        1.13
        

        

        • 

      

      • 

    


      

    • 



      Method Detail
      
















































        

      • 

        getPageToken
        

        public String getPageToken()
        

        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.
        

        • 

      




        

      • 

        setPageToken
        

        public Drive.Changes.Watch setPageToken(String 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.
        

        • 

      




        

      • 

        getDriveId
        

        public String getDriveId()
        

        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.
        

        • 

      




        

      • 

        setDriveId
        

        public Drive.Changes.Watch setDriveId(String 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.
        

        • 

      




        

      • 

        getIncludeCorpusRemovals
        

        public Boolean getIncludeCorpusRemovals()
        

        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. [default: false]
        

        • 

      




        

      • 

        setIncludeCorpusRemovals
        

        public Drive.Changes.Watch setIncludeCorpusRemovals(Boolean 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.
        

        • 

      




        

      • 

        isIncludeCorpusRemovals
        

        public boolean isIncludeCorpusRemovals()
        

        Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

 
        
 Boolean properties can have four possible values:
 null, Data.NULL_BOOLEAN, Boolean.TRUE
 or Boolean.FALSE.
 
        

 
        
 This method returns Boolean.TRUE if the default of the property is Boolean.TRUE
 and it is null or Data.NULL_BOOLEAN.
 Boolean.FALSE is returned if the default of the property is Boolean.FALSE and
 it is null or Data.NULL_BOOLEAN.
 
        

 
        
 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.
 
        

        • 

      




        

      • 

        getIncludeItemsFromAllDrives
        

        public Boolean getIncludeItemsFromAllDrives()
        

        Whether both My Drive and shared drive items should be included in results. [default: false]
        

        • 

      




        

      • 

        setIncludeItemsFromAllDrives
        

        public Drive.Changes.Watch setIncludeItemsFromAllDrives(Boolean includeItemsFromAllDrives)
        

        Whether both My Drive and shared drive items should be included in results.
        

        • 

      




        

      • 

        isIncludeItemsFromAllDrives
        

        public boolean isIncludeItemsFromAllDrives()
        

        Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

 
        
 Boolean properties can have four possible values:
 null, Data.NULL_BOOLEAN, Boolean.TRUE
 or Boolean.FALSE.
 
        

 
        
 This method returns Boolean.TRUE if the default of the property is Boolean.TRUE
 and it is null or Data.NULL_BOOLEAN.
 Boolean.FALSE is returned if the default of the property is Boolean.FALSE and
 it is null or Data.NULL_BOOLEAN.
 
        

 
        
 Whether both My Drive and shared drive items should be included in results.
 
        

        • 

      




        

      • 

        getIncludeLabels
        

        public String getIncludeLabels()
        

        A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
        

        • 

      




        

      • 

        setIncludeLabels
        

        public Drive.Changes.Watch setIncludeLabels(String includeLabels)
        

        A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
        

        • 

      




        

      • 

        getIncludePermissionsForView
        

        public String getIncludePermissionsForView()
        

        Specifies which additional view's permissions to include in the response. Only 'published' is
     supported.
        

        • 

      




        

      • 

        setIncludePermissionsForView
        

        public Drive.Changes.Watch setIncludePermissionsForView(String includePermissionsForView)
        

        Specifies which additional view's permissions to include in the response. Only 'published'
 is supported.
        

        • 

      




        

      • 

        getIncludeRemoved
        

        public Boolean getIncludeRemoved()
        

        Whether to include changes indicating that items have been removed from the list of changes, for
     example by deletion or loss of access. [default: true]
        

        • 

      




        

      • 

        setIncludeRemoved
        

        public Drive.Changes.Watch setIncludeRemoved(Boolean includeRemoved)
        

        Whether to include changes indicating that items have been removed from the list of
 changes, for example by deletion or loss of access.
        

        • 

      




        

      • 

        isIncludeRemoved
        

        public boolean isIncludeRemoved()
        

        Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

 
        
 Boolean properties can have four possible values:
 null, Data.NULL_BOOLEAN, Boolean.TRUE
 or Boolean.FALSE.
 
        

 
        
 This method returns Boolean.TRUE if the default of the property is Boolean.TRUE
 and it is null or Data.NULL_BOOLEAN.
 Boolean.FALSE is returned if the default of the property is Boolean.FALSE and
 it is null or Data.NULL_BOOLEAN.
 
        

 
        
 Whether to include changes indicating that items have been removed from the list of changes, for
     example by deletion or loss of access.
 
        

        • 

      




        

      • 

        getIncludeTeamDriveItems
        

        public Boolean getIncludeTeamDriveItems()
        

        Deprecated: Use `includeItemsFromAllDrives` instead. [default: false]
        

        • 

      




        

      • 

        setIncludeTeamDriveItems
        

        public Drive.Changes.Watch setIncludeTeamDriveItems(Boolean includeTeamDriveItems)
        

        Deprecated: Use `includeItemsFromAllDrives` instead.
        

        • 

      




        

      • 

        isIncludeTeamDriveItems
        

        public boolean isIncludeTeamDriveItems()
        

        Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

 
        
 Boolean properties can have four possible values:
 null, Data.NULL_BOOLEAN, Boolean.TRUE
 or Boolean.FALSE.
 
        

 
        
 This method returns Boolean.TRUE if the default of the property is Boolean.TRUE
 and it is null or Data.NULL_BOOLEAN.
 Boolean.FALSE is returned if the default of the property is Boolean.FALSE and
 it is null or Data.NULL_BOOLEAN.
 
        

 
        
 Deprecated: Use `includeItemsFromAllDrives` instead.
 
        

        • 

      




        

      • 

        getPageSize
        

        public Integer getPageSize()
        

        The maximum number of changes to return per page. [default: 100] [minimum: 1] [maximum: 1000]
        

        • 

      








        

      • 

        getRestrictToMyDrive
        

        public Boolean getRestrictToMyDrive()
        

        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. [default: false]
        

        • 

      




        

      • 

        setRestrictToMyDrive
        

        public Drive.Changes.Watch setRestrictToMyDrive(Boolean 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.
        

        • 

      




        

      • 

        isRestrictToMyDrive
        

        public boolean isRestrictToMyDrive()
        

        Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

 
        
 Boolean properties can have four possible values:
 null, Data.NULL_BOOLEAN, Boolean.TRUE
 or Boolean.FALSE.
 
        

 
        
 This method returns Boolean.TRUE if the default of the property is Boolean.TRUE
 and it is null or Data.NULL_BOOLEAN.
 Boolean.FALSE is returned if the default of the property is Boolean.FALSE and
 it is null or Data.NULL_BOOLEAN.
 
        

 
        
 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.
 
        

        • 

      




        

      • 

        getSpaces
        

        public String getSpaces()
        

        A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and
     'appDataFolder'. [default: drive]
        

        • 

      




        

      • 

        setSpaces
        

        public Drive.Changes.Watch setSpaces(String spaces)
        

        A comma-separated list of spaces to query within the corpora. Supported values are 'drive'
 and 'appDataFolder'.
        

        • 

      




        

      • 

        getSupportsAllDrives
        

        public Boolean getSupportsAllDrives()
        

        Whether the requesting application supports both My Drives and shared drives. [default: false]
        

        • 

      




        

      • 

        setSupportsAllDrives
        

        public Drive.Changes.Watch setSupportsAllDrives(Boolean supportsAllDrives)
        

        Whether the requesting application supports both My Drives and shared drives.
        

        • 

      




        

      • 

        isSupportsAllDrives
        

        public boolean isSupportsAllDrives()
        

        Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

 
        
 Boolean properties can have four possible values:
 null, Data.NULL_BOOLEAN, Boolean.TRUE
 or Boolean.FALSE.
 
        

 
        
 This method returns Boolean.TRUE if the default of the property is Boolean.TRUE
 and it is null or Data.NULL_BOOLEAN.
 Boolean.FALSE is returned if the default of the property is Boolean.FALSE and
 it is null or Data.NULL_BOOLEAN.
 
        

 
        
 Whether the requesting application supports both My Drives and shared drives.
 
        

        • 

      




        

      • 

        getSupportsTeamDrives
        

        public Boolean getSupportsTeamDrives()
        

        Deprecated: Use `supportsAllDrives` instead. [default: false]
        

        • 

      




        

      • 

        setSupportsTeamDrives
        

        public Drive.Changes.Watch setSupportsTeamDrives(Boolean supportsTeamDrives)
        

        Deprecated: Use `supportsAllDrives` instead.
        

        • 

      




        

      • 

        isSupportsTeamDrives
        

        public boolean isSupportsTeamDrives()
        

        Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

 
        
 Boolean properties can have four possible values:
 null, Data.NULL_BOOLEAN, Boolean.TRUE
 or Boolean.FALSE.
 
        

 
        
 This method returns Boolean.TRUE if the default of the property is Boolean.TRUE
 and it is null or Data.NULL_BOOLEAN.
 Boolean.FALSE is returned if the default of the property is Boolean.FALSE and
 it is null or Data.NULL_BOOLEAN.
 
        

 
        
 Deprecated: Use `supportsAllDrives` instead.
 
        

        • 

      




        

      • 

        getTeamDriveId
        

        public String getTeamDriveId()
        

        Deprecated: Use `driveId` instead.
        

        • 

      









      • 

    

    • 













Skip navigation links





























Copyright © 2011–2024 Google. All rights reserved.




© 2015 - 2024 Weber Informatics LLC | Privacy Policy