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

#include <drive_service.h>

Inheritance diagram for google_drive_api::FilesResource_WatchMethod:
google_drive_api::DriveServiceBaseRequest

Public Member Functions

 FilesResource_WatchMethod (const DriveService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &file_id, const Channel &_content_)
 
virtual ~FilesResource_WatchMethod ()
 
void clear_acknowledge_abuse ()
 
bool get_acknowledge_abuse () const
 
void set_acknowledge_abuse (bool value)
 
void clear_projection ()
 
const string & get_projection () const
 
string * mutable_projection ()
 
void set_projection (const string &value)
 
void clear_revision_id ()
 
const string & get_revision_id () const
 
string * mutable_revisionId ()
 
void set_revision_id (const string &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_update_viewed_date ()
 
bool get_update_viewed_date () const
 
void set_update_viewed_date (bool 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)
 
bool get_use_media_download () const
 
void set_use_media_download (bool use)
 
- 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.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

◆ FilesResource_WatchMethod()

google_drive_api::FilesResource_WatchMethod::FilesResource_WatchMethod ( const DriveService _service_,
client::AuthorizationCredential *  _credential_,
const absl::string_view &  file_id,
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]file_idThe ID for the file in question.
[in]<em>content</em>The data object to watch.

◆ ~FilesResource_WatchMethod()

google_drive_api::FilesResource_WatchMethod::~FilesResource_WatchMethod ( )
virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_drive_api::FilesResource_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::FilesResource_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_acknowledge_abuse()

void google_drive_api::FilesResource_WatchMethod::clear_acknowledge_abuse ( )
inline

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

◆ clear_projection()

void google_drive_api::FilesResource_WatchMethod::clear_projection ( )
inline

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

◆ clear_revision_id()

void google_drive_api::FilesResource_WatchMethod::clear_revision_id ( )
inline

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

◆ clear_supports_all_drives()

void google_drive_api::FilesResource_WatchMethod::clear_supports_all_drives ( )
inline

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

◆ clear_supports_team_drives()

void google_drive_api::FilesResource_WatchMethod::clear_supports_team_drives ( )
inline

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

◆ clear_update_viewed_date()

void google_drive_api::FilesResource_WatchMethod::clear_update_viewed_date ( )
inline

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

◆ ExecuteAndParseResponse()

util::Status google_drive_api::FilesResource_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_acknowledge_abuse()

bool google_drive_api::FilesResource_WatchMethod::get_acknowledge_abuse ( ) const
inline

Gets the optional 'acknowledgeAbuse' attribute.

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

◆ get_projection()

const string& google_drive_api::FilesResource_WatchMethod::get_projection ( ) const
inline

Gets the optional 'projection' attribute.

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

◆ get_revision_id()

const string& google_drive_api::FilesResource_WatchMethod::get_revision_id ( ) const
inline

Gets the optional 'revisionId' attribute.

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

◆ get_supports_all_drives()

bool google_drive_api::FilesResource_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::FilesResource_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_update_viewed_date()

bool google_drive_api::FilesResource_WatchMethod::get_update_viewed_date ( ) const
inline

Gets the optional 'updateViewedDate' attribute.

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

◆ get_use_media_download()

bool google_drive_api::FilesResource_WatchMethod::get_use_media_download ( ) const
inline

Determine if the request should use Media Download for the response.

Returns
true for media download, false otherwise.

◆ mutable_projection()

string* google_drive_api::FilesResource_WatchMethod::mutable_projection ( )
inline

Gets a modifiable pointer to the optional projection' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ mutable_revisionId()

string* google_drive_api::FilesResource_WatchMethod::mutable_revisionId ( )
inline

Gets a modifiable pointer to the optional revisionId' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ set_acknowledge_abuse()

void google_drive_api::FilesResource_WatchMethod::set_acknowledge_abuse ( bool  value)
inline

Sets the 'acknowledgeAbuse' attribute.

Parameters
[in]valueWhether the user is acknowledging the risk of downloading known malware or other abusive files.

◆ set_projection()

void google_drive_api::FilesResource_WatchMethod::set_projection ( const string &  value)
inline

Sets the 'projection' attribute.

Parameters
[in]valueThis parameter is deprecated and has no function.

◆ set_revision_id()

void google_drive_api::FilesResource_WatchMethod::set_revision_id ( const string &  value)
inline

Sets the 'revisionId' attribute.

Parameters
[in]valueSpecifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.

◆ set_supports_all_drives()

void google_drive_api::FilesResource_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::FilesResource_WatchMethod::set_supports_team_drives ( bool  value)
inline

Sets the 'supportsTeamDrives' attribute.

Deprecated:
Parameters
[in]valueDeprecated use supportsAllDrives instead.

◆ set_update_viewed_date()

void google_drive_api::FilesResource_WatchMethod::set_update_viewed_date ( bool  value)
inline

Sets the 'updateViewedDate' attribute.

Deprecated:
Parameters
[in]valueDeprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.

◆ set_use_media_download()

void google_drive_api::FilesResource_WatchMethod::set_use_media_download ( bool  use)
inline

Sets whether Media Download should be used for the response data.

Parameters
[in]usetrue to use media download, false otherwise.

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