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

#include <drive_service.h>

Inheritance diagram for google_drive_api::PermissionsResource_InsertMethod:
google_drive_api::DriveServiceBaseRequest

Public Member Functions

 PermissionsResource_InsertMethod (const DriveService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &file_id, const Permission &_content_)
 
virtual ~PermissionsResource_InsertMethod ()
 
void clear_email_message ()
 
const string & get_email_message () const
 
string * mutable_emailMessage ()
 
void set_email_message (const string &value)
 
void clear_enforce_single_parent ()
 
bool get_enforce_single_parent () const
 
void set_enforce_single_parent (bool value)
 
void clear_move_to_new_owners_root ()
 
bool get_move_to_new_owners_root () const
 
void set_move_to_new_owners_root (bool value)
 
void clear_send_notification_emails ()
 
bool get_send_notification_emails () const
 
void set_send_notification_emails (bool 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_use_domain_admin_access ()
 
bool get_use_domain_admin_access () const
 
void set_use_domain_admin_access (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 (Permission *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 insert 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.file

Constructor & Destructor Documentation

◆ PermissionsResource_InsertMethod()

google_drive_api::PermissionsResource_InsertMethod::PermissionsResource_InsertMethod ( const DriveService _service_,
client::AuthorizationCredential *  _credential_,
const absl::string_view &  file_id,
const Permission _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 or shared drive.
[in]<em>content</em>The data object to insert.

◆ ~PermissionsResource_InsertMethod()

google_drive_api::PermissionsResource_InsertMethod::~PermissionsResource_InsertMethod ( )
virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_drive_api::PermissionsResource_InsertMethod::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::PermissionsResource_InsertMethod::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_email_message()

void google_drive_api::PermissionsResource_InsertMethod::clear_email_message ( )
inline

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

◆ clear_enforce_single_parent()

void google_drive_api::PermissionsResource_InsertMethod::clear_enforce_single_parent ( )
inline

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

◆ clear_move_to_new_owners_root()

void google_drive_api::PermissionsResource_InsertMethod::clear_move_to_new_owners_root ( )
inline

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

◆ clear_send_notification_emails()

void google_drive_api::PermissionsResource_InsertMethod::clear_send_notification_emails ( )
inline

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

◆ clear_supports_all_drives()

void google_drive_api::PermissionsResource_InsertMethod::clear_supports_all_drives ( )
inline

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

◆ clear_supports_team_drives()

void google_drive_api::PermissionsResource_InsertMethod::clear_supports_team_drives ( )
inline

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

◆ clear_use_domain_admin_access()

void google_drive_api::PermissionsResource_InsertMethod::clear_use_domain_admin_access ( )
inline

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

◆ ExecuteAndParseResponse()

util::Status google_drive_api::PermissionsResource_InsertMethod::ExecuteAndParseResponse ( Permission 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_email_message()

const string& google_drive_api::PermissionsResource_InsertMethod::get_email_message ( ) const
inline

Gets the optional 'emailMessage' attribute.

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

◆ get_enforce_single_parent()

bool google_drive_api::PermissionsResource_InsertMethod::get_enforce_single_parent ( ) const
inline

Gets the optional 'enforceSingleParent' attribute.

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

◆ get_move_to_new_owners_root()

bool google_drive_api::PermissionsResource_InsertMethod::get_move_to_new_owners_root ( ) const
inline

Gets the optional 'moveToNewOwnersRoot' attribute.

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

◆ get_send_notification_emails()

bool google_drive_api::PermissionsResource_InsertMethod::get_send_notification_emails ( ) const
inline

Gets the optional 'sendNotificationEmails' attribute.

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

◆ get_supports_all_drives()

bool google_drive_api::PermissionsResource_InsertMethod::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::PermissionsResource_InsertMethod::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_use_domain_admin_access()

bool google_drive_api::PermissionsResource_InsertMethod::get_use_domain_admin_access ( ) const
inline

Gets the optional 'useDomainAdminAccess' attribute.

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

◆ mutable_emailMessage()

string* google_drive_api::PermissionsResource_InsertMethod::mutable_emailMessage ( )
inline

Gets a modifiable pointer to the optional emailMessage' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ set_email_message()

void google_drive_api::PermissionsResource_InsertMethod::set_email_message ( const string &  value)
inline

Sets the 'emailMessage' attribute.

Parameters
[in]valueA plain text custom message to include in notification emails.

◆ set_enforce_single_parent()

void google_drive_api::PermissionsResource_InsertMethod::set_enforce_single_parent ( bool  value)
inline

Sets the 'enforceSingleParent' attribute.

Parameters
[in]valueSet to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. See moveToNewOwnersRoot for details.

◆ set_move_to_new_owners_root()

void google_drive_api::PermissionsResource_InsertMethod::set_move_to_new_owners_root ( bool  value)
inline

Sets the 'moveToNewOwnersRoot' attribute.

Parameters
[in]valueThis parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. When set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, when enforceSingleParent=true, parents are not changed. If set to false, when enforceSingleParent=false, existing parents are not changed; however, the file will be added to the new owner's My Drive root folder, unless it is already in the new owner's My Drive.

◆ set_send_notification_emails()

void google_drive_api::PermissionsResource_InsertMethod::set_send_notification_emails ( bool  value)
inline

Sets the 'sendNotificationEmails' attribute.

Parameters
[in]valueWhether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the role is owner.

◆ set_supports_all_drives()

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

Sets the 'supportsTeamDrives' attribute.

Deprecated:
Parameters
[in]valueDeprecated use supportsAllDrives instead.

◆ set_use_domain_admin_access()

void google_drive_api::PermissionsResource_InsertMethod::set_use_domain_admin_access ( bool  value)
inline

Sets the 'useDomainAdminAccess' attribute.

Parameters
[in]valueIssue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.

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