drive  v2
Public Member Functions | List of all members
google_drive_api::ChangesResource_WatchMethod Class Reference

#include <drive_service.h>

Inheritance diagram for google_drive_api::ChangesResource_WatchMethod:
google_drive_api::DriveServiceBaseRequest

Public Member Functions

 ChangesResource_WatchMethod (const DriveService *_service_, client::AuthorizationCredential *_credential_, const Channel &_content_)
 
virtual ~ChangesResource_WatchMethod ()
 
void clear_drive_id ()
 
const string & get_drive_id () const
 
string * mutable_driveId ()
 
void set_drive_id (const string &value)
 
void clear_include_corpus_removals ()
 
bool get_include_corpus_removals () const
 
void set_include_corpus_removals (bool value)
 
void clear_include_deleted ()
 
bool get_include_deleted () const
 
void set_include_deleted (bool value)
 
void clear_include_items_from_all_drives ()
 
bool get_include_items_from_all_drives () const
 
void set_include_items_from_all_drives (bool value)
 
void clear_include_subscribed ()
 
bool get_include_subscribed () const
 
void set_include_subscribed (bool value)
 
void clear_include_team_drive_items ()
 
bool get_include_team_drive_items () const
 
void set_include_team_drive_items (bool value)
 
void clear_max_results ()
 
int32 get_max_results () const
 
void set_max_results (int32 value)
 
void clear_page_token ()
 
const string & get_page_token () const
 
string * mutable_pageToken ()
 
void set_page_token (const string &value)
 
void clear_spaces ()
 
const string & get_spaces () const
 
string * mutable_spaces ()
 
void set_spaces (const string &value)
 
void clear_start_change_id ()
 
int64 get_start_change_id () const
 
void set_start_change_id (int64 value)
 
void clear_supports_all_drives ()
 
bool get_supports_all_drives () const
 
void set_supports_all_drives (bool value)
 
void clear_supports_team_drives ()
 
bool get_supports_team_drives () const
 
void set_supports_team_drives (bool value)
 
void clear_team_drive_id ()
 
const string & get_team_drive_id () const
 
string * mutable_teamDriveId ()
 
void set_team_drive_id (const string &value)
 
virtual util::Status AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
 
virtual util::Status AppendOptionalQueryParameters (string *target)
 
util::Status ExecuteAndParseResponse (Channel *data)
 
- Public Member Functions inherited from google_drive_api::DriveServiceBaseRequest
 DriveServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)
 
virtual ~DriveServiceBaseRequest ()
 
void clear_alt ()
 
const string & get_alt () const
 
string * mutable_alt ()
 
void set_alt (const string &value)
 
void clear_fields ()
 
const string & get_fields () const
 
string * mutable_fields ()
 
void set_fields (const string &value)
 
void clear_key ()
 
const string & get_key () const
 
string * mutable_key ()
 
void set_key (const string &value)
 
void clear_oauth_token ()
 
const string & get_oauth_token () const
 
string * mutable_oauthToken ()
 
void set_oauth_token (const string &value)
 
void clear_pretty_print ()
 
bool get_pretty_print () const
 
void set_pretty_print (bool value)
 
void clear_quota_user ()
 
const string & get_quota_user () const
 
string * mutable_quotaUser ()
 
void set_quota_user (const string &value)
 
void clear_user_ip ()
 
const string & get_user_ip () const
 
string * mutable_userIp ()
 
void set_user_ip (const string &value)
 

Additional Inherited Members

- Protected Member Functions inherited from google_drive_api::DriveServiceBaseRequest
void AddJsonContentToRequest (const client::JsonCppData *content)
 

Detailed Description

Implements the watch method.

This class uses the Command Pattern. Construct an instance with the required parameters, then set any additional optional parameters by using the attribute setters. To invoke the method, call Execute.

One or more of these authorization scopes are required for this method: https://www.googleapis.com/auth/drive https://www.googleapis.com/auth/drive.appdata https://www.googleapis.com/auth/drive.apps.readonly https://www.googleapis.com/auth/drive.file https://www.googleapis.com/auth/drive.metadata https://www.googleapis.com/auth/drive.metadata.readonly https://www.googleapis.com/auth/drive.photos.readonly https://www.googleapis.com/auth/drive.readonly

Constructor & Destructor Documentation

◆ ChangesResource_WatchMethod()

google_drive_api::ChangesResource_WatchMethod::ChangesResource_WatchMethod ( const DriveService _service_,
client::AuthorizationCredential *  _credential_,
const Channel _content_ 
)

The standard constructor takes all the required method parameters.

Parameters
[in]<em>service</em>The service instance to send to when executed.
[in]<em>credential</em>If not NULL, the credential to authorize with. In practice this is supplied by the user code that is creating the method instance.
[in]<em>content</em>The data object to watch.

◆ ~ChangesResource_WatchMethod()

google_drive_api::ChangesResource_WatchMethod::~ChangesResource_WatchMethod ( )
virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_drive_api::ChangesResource_WatchMethod::AppendOptionalQueryParameters ( string *  target)
virtual

Appends the optional query parameters to the target URL.

Parameters
[in,out]targetThe URL string to append to.

Reimplemented from google_drive_api::DriveServiceBaseRequest.

◆ AppendVariable()

util::Status google_drive_api::ChangesResource_WatchMethod::AppendVariable ( const StringPiece &  variable_name,
const client::UriTemplateConfig &  config,
string *  target 
)
virtual

Appends variable value to the target string.

This is a helper function used to resolve templated variables in the URI.

Parameters
[in]variable_nameThe name of the templated variable.
[in]configA pass-through parameter used for lists and maps.
[in,out]targetThe string to append the value to.

Reimplemented from google_drive_api::DriveServiceBaseRequest.

◆ clear_drive_id()

void google_drive_api::ChangesResource_WatchMethod::clear_drive_id ( )
inline

Clears the 'driveId' attribute so it is no longer set.

◆ clear_include_corpus_removals()

void google_drive_api::ChangesResource_WatchMethod::clear_include_corpus_removals ( )
inline

Clears the 'includeCorpusRemovals' attribute so it is no longer set.

◆ clear_include_deleted()

void google_drive_api::ChangesResource_WatchMethod::clear_include_deleted ( )
inline

Clears the 'includeDeleted' attribute so it is no longer set.

◆ clear_include_items_from_all_drives()

void google_drive_api::ChangesResource_WatchMethod::clear_include_items_from_all_drives ( )
inline

Clears the 'includeItemsFromAllDrives' attribute so it is no longer set.

◆ clear_include_subscribed()

void google_drive_api::ChangesResource_WatchMethod::clear_include_subscribed ( )
inline

Clears the 'includeSubscribed' attribute so it is no longer set.

◆ clear_include_team_drive_items()

void google_drive_api::ChangesResource_WatchMethod::clear_include_team_drive_items ( )
inline

Clears the 'includeTeamDriveItems' attribute so it is no longer set.

◆ clear_max_results()

void google_drive_api::ChangesResource_WatchMethod::clear_max_results ( )
inline

Clears the 'maxResults' attribute so it is no longer set.

◆ clear_page_token()

void google_drive_api::ChangesResource_WatchMethod::clear_page_token ( )
inline

Clears the 'pageToken' attribute so it is no longer set.

◆ clear_spaces()

void google_drive_api::ChangesResource_WatchMethod::clear_spaces ( )
inline

Clears the 'spaces' attribute so it is no longer set.

◆ clear_start_change_id()

void google_drive_api::ChangesResource_WatchMethod::clear_start_change_id ( )
inline

Clears the 'startChangeId' attribute so it is no longer set.

◆ clear_supports_all_drives()

void google_drive_api::ChangesResource_WatchMethod::clear_supports_all_drives ( )
inline

Clears the 'supportsAllDrives' attribute so it is no longer set.

◆ clear_supports_team_drives()

void google_drive_api::ChangesResource_WatchMethod::clear_supports_team_drives ( )
inline

Clears the 'supportsTeamDrives' attribute so it is no longer set.

◆ clear_team_drive_id()

void google_drive_api::ChangesResource_WatchMethod::clear_team_drive_id ( )
inline

Clears the 'teamDriveId' attribute so it is no longer set.

◆ ExecuteAndParseResponse()

util::Status google_drive_api::ChangesResource_WatchMethod::ExecuteAndParseResponse ( Channel data)
inline

Executes the method and parses the response into a data object on success.

Parameters
[out]dataLoads from the response payload JSON data on success.
Returns
Success if an HTTP 2xx response was received. Otherwise the status indicates the reason for failure. Finer detail may be available from the underlying http_request to distinguish the transport_status from the overal HTTP request status.

◆ get_drive_id()

const string& google_drive_api::ChangesResource_WatchMethod::get_drive_id ( ) const
inline

Gets the optional 'driveId' attribute.

If the value is not set then the default value will be returned.

◆ get_include_corpus_removals()

bool google_drive_api::ChangesResource_WatchMethod::get_include_corpus_removals ( ) const
inline

Gets the optional 'includeCorpusRemovals' attribute.

If the value is not set then the default value will be returned.

◆ get_include_deleted()

bool google_drive_api::ChangesResource_WatchMethod::get_include_deleted ( ) const
inline

Gets the optional 'includeDeleted' attribute.

If the value is not set then the default value will be returned.

◆ get_include_items_from_all_drives()

bool google_drive_api::ChangesResource_WatchMethod::get_include_items_from_all_drives ( ) const
inline

Gets the optional 'includeItemsFromAllDrives' attribute.

If the value is not set then the default value will be returned.

◆ get_include_subscribed()

bool google_drive_api::ChangesResource_WatchMethod::get_include_subscribed ( ) const
inline

Gets the optional 'includeSubscribed' attribute.

If the value is not set then the default value will be returned.

◆ get_include_team_drive_items()

bool google_drive_api::ChangesResource_WatchMethod::get_include_team_drive_items ( ) const
inline

Gets the optional 'includeTeamDriveItems' attribute.

If the value is not set then the default value will be returned.

◆ get_max_results()

int32 google_drive_api::ChangesResource_WatchMethod::get_max_results ( ) const
inline

Gets the optional 'maxResults' attribute.

If the value is not set then the default value will be returned.

◆ get_page_token()

const string& google_drive_api::ChangesResource_WatchMethod::get_page_token ( ) const
inline

Gets the optional 'pageToken' attribute.

If the value is not set then the default value will be returned.

◆ get_spaces()

const string& google_drive_api::ChangesResource_WatchMethod::get_spaces ( ) const
inline

Gets the optional 'spaces' attribute.

If the value is not set then the default value will be returned.

◆ get_start_change_id()

int64 google_drive_api::ChangesResource_WatchMethod::get_start_change_id ( ) const
inline

Gets the optional 'startChangeId' attribute.

If the value is not set then the default value will be returned.

◆ get_supports_all_drives()

bool google_drive_api::ChangesResource_WatchMethod::get_supports_all_drives ( ) const
inline

Gets the optional 'supportsAllDrives' attribute.

If the value is not set then the default value will be returned.

◆ get_supports_team_drives()

bool google_drive_api::ChangesResource_WatchMethod::get_supports_team_drives ( ) const
inline

Gets the optional 'supportsTeamDrives' attribute.

If the value is not set then the default value will be returned.

◆ get_team_drive_id()

const string& google_drive_api::ChangesResource_WatchMethod::get_team_drive_id ( ) const
inline

Gets the optional 'teamDriveId' attribute.

If the value is not set then the default value will be returned.

◆ mutable_driveId()

string* google_drive_api::ChangesResource_WatchMethod::mutable_driveId ( )
inline

Gets a modifiable pointer to the optional driveId' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ mutable_pageToken()

string* google_drive_api::ChangesResource_WatchMethod::mutable_pageToken ( )
inline

Gets a modifiable pointer to the optional pageToken' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ mutable_spaces()

string* google_drive_api::ChangesResource_WatchMethod::mutable_spaces ( )
inline

Gets a modifiable pointer to the optional spaces' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ mutable_teamDriveId()

string* google_drive_api::ChangesResource_WatchMethod::mutable_teamDriveId ( )
inline

Gets a modifiable pointer to the optional teamDriveId' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ set_drive_id()

void google_drive_api::ChangesResource_WatchMethod::set_drive_id ( const string &  value)
inline

Sets the 'driveId' attribute.

Parameters
[in]valueThe 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.

◆ set_include_corpus_removals()

void google_drive_api::ChangesResource_WatchMethod::set_include_corpus_removals ( bool  value)
inline

Sets the 'includeCorpusRemovals' attribute.

Parameters
[in]valueWhether 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.

◆ set_include_deleted()

void google_drive_api::ChangesResource_WatchMethod::set_include_deleted ( bool  value)
inline

Sets the 'includeDeleted' attribute.

Parameters
[in]valueWhether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.

◆ set_include_items_from_all_drives()

void google_drive_api::ChangesResource_WatchMethod::set_include_items_from_all_drives ( bool  value)
inline

Sets the 'includeItemsFromAllDrives' attribute.

Deprecated:
Parameters
[in]valueDeprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results.

◆ set_include_subscribed()

void google_drive_api::ChangesResource_WatchMethod::set_include_subscribed ( bool  value)
inline

Sets the 'includeSubscribed' attribute.

Parameters
[in]valueWhether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result.

◆ set_include_team_drive_items()

void google_drive_api::ChangesResource_WatchMethod::set_include_team_drive_items ( bool  value)
inline

Sets the 'includeTeamDriveItems' attribute.

Deprecated:
Parameters
[in]valueDeprecated use includeItemsFromAllDrives instead.

◆ set_max_results()

void google_drive_api::ChangesResource_WatchMethod::set_max_results ( int32  value)
inline

Sets the 'maxResults' attribute.

Parameters
[in]valueMaximum number of changes to return.

◆ set_page_token()

void google_drive_api::ChangesResource_WatchMethod::set_page_token ( const string &  value)
inline

Sets the 'pageToken' attribute.

Parameters
[in]valueThe 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.

◆ set_spaces()

void google_drive_api::ChangesResource_WatchMethod::set_spaces ( const string &  value)
inline

Sets the 'spaces' attribute.

Parameters
[in]valueA comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.

◆ set_start_change_id()

void google_drive_api::ChangesResource_WatchMethod::set_start_change_id ( int64  value)
inline

Sets the 'startChangeId' attribute.

Deprecated:
Parameters
[in]valueDeprecated - use pageToken instead.

◆ set_supports_all_drives()

void google_drive_api::ChangesResource_WatchMethod::set_supports_all_drives ( bool  value)
inline

Sets the 'supportsAllDrives' attribute.

Deprecated:
Parameters
[in]valueDeprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

◆ set_supports_team_drives()

void google_drive_api::ChangesResource_WatchMethod::set_supports_team_drives ( bool  value)
inline

Sets the 'supportsTeamDrives' attribute.

Deprecated:
Parameters
[in]valueDeprecated use supportsAllDrives instead.

◆ set_team_drive_id()

void google_drive_api::ChangesResource_WatchMethod::set_team_drive_id ( const string &  value)
inline

Sets the 'teamDriveId' attribute.

Deprecated:
Parameters
[in]valueDeprecated use driveId instead.

The documentation for this class was generated from the following files: