GoogleDrive Class

Properties   Methods   Events   Config Settings   Errors  

The GoogleDrive class makes it easy to upload, download, and manage files and folders within Google Drive.

Syntax

GoogleDrive

Remarks

The GoogleDrive class provides an easy-to-use interface for Google Drive. Capabilities include uploading and downloading files, file and folder manipulation and organization, Google Shared Drive support, strong client-side file encryption functionality, and more.

Authentication

This class requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property to set the appropriate fields for the chosen ClientProfile and GrantType.

The class has the following defaults:

Below is a brief description of the different ClientProfile and GrantType values that are supported by this class. For a more in-depth description of what needs to be set, refer to the service documentation.

Application Profile

This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the class. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.

To start the authentication and authorization process, the Authorize method should be called. If the authorization and authentication was successful, then the AccessToken field will be populated. Additionally, if a refresh token was provided the RefreshToken field will be populated as well. These values of the fields are for informational purposes. The class will also cache these tokens along with when the AccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the class will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new AccessToken. If the Authorize method was not used and user interaction would be required, the class will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the GrantType field. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.

A brief description of the supported values for the GrantType field are below. For more information, see the service documentation.

Authorization Code

When using the Authorization Code grant type, the class will use an authorization code to get an access token. For this GrantType the class expects a ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the authorization code, setting the AuthorizationCode field, from the redirect. Immediately, the class will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the RefreshToken field is set, or a refresh token is cached, then the class will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

Example: GoogleDrive googledrive = new GoogleDrive(); googledrive.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication; googledrive.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode; googledrive.OAuth.ClientId = CLIENT_ID; googledrive.OAuth.ClientSecret = CLIENT_SECRET; googledrive.Authorize();

Implicit

Note: This grant type is considered insecure and should only be used when necessary.

When using the Implicit grant type, the class will request the authorization server to get an access token. For this GrantType the class expects a ClientId, ClientSecret, and ServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the access token from the redirect.

A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the class will not be able to automatically get a fresh token once it expires.

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the class to ignore the values set in the OAuth property.

For Example: Oauth oauth = new Oauth(); oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET"; oauth.AuthorizationScope = "https://www.googleapis.com/auth/gmail.readonly"; oauth.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth"; oauth.ServerTokenURL = "https://www.googleapis.com/auth/drive"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; googledrive.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Listing Resources

The ListResources method is used to list resources within the scope specified by the ListResourcesScope property.

The ListChildren, ListParents, and GetResourceInfo methods are also available for finer-grained control. // ResourceList event handler. googledrive.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; // List all of the current user's resources. googledrive.ListResourcesScope = GoogledriveListResourcesScopes.lrsUser; do { googledrive.ListResources(); for (int i = 0; i < googledrive.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(googledrive.ResourceMarker)); // List all of the resources in the specified shared drive. googledrive.SharedDrive = "wfsr789vusijfv"; googledrive.ListResourcesScope = GoogledriveListResourcesScopes.lrsSharedDrive; do { googledrive.ListResources(); for (int i = 0; i < googledrive.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(googledrive.ResourceMarker));

Downloading Files

The DownloadFile method is used to download files.

Download Notes

To decrypt an encrypted file set EncryptionAlgorithm and EncryptionPassword before calling this method. googledrive.LocalFile = "../MyFile.zip"; googledrive.DownloadFile(googledrive.Resources[0].Id, "");

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyFile.zip"; googledrive.LocalFile = downloadFile; googledrive.DownloadFile(googledrive.Resources[0].Id, ""); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file googledrive.StartByte = new FileInfo(downloadFile).Length; googledrive.DownloadFile(googledrive.Resources[0].Id, "");

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.

If LocalFile is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile. googledrive.LocalFile = "../MyFile.zip"; googledrive.EncryptionPassword = "password"; googledrive.DownloadFile(googledrive.Resource[0].Id, ""); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially download temp file googledrive.StartByte = new FileInfo(googledrive.Config("DownloadTempFile")).Length; googledrive.DownloadFile(googledrive.Resource[0].Id, "");

Uploading Files

The UploadFile method is used to upload files.

Upload Notes

Google Drive offers two ways to upload a file. For smaller files a simple upload option is provided to upload data in one request. This is the default option. For larger files, uploads can be fragmented into multiple pieces, allowing resuming of uploads that may be interrupted.

Simple

By default the class uses the simple upload mechanism. googledrive.LocalFile = "../MyFile.zip"; googledrive.UploadFile("MyFile.zip", "");

Resumable

To enable resumable uploads set UseResumableUpload to true. This is recommended for large files. The class will automatically fragment the specified file into smaller pieces and upload each individually. FragmentSize may be set to specify the size of the fragment if desired. The default fragment size is 10 MB.

When UseResumableUpload is set to true and UploadFile is called, a resumable upload session is started by the class. ResumeURL is populated with a URL identifying the session (this value may be needed for additional operations if the upload does not complete normally).

During a resumable upload, the FragmentComplete event fires after each fragment is uploaded to indicate overall progress. The class also updates StartByte as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that ResumeURL and StartByte are populated (if the same instance of the class is used, they should already be populated, and no special action should be needed). If uploading from a stream, be sure to reset its position to where it was the first time the upload was started (typically the beginning). Then call UploadFile again to resume the upload at the specified StartByte offset.

Note that if the upload is not resumed after some time the upload session will expire. GetUploadStatus may be used to check the status of a resumable upload. googledrive.LocalFile = "../MyFile.zip"; googledrive.UploadFile("MyFile.zip", ""); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte and ResumeURL are already populated from the previous //upload attempt. googledrive.UploadFile("MyFile.zip", ""); MemoryStream uploadStream = new MemoryStream(File.ReadAllBytes("../MyFile.zip")); googledrive.SetUploadStream(uploadStream); googledrive.UploadFile("MyFile.zip", ""); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte and ResumeURL are already populated from the previous //upload attempt. //You MUST reset the stream's position to where it was when you first started the upload! uploadStream.Position = 0; googledrive.UploadFile("MyFile.zip", "");

Shared Drive Support

The GoogleDrive class has full support for Google Shared Drives. For the most common use-cases (such as those described above), there is very little difference when using a shared drive versus a personal Google Drive ("My Drive").

For more information about how to use the class with Google Shared Drives, refer to both the shared-drive-specific documentation sections for commonly-used methods like ListResources, MoveResource, UpdatePermissions, etc.; and browse through the documentation for shared-drive-specific methods and properties such as the AddSharedDriveMember and ListSharedDrives methods, the SharedDrive property, etc.

Additional Functionality

The GoogleDrive class offers advanced functionality beyond simple uploads and downloads. For instance:

• Encrypt and decrypt files using the EncryptionAlgorithm and EncryptionPassword properties.
• Basic file and folder manipulation and organization using methods such as CopyResource, CreateFolder, DeleteResource, MoveResource, and UpdateResource.
• Enumeration and manipulation of parent-child relationships using the AddParents, ListChildren, ListParents, and RemoveParents methods.
• Resourcing trashing and deletion: DeleteResource, TrashResource, RestoreResource.
• Control over permissions using ListPermissions and UpdatePermissions.
• Change tracking with ListChanges.
• And more!

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Account Property (GoogleDrive Class)

Details about the current user's account and space usage.

Syntax

• C++
• C
• Qt

CloudStorageGDriveAccount* GetAccount();

int cloudstorage_googledrive_getaccountcancreateshareddrives(void* lpObj);

int64 cloudstorage_googledrive_getaccountdriveusage(void* lpObj);

char* cloudstorage_googledrive_getaccountemail(void* lpObj);

char* cloudstorage_googledrive_getaccountname(void* lpObj);

char* cloudstorage_googledrive_getaccountpermissionid(void* lpObj);

int64 cloudstorage_googledrive_getaccountstoragequota(void* lpObj);

int64 cloudstorage_googledrive_getaccountstorageusage(void* lpObj);

int64 cloudstorage_googledrive_getaccounttrashusage(void* lpObj);

bool GetAccountCanCreateSharedDrives();

qint64 GetAccountDriveUsage();

QString GetAccountEmail();

QString GetAccountName();

QString GetAccountPermissionId();

qint64 GetAccountStorageQuota();

qint64 GetAccountStorageUsage();

qint64 GetAccountTrashUsage();

Remarks

This property holds a GDriveAccount object with information about the current user's account and space usage; it's populated after calling GetAccountInfo.

This property is read-only and not available at design time.

Data Type

CloudStorageGDriveAccount

Authorization Property (GoogleDrive Class)

OAuth 2.0 Authorization Token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorization();
int SetAuthorization(const char* lpszAuthorization);

Unicode (Windows)
LPWSTR GetAuthorization();
INT SetAuthorization(LPCWSTR lpszAuthorization);

char* cloudstorage_googledrive_getauthorization(void* lpObj);
int cloudstorage_googledrive_setauthorization(void* lpObj, const char* lpszAuthorization);

QString GetAuthorization();
int SetAuthorization(QString qsAuthorization);

Default Value

""

Remarks

This class supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property, using the OAuth class or a separate process. If using the OAuth property, then the Authorization property will not be used.

Bearer ACCESS_TOKEN

Data Type

String

ChangeMarker Property (GoogleDrive Class)

A marker indicating what page of changes to return next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChangeMarker();
int SetChangeMarker(const char* lpszChangeMarker);

Unicode (Windows)
LPWSTR GetChangeMarker();
INT SetChangeMarker(LPCWSTR lpszChangeMarker);

char* cloudstorage_googledrive_getchangemarker(void* lpObj);
int cloudstorage_googledrive_setchangemarker(void* lpObj, const char* lpszChangeMarker);

QString GetChangeMarker();
int SetChangeMarker(QString qsChangeMarker);

Default Value

""

Remarks

This property will be populated when ListChanges is called if the results are paged and there are more pages. To list all changes, continue to call ListChanges until this property returns empty string.

Setting ChangeMarker will cause NextChangeMarker to be set to empty string.

Refer to ListChanges for more information.

This property is not available at design time.

Data Type

String

Changes Property (GoogleDrive Class)

A collection of changes.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageGDriveChange>* GetChanges();

int cloudstorage_googledrive_getchangecount(void* lpObj);

int cloudstorage_googledrive_getchangeremoved(void* lpObj, int changeindex);

char* cloudstorage_googledrive_getchangeresourceid(void* lpObj, int changeindex);

char* cloudstorage_googledrive_getchangeshareddriveid(void* lpObj, int changeindex);

char* cloudstorage_googledrive_getchangetime(void* lpObj, int changeindex);

int cloudstorage_googledrive_getchangetype(void* lpObj, int changeindex);

int GetChangeCount();

bool GetChangeRemoved(int iChangeIndex);

QString GetChangeResourceId(int iChangeIndex);

QString GetChangeSharedDriveId(int iChangeIndex);

QString GetChangeTime(int iChangeIndex);

int GetChangeType(int iChangeIndex);

Remarks

This collection holds a list of changes to resources and shared drives available to the current user.

Refer to ListChanges for more information.

This property is read-only and not available at design time.

Data Type

CloudStorageGDriveChange

ChildMarker Property (GoogleDrive Class)

A marker when child resources are paged.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChildMarker();
int SetChildMarker(const char* lpszChildMarker);

Unicode (Windows)
LPWSTR GetChildMarker();
INT SetChildMarker(LPCWSTR lpszChildMarker);

char* cloudstorage_googledrive_getchildmarker(void* lpObj);
int cloudstorage_googledrive_setchildmarker(void* lpObj, const char* lpszChildMarker);

QString GetChildMarker();
int SetChildMarker(QString qsChildMarker);

Default Value

""

Remarks

This property returns a marker used to iterate over pages of child resources; it's populated when ListChildren is called if the results are paged.

Continue to call ListChildren until this property returns empty string in order to list all resources.

This property is not available at design time.

Data Type

String

Children Property (GoogleDrive Class)

A collection of child resources.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageGDriveResource>* GetChildren();

int cloudstorage_googledrive_getchildcount(void* lpObj);

int cloudstorage_googledrive_getchildcontentaccessible(void* lpObj, int childindex);

char* cloudstorage_googledrive_getchildcreatedtime(void* lpObj, int childindex);

char* cloudstorage_googledrive_getchilddescription(void* lpObj, int childindex);

char* cloudstorage_googledrive_getchildextension(void* lpObj, int childindex);

char* cloudstorage_googledrive_getchildid(void* lpObj, int childindex);

char* cloudstorage_googledrive_getchildmd5checksum(void* lpObj, int childindex);

char* cloudstorage_googledrive_getchildmimetype(void* lpObj, int childindex);

char* cloudstorage_googledrive_getchildmodifiedtime(void* lpObj, int childindex);

char* cloudstorage_googledrive_getchildname(void* lpObj, int childindex);

char* cloudstorage_googledrive_getchildoriginalname(void* lpObj, int childindex);

char* cloudstorage_googledrive_getchildowner(void* lpObj, int childindex);

char* cloudstorage_googledrive_getchildowneremail(void* lpObj, int childindex);

char* cloudstorage_googledrive_getchildparentids(void* lpObj, int childindex);

char* cloudstorage_googledrive_getchildshareddriveid(void* lpObj, int childindex);

int64 cloudstorage_googledrive_getchildsize(void* lpObj, int childindex);

int cloudstorage_googledrive_getchildstarred(void* lpObj, int childindex);

int cloudstorage_googledrive_getchildtrashed(void* lpObj, int childindex);

int cloudstorage_googledrive_getchildtype(void* lpObj, int childindex);

int cloudstorage_googledrive_getchildviewed(void* lpObj, int childindex);

char* cloudstorage_googledrive_getchildviewlink(void* lpObj, int childindex);

int GetChildCount();

bool GetChildContentAccessible(int iChildIndex);

QString GetChildCreatedTime(int iChildIndex);

QString GetChildDescription(int iChildIndex);

QString GetChildExtension(int iChildIndex);

QString GetChildId(int iChildIndex);

QString GetChildMD5Checksum(int iChildIndex);

QString GetChildMIMEType(int iChildIndex);

QString GetChildModifiedTime(int iChildIndex);

QString GetChildName(int iChildIndex);

QString GetChildOriginalName(int iChildIndex);

QString GetChildOwner(int iChildIndex);

QString GetChildOwnerEmail(int iChildIndex);

QString GetChildParentIds(int iChildIndex);

QString GetChildSharedDriveId(int iChildIndex);

qint64 GetChildSize(int iChildIndex);

bool GetChildStarred(int iChildIndex);

bool GetChildTrashed(int iChildIndex);

int GetChildType(int iChildIndex);

bool GetChildViewed(int iChildIndex);

QString GetChildViewLink(int iChildIndex);

Remarks

This collection holds a list of child file and folder resources.

Calling ListChildren will populate this collection.

This property is read-only and not available at design time.

Data Type

CloudStorageGDriveResource

EncryptionAlgorithm Property (GoogleDrive Class)

The encryption algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(int iEncryptionAlgorithm);

Unicode (Windows)
INT GetEncryptionAlgorithm();
INT SetEncryptionAlgorithm(INT iEncryptionAlgorithm);

EA_AES(0), 
EA_BLOWFISH(1), 
EA_CAST(2), 
EA_DES(3), 
EA_IDEA(4), 
EA_RC2(5), 
EA_RC4(6), 
EA_TEA(7), 
EA_TRIPLE_DES(8), 
EA_TWOFISH(9), 
EA_RIJNDAEL(10), 
EA_CHA_CHA(11), 
EA_XSALSA_20(12)

int cloudstorage_googledrive_getencryptionalgorithm(void* lpObj);
int cloudstorage_googledrive_setencryptionalgorithm(void* lpObj, int iEncryptionAlgorithm);

int GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(int iEncryptionAlgorithm);

Default Value

0

Remarks

This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:

Data Type

Integer

EncryptionPassword Property (GoogleDrive Class)

The encryption password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionPassword();
int SetEncryptionPassword(const char* lpszEncryptionPassword);

Unicode (Windows)
LPWSTR GetEncryptionPassword();
INT SetEncryptionPassword(LPCWSTR lpszEncryptionPassword);

char* cloudstorage_googledrive_getencryptionpassword(void* lpObj);
int cloudstorage_googledrive_setencryptionpassword(void* lpObj, const char* lpszEncryptionPassword);

QString GetEncryptionPassword();
int SetEncryptionPassword(QString qsEncryptionPassword);

Default Value

""

Remarks

If this property is populated when UploadFile or DownloadFile is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it.

The class uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.

This property is not available at design time.

Data Type

String

Firewall Property (GoogleDrive Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

CloudStorageFirewall* GetFirewall();
int SetFirewall(CloudStorageFirewall* val);

int cloudstorage_googledrive_getfirewallautodetect(void* lpObj);
int cloudstorage_googledrive_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int cloudstorage_googledrive_getfirewalltype(void* lpObj);
int cloudstorage_googledrive_setfirewalltype(void* lpObj, int iFirewallType);

char* cloudstorage_googledrive_getfirewallhost(void* lpObj);
int cloudstorage_googledrive_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* cloudstorage_googledrive_getfirewallpassword(void* lpObj);
int cloudstorage_googledrive_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int cloudstorage_googledrive_getfirewallport(void* lpObj);
int cloudstorage_googledrive_setfirewallport(void* lpObj, int iFirewallPort);

char* cloudstorage_googledrive_getfirewalluser(void* lpObj);
int cloudstorage_googledrive_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

CloudStorageFirewall

Idle Property (GoogleDrive Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int cloudstorage_googledrive_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

ListResourcesScope Property (GoogleDrive Class)

Controls the scope of the results when listing resources.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetListResourcesScope();
int SetListResourcesScope(int iListResourcesScope);

Unicode (Windows)
INT GetListResourcesScope();
INT SetListResourcesScope(INT iListResourcesScope);

LRS_USER(0), 
LRS_DOMAIN(1), 
LRS_SHARED_DRIVE(2), 
LRS_ALL_DRIVES(3)

int cloudstorage_googledrive_getlistresourcesscope(void* lpObj);
int cloudstorage_googledrive_setlistresourcesscope(void* lpObj, int iListResourcesScope);

int GetListResourcesScope();
int SetListResourcesScope(int iListResourcesScope);

Default Value

0

Remarks

This property controls the scope of the results when listing resources with ListResources or ListChildren. Valid values are:

Refer to ListResources for more information.

This property is not available at design time.

Data Type

Integer

LocalFile Property (GoogleDrive Class)

The location of the local file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalFile();
wchar_t* GetLocalFile_W(); // Windows only
int SetLocalFile(const char* lpszLocalFile);
int SetLocalFile(const wchar_t* lpszLocalFile); // Windows only

Unicode (Windows)
LPWSTR GetLocalFile();
INT SetLocalFile(LPCWSTR lpszLocalFile);

char* cloudstorage_googledrive_getlocalfile(void* lpObj);
wchar_t* cloudstorage_googledrive_getlocalfile_W(void* lpObj); // Windows only
int cloudstorage_googledrive_setlocalfile(void* lpObj, const char* lpszLocalFile);
int cloudstorage_googledrive_setlocalfile(void* lpObj, const wchar_t* lpszLocalFile); // Windows only

QString GetLocalFile();
int SetLocalFile(QString qsLocalFile);

Default Value

""

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling UploadFile or UpdateResource, and as the destination file when calling DownloadFile.

Note: Setting this property to a non-empty value will discard any streams set using SetDownloadStream and SetUploadStream. Similarly, passing a non-null value to either of the aforementioned methods will clear this property.

Data Type

String

LocalHost Property (GoogleDrive Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* cloudstorage_googledrive_getlocalhost(void* lpObj);
int cloudstorage_googledrive_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

NextChangeMarker Property (GoogleDrive Class)

A marker indicating what page of changes to return in the future.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNextChangeMarker();
int SetNextChangeMarker(const char* lpszNextChangeMarker);

Unicode (Windows)
LPWSTR GetNextChangeMarker();
INT SetNextChangeMarker(LPCWSTR lpszNextChangeMarker);

char* cloudstorage_googledrive_getnextchangemarker(void* lpObj);
int cloudstorage_googledrive_setnextchangemarker(void* lpObj, const char* lpszNextChangeMarker);

QString GetNextChangeMarker();
int SetNextChangeMarker(QString qsNextChangeMarker);

Default Value

""

Remarks

This property will be populated when ListChanges is called if there are no more changes to list.

This property will be populated with the most current change marker if GetCurrentChangeMarker is called.

Setting NextChangeMarker will cause ChangeMarker to be set to empty string.

Refer to ListChanges for more information.

This property is not available at design time.

Data Type

String

OAuth Property (GoogleDrive Class)

This property holds the OAuth Settings.

Syntax

• C++
• C
• Qt

CloudStorageOAuthSettings* GetOAuth();

char* cloudstorage_googledrive_getoauthaccesstoken(void* lpObj);
int cloudstorage_googledrive_setoauthaccesstoken(void* lpObj, const char* lpszOAuthAccessToken);

char* cloudstorage_googledrive_getoauthauthorizationcode(void* lpObj);
int cloudstorage_googledrive_setoauthauthorizationcode(void* lpObj, const char* lpszOAuthAuthorizationCode);

char* cloudstorage_googledrive_getoauthauthorizationscope(void* lpObj);
int cloudstorage_googledrive_setoauthauthorizationscope(void* lpObj, const char* lpszOAuthAuthorizationScope);

char* cloudstorage_googledrive_getoauthclientid(void* lpObj);
int cloudstorage_googledrive_setoauthclientid(void* lpObj, const char* lpszOAuthClientId);

int cloudstorage_googledrive_getoauthclientprofile(void* lpObj);
int cloudstorage_googledrive_setoauthclientprofile(void* lpObj, int iOAuthClientProfile);

char* cloudstorage_googledrive_getoauthclientsecret(void* lpObj);
int cloudstorage_googledrive_setoauthclientsecret(void* lpObj, const char* lpszOAuthClientSecret);

int cloudstorage_googledrive_getoauthgranttype(void* lpObj);
int cloudstorage_googledrive_setoauthgranttype(void* lpObj, int iOAuthGrantType);

char* cloudstorage_googledrive_getoauthrefreshtoken(void* lpObj);
int cloudstorage_googledrive_setoauthrefreshtoken(void* lpObj, const char* lpszOAuthRefreshToken);

int cloudstorage_googledrive_getoauthrequestrefreshtoken(void* lpObj);
int cloudstorage_googledrive_setoauthrequestrefreshtoken(void* lpObj, int bOAuthRequestRefreshToken);

char* cloudstorage_googledrive_getoauthreturnurl(void* lpObj);
int cloudstorage_googledrive_setoauthreturnurl(void* lpObj, const char* lpszOAuthReturnURL);

char* cloudstorage_googledrive_getoauthserverauthurl(void* lpObj);
int cloudstorage_googledrive_setoauthserverauthurl(void* lpObj, const char* lpszOAuthServerAuthURL);

char* cloudstorage_googledrive_getoauthservertokenurl(void* lpObj);
int cloudstorage_googledrive_setoauthservertokenurl(void* lpObj, const char* lpszOAuthServerTokenURL);

char* cloudstorage_googledrive_getoauthwebauthurl(void* lpObj);

QString GetOAuthAccessToken();
int SetOAuthAccessToken(QString qsOAuthAccessToken);

QString GetOAuthAuthorizationCode();
int SetOAuthAuthorizationCode(QString qsOAuthAuthorizationCode);

QString GetOAuthAuthorizationScope();
int SetOAuthAuthorizationScope(QString qsOAuthAuthorizationScope);

QString GetOAuthClientId();
int SetOAuthClientId(QString qsOAuthClientId);

int GetOAuthClientProfile();
int SetOAuthClientProfile(int iOAuthClientProfile);

QString GetOAuthClientSecret();
int SetOAuthClientSecret(QString qsOAuthClientSecret);

int GetOAuthGrantType();
int SetOAuthGrantType(int iOAuthGrantType);

QString GetOAuthRefreshToken();
int SetOAuthRefreshToken(QString qsOAuthRefreshToken);

bool GetOAuthRequestRefreshToken();
int SetOAuthRequestRefreshToken(bool bOAuthRequestRefreshToken);

QString GetOAuthReturnURL();
int SetOAuthReturnURL(QString qsOAuthReturnURL);

QString GetOAuthServerAuthURL();
int SetOAuthServerAuthURL(QString qsOAuthServerAuthURL);

QString GetOAuthServerTokenURL();
int SetOAuthServerTokenURL(QString qsOAuthServerTokenURL);

QString GetOAuthWebAuthURL();

Remarks

This property is used to define the necessary fields to authenticate with the service provider. See the introduction for more information.

This property is read-only and not available at design time.

Data Type

CloudStorageOAuthSettings

OtherHeaders Property (GoogleDrive Class)

Other headers as determined by the user (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders);

Unicode (Windows)
LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);

char* cloudstorage_googledrive_getotherheaders(void* lpObj);
int cloudstorage_googledrive_setotherheaders(void* lpObj, const char* lpszOtherHeaders);

QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

This property is not available at design time.

Data Type

String

Overwrite Property (GoogleDrive Class)

Determines if local files are overwritten.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int cloudstorage_googledrive_getoverwrite(void* lpObj);
int cloudstorage_googledrive_setoverwrite(void* lpObj, int bOverwrite);

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

This property controls whether local files are overwritten when calling DownloadFile. It is only applicable to local files. The default value is false.

Data Type

Boolean

ParsedHeaders Property (GoogleDrive Class)

This property includes a collection of headers returned from the last request.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageHeader>* GetParsedHeaders();

int cloudstorage_googledrive_getparsedheadercount(void* lpObj);

char* cloudstorage_googledrive_getparsedheaderfield(void* lpObj, int parsedheaderindex);

char* cloudstorage_googledrive_getparsedheadervalue(void* lpObj, int parsedheaderindex);

int GetParsedHeaderCount();

QString GetParsedHeaderField(int iParsedHeaderIndex);

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

This property is read-only and not available at design time.

Data Type

CloudStorageHeader

PermissionMarker Property (GoogleDrive Class)

A marker when permissions are paged.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPermissionMarker();
int SetPermissionMarker(const char* lpszPermissionMarker);

Unicode (Windows)
LPWSTR GetPermissionMarker();
INT SetPermissionMarker(LPCWSTR lpszPermissionMarker);

char* cloudstorage_googledrive_getpermissionmarker(void* lpObj);
int cloudstorage_googledrive_setpermissionmarker(void* lpObj, const char* lpszPermissionMarker);

QString GetPermissionMarker();
int SetPermissionMarker(QString qsPermissionMarker);

Default Value

""

Remarks

This property returns a marker used to iterate over pages of permissions; it's populated when ListPermissions is called if the results are paged.

Continue to call ListPermissions until this property returns empty string in order to list all permissions.

This property is not available at design time.

Data Type

String

Permissions Property (GoogleDrive Class)

A collection of permissions.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageGDrivePermission>* GetPermissions();
int SetPermissions(CloudStorageList<CloudStorageGDrivePermission>* val);

int cloudstorage_googledrive_getpermissioncount(void* lpObj);
int cloudstorage_googledrive_setpermissioncount(void* lpObj, int iPermissionCount);

int cloudstorage_googledrive_getpermissionallowfilediscovery(void* lpObj, int permissionindex);
int cloudstorage_googledrive_setpermissionallowfilediscovery(void* lpObj, int permissionindex, int bPermissionAllowFileDiscovery);

char* cloudstorage_googledrive_getpermissiondomain(void* lpObj, int permissionindex);
int cloudstorage_googledrive_setpermissiondomain(void* lpObj, int permissionindex, const char* lpszPermissionDomain);

char* cloudstorage_googledrive_getpermissionemail(void* lpObj, int permissionindex);
int cloudstorage_googledrive_setpermissionemail(void* lpObj, int permissionindex, const char* lpszPermissionEmail);

char* cloudstorage_googledrive_getpermissionid(void* lpObj, int permissionindex);
int cloudstorage_googledrive_setpermissionid(void* lpObj, int permissionindex, const char* lpszPermissionId);

int cloudstorage_googledrive_getpermissionmodop(void* lpObj, int permissionindex);
int cloudstorage_googledrive_setpermissionmodop(void* lpObj, int permissionindex, int iPermissionModOp);

int cloudstorage_googledrive_getpermissionrole(void* lpObj, int permissionindex);
int cloudstorage_googledrive_setpermissionrole(void* lpObj, int permissionindex, int iPermissionRole);

int cloudstorage_googledrive_getpermissiontype(void* lpObj, int permissionindex);
int cloudstorage_googledrive_setpermissiontype(void* lpObj, int permissionindex, int iPermissionType);

int GetPermissionCount();
int SetPermissionCount(int iPermissionCount);

bool GetPermissionAllowFileDiscovery(int iPermissionIndex);
int SetPermissionAllowFileDiscovery(int iPermissionIndex, bool bPermissionAllowFileDiscovery);

QString GetPermissionDomain(int iPermissionIndex);
int SetPermissionDomain(int iPermissionIndex, QString qsPermissionDomain);

QString GetPermissionEmail(int iPermissionIndex);
int SetPermissionEmail(int iPermissionIndex, QString qsPermissionEmail);

QString GetPermissionId(int iPermissionIndex);
int SetPermissionId(int iPermissionIndex, QString qsPermissionId);

int GetPermissionModOp(int iPermissionIndex);
int SetPermissionModOp(int iPermissionIndex, int iPermissionModOp);

int GetPermissionRole(int iPermissionIndex);
int SetPermissionRole(int iPermissionIndex, int iPermissionRole);

int GetPermissionType(int iPermissionIndex);
int SetPermissionType(int iPermissionIndex, int iPermissionType);

Remarks

This collection holds a list of permissions for a file, folder, or shared drive.

Calling ListPermissions will populate this collection.

Also see UpdatePermissions for information on how the items in this collection are used to create, update, and delete permissions.

This property is not available at design time.

Data Type

CloudStorageGDrivePermission

Proxy Property (GoogleDrive Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

CloudStorageProxy* GetProxy();
int SetProxy(CloudStorageProxy* val);

int cloudstorage_googledrive_getproxyauthscheme(void* lpObj);
int cloudstorage_googledrive_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int cloudstorage_googledrive_getproxyautodetect(void* lpObj);
int cloudstorage_googledrive_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* cloudstorage_googledrive_getproxypassword(void* lpObj);
int cloudstorage_googledrive_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int cloudstorage_googledrive_getproxyport(void* lpObj);
int cloudstorage_googledrive_setproxyport(void* lpObj, int iProxyPort);

char* cloudstorage_googledrive_getproxyserver(void* lpObj);
int cloudstorage_googledrive_setproxyserver(void* lpObj, const char* lpszProxyServer);

int cloudstorage_googledrive_getproxyssl(void* lpObj);
int cloudstorage_googledrive_setproxyssl(void* lpObj, int iProxySSL);

char* cloudstorage_googledrive_getproxyuser(void* lpObj);
int cloudstorage_googledrive_setproxyuser(void* lpObj, const char* lpszProxyUser);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Data Type

CloudStorageProxy

QueryParams Property (GoogleDrive Class)

Additional query parameters to be included in the request.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageQueryParam>* GetQueryParams();
int SetQueryParams(CloudStorageList<CloudStorageQueryParam>* val);

int cloudstorage_googledrive_getqueryparamcount(void* lpObj);
int cloudstorage_googledrive_setqueryparamcount(void* lpObj, int iQueryParamCount);

char* cloudstorage_googledrive_getqueryparamname(void* lpObj, int queryparamindex);
int cloudstorage_googledrive_setqueryparamname(void* lpObj, int queryparamindex, const char* lpszQueryParamName);

char* cloudstorage_googledrive_getqueryparamvalue(void* lpObj, int queryparamindex);
int cloudstorage_googledrive_setqueryparamvalue(void* lpObj, int queryparamindex, const char* lpszQueryParamValue);

int GetQueryParamCount();
int SetQueryParamCount(int iQueryParamCount);

QString GetQueryParamName(int iQueryParamIndex);
int SetQueryParamName(int iQueryParamIndex, QString qsQueryParamName);

QString GetQueryParamValue(int iQueryParamIndex);
int SetQueryParamValue(int iQueryParamIndex, QString qsQueryParamValue);

Remarks

This is a collection of query parameters that will be added to the request. Parameters can be added via the AddQueryParam method.

Data Type

CloudStorageQueryParam

ResourceData Property (GoogleDrive Class)

The data that was downloaded, or that should be uploaded.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetResourceData(char* &lpResourceData, int &lenResourceData);
int SetResourceData(const char* lpResourceData, int lenResourceData);

Unicode (Windows)
INT GetResourceData(LPSTR &lpResourceData, INT &lenResourceData);
INT SetResourceData(LPCSTR lpResourceData, INT lenResourceData);

int cloudstorage_googledrive_getresourcedata(void* lpObj, char** lpResourceData, int* lenResourceData);
int cloudstorage_googledrive_setresourcedata(void* lpObj, const char* lpResourceData, int lenResourceData);

QByteArray GetResourceData();
int SetResourceData(QByteArray qbaResourceData);

Default Value

""

Remarks

This property is populated with file data after calling DownloadFile if SetDownloadStream and LocalFile are not set.

This property can also be set before calling UploadFile; its data will be uploaded if SetUploadStream and LocalFile are not set.

This property is not available at design time.

Data Type

Binary String

ResourceMarker Property (GoogleDrive Class)

A marker indicating what page of resources to return next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResourceMarker();
int SetResourceMarker(const char* lpszResourceMarker);

Unicode (Windows)
LPWSTR GetResourceMarker();
INT SetResourceMarker(LPCWSTR lpszResourceMarker);

char* cloudstorage_googledrive_getresourcemarker(void* lpObj);
int cloudstorage_googledrive_setresourcemarker(void* lpObj, const char* lpszResourceMarker);

QString GetResourceMarker();
int SetResourceMarker(QString qsResourceMarker);

Default Value

""

Remarks

This property will be populated when ListResources is called if the results are paged and there are more pages. To list all resources, continue to call ListResources until this property returns empty string.

Refer to ListResources for more information.

Note that resources are never paged when calling ListParents or GetResourceInfo.

This property is not available at design time.

Data Type

String

Resources Property (GoogleDrive Class)

A collection of resources.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageGDriveResource>* GetResources();
int SetResources(CloudStorageList<CloudStorageGDriveResource>* val);

int cloudstorage_googledrive_getresourcecount(void* lpObj);
int cloudstorage_googledrive_setresourcecount(void* lpObj, int iResourceCount);

int cloudstorage_googledrive_getresourcecontentaccessible(void* lpObj, int resourceindex);
int cloudstorage_googledrive_setresourcecontentaccessible(void* lpObj, int resourceindex, int bResourceContentAccessible);

char* cloudstorage_googledrive_getresourcecreatedtime(void* lpObj, int resourceindex);
int cloudstorage_googledrive_setresourcecreatedtime(void* lpObj, int resourceindex, const char* lpszResourceCreatedTime);

char* cloudstorage_googledrive_getresourcedescription(void* lpObj, int resourceindex);
int cloudstorage_googledrive_setresourcedescription(void* lpObj, int resourceindex, const char* lpszResourceDescription);

char* cloudstorage_googledrive_getresourceextension(void* lpObj, int resourceindex);

char* cloudstorage_googledrive_getresourceid(void* lpObj, int resourceindex);
int cloudstorage_googledrive_setresourceid(void* lpObj, int resourceindex, const char* lpszResourceId);

char* cloudstorage_googledrive_getresourcemd5checksum(void* lpObj, int resourceindex);

char* cloudstorage_googledrive_getresourcemimetype(void* lpObj, int resourceindex);
int cloudstorage_googledrive_setresourcemimetype(void* lpObj, int resourceindex, const char* lpszResourceMIMEType);

char* cloudstorage_googledrive_getresourcemodifiedtime(void* lpObj, int resourceindex);
int cloudstorage_googledrive_setresourcemodifiedtime(void* lpObj, int resourceindex, const char* lpszResourceModifiedTime);

char* cloudstorage_googledrive_getresourcename(void* lpObj, int resourceindex);
int cloudstorage_googledrive_setresourcename(void* lpObj, int resourceindex, const char* lpszResourceName);

char* cloudstorage_googledrive_getresourceoriginalname(void* lpObj, int resourceindex);

char* cloudstorage_googledrive_getresourceowner(void* lpObj, int resourceindex);

char* cloudstorage_googledrive_getresourceowneremail(void* lpObj, int resourceindex);

char* cloudstorage_googledrive_getresourceparentids(void* lpObj, int resourceindex);
int cloudstorage_googledrive_setresourceparentids(void* lpObj, int resourceindex, const char* lpszResourceParentIds);

char* cloudstorage_googledrive_getresourceshareddriveid(void* lpObj, int resourceindex);

int64 cloudstorage_googledrive_getresourcesize(void* lpObj, int resourceindex);

int cloudstorage_googledrive_getresourcestarred(void* lpObj, int resourceindex);
int cloudstorage_googledrive_setresourcestarred(void* lpObj, int resourceindex, int bResourceStarred);

int cloudstorage_googledrive_getresourcetrashed(void* lpObj, int resourceindex);
int cloudstorage_googledrive_setresourcetrashed(void* lpObj, int resourceindex, int bResourceTrashed);

int cloudstorage_googledrive_getresourcetype(void* lpObj, int resourceindex);

int cloudstorage_googledrive_getresourceviewed(void* lpObj, int resourceindex);

char* cloudstorage_googledrive_getresourceviewlink(void* lpObj, int resourceindex);

int GetResourceCount();
int SetResourceCount(int iResourceCount);

bool GetResourceContentAccessible(int iResourceIndex);
int SetResourceContentAccessible(int iResourceIndex, bool bResourceContentAccessible);

QString GetResourceCreatedTime(int iResourceIndex);
int SetResourceCreatedTime(int iResourceIndex, QString qsResourceCreatedTime);

QString GetResourceDescription(int iResourceIndex);
int SetResourceDescription(int iResourceIndex, QString qsResourceDescription);

QString GetResourceExtension(int iResourceIndex);

QString GetResourceId(int iResourceIndex);
int SetResourceId(int iResourceIndex, QString qsResourceId);

QString GetResourceMD5Checksum(int iResourceIndex);

QString GetResourceMIMEType(int iResourceIndex);
int SetResourceMIMEType(int iResourceIndex, QString qsResourceMIMEType);

QString GetResourceModifiedTime(int iResourceIndex);
int SetResourceModifiedTime(int iResourceIndex, QString qsResourceModifiedTime);

QString GetResourceName(int iResourceIndex);
int SetResourceName(int iResourceIndex, QString qsResourceName);

QString GetResourceOriginalName(int iResourceIndex);

QString GetResourceOwner(int iResourceIndex);

QString GetResourceOwnerEmail(int iResourceIndex);

QString GetResourceParentIds(int iResourceIndex);
int SetResourceParentIds(int iResourceIndex, QString qsResourceParentIds);

QString GetResourceSharedDriveId(int iResourceIndex);

qint64 GetResourceSize(int iResourceIndex);

bool GetResourceStarred(int iResourceIndex);
int SetResourceStarred(int iResourceIndex, bool bResourceStarred);

bool GetResourceTrashed(int iResourceIndex);
int SetResourceTrashed(int iResourceIndex, bool bResourceTrashed);

int GetResourceType(int iResourceIndex);

bool GetResourceViewed(int iResourceIndex);

QString GetResourceViewLink(int iResourceIndex);

Remarks

This collection holds a list of file and folder resources.

Calling ListResources, ListParents, or GetResourceInfo will populate this collection.

Also see the UploadFile and UpdateResource methods for information on how they use this collection.

This property is not available at design time.

Data Type

CloudStorageGDriveResource

ResumeURL Property (GoogleDrive Class)

The resumable upload URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResumeURL();
int SetResumeURL(const char* lpszResumeURL);

Unicode (Windows)
LPWSTR GetResumeURL();
INT SetResumeURL(LPCWSTR lpszResumeURL);

char* cloudstorage_googledrive_getresumeurl(void* lpObj);
int cloudstorage_googledrive_setresumeurl(void* lpObj, const char* lpszResumeURL);

QString GetResumeURL();
int SetResumeURL(QString qsResumeURL);

Default Value

""

Remarks

This property holds the URL of the resumable upload session. This is populated by the class automatically when UseResumableUpload is set to true and UploadFile is called to initiate a new upload.

This must be set in order to resume an interrupted upload. See UploadFile for details.

This property is not available at design time.

Data Type

String

SharedDrive Property (GoogleDrive Class)

The shared drive to list file and folder resources for.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSharedDrive();
int SetSharedDrive(const char* lpszSharedDrive);

Unicode (Windows)
LPWSTR GetSharedDrive();
INT SetSharedDrive(LPCWSTR lpszSharedDrive);

char* cloudstorage_googledrive_getshareddrive(void* lpObj);
int cloudstorage_googledrive_setshareddrive(void* lpObj, const char* lpszSharedDrive);

QString GetSharedDrive();
int SetSharedDrive(QString qsSharedDrive);

Default Value

""

Remarks

When ListResourcesScope is set to lrsSharedDrive (2), this property must be set to a shared drive resource Id before calling ListResources or ListChildren.

This property may also be set to a shared drive resource Id before calling GetCurrentChangeMarker or ListChanges in order to list changes to the specified shared drive and its contents.

Refer to ListResources or ListChanges for more information.

This property is not available at design time.

Data Type

String

SharedDriveMarker Property (GoogleDrive Class)

A marker when shared drives are paged.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSharedDriveMarker();
int SetSharedDriveMarker(const char* lpszSharedDriveMarker);

Unicode (Windows)
LPWSTR GetSharedDriveMarker();
INT SetSharedDriveMarker(LPCWSTR lpszSharedDriveMarker);

char* cloudstorage_googledrive_getshareddrivemarker(void* lpObj);
int cloudstorage_googledrive_setshareddrivemarker(void* lpObj, const char* lpszSharedDriveMarker);

QString GetSharedDriveMarker();
int SetSharedDriveMarker(QString qsSharedDriveMarker);

Default Value

""

Remarks

This property returns a marker used to iterate over pages of shared drives; it's populated when ListSharedDrives is called if the results are paged.

Continue to call ListSharedDrives until this property returns empty string in order to list all shared drives.

This property is not available at design time.

Data Type

String

SharedDrives Property (GoogleDrive Class)

A collection of shared drives.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageGDriveSharedDrive>* GetSharedDrives();

int cloudstorage_googledrive_getshareddrivecount(void* lpObj);

int cloudstorage_googledrive_getshareddrivecapabilities(void* lpObj, int shareddriveindex);

char* cloudstorage_googledrive_getshareddrivecreatedtime(void* lpObj, int shareddriveindex);

int cloudstorage_googledrive_getshareddrivehidden(void* lpObj, int shareddriveindex);

char* cloudstorage_googledrive_getshareddriveid(void* lpObj, int shareddriveindex);

char* cloudstorage_googledrive_getshareddrivename(void* lpObj, int shareddriveindex);

int cloudstorage_googledrive_getshareddriverestrictions(void* lpObj, int shareddriveindex);

int GetSharedDriveCount();

int GetSharedDriveCapabilities(int iSharedDriveIndex);

QString GetSharedDriveCreatedTime(int iSharedDriveIndex);

bool GetSharedDriveHidden(int iSharedDriveIndex);

QString GetSharedDriveId(int iSharedDriveIndex);

QString GetSharedDriveName(int iSharedDriveIndex);

int GetSharedDriveRestrictions(int iSharedDriveIndex);

Remarks

This collection holds a list of shared drives.

Calling ListSharedDrives will populate this collection.

This property is read-only and not available at design time.

Data Type

CloudStorageGDriveSharedDrive

SSLAcceptServerCert Property (GoogleDrive Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

CloudStorageCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(CloudStorageCertificate* val);

char* cloudstorage_googledrive_getsslacceptservercerteffectivedate(void* lpObj);

char* cloudstorage_googledrive_getsslacceptservercertexpirationdate(void* lpObj);

char* cloudstorage_googledrive_getsslacceptservercertextendedkeyusage(void* lpObj);

char* cloudstorage_googledrive_getsslacceptservercertfingerprint(void* lpObj);

char* cloudstorage_googledrive_getsslacceptservercertfingerprintsha1(void* lpObj);

char* cloudstorage_googledrive_getsslacceptservercertfingerprintsha256(void* lpObj);

char* cloudstorage_googledrive_getsslacceptservercertissuer(void* lpObj);

char* cloudstorage_googledrive_getsslacceptservercertprivatekey(void* lpObj);

int cloudstorage_googledrive_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* cloudstorage_googledrive_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* cloudstorage_googledrive_getsslacceptservercertpublickey(void* lpObj);

char* cloudstorage_googledrive_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int cloudstorage_googledrive_getsslacceptservercertpublickeylength(void* lpObj);

char* cloudstorage_googledrive_getsslacceptservercertserialnumber(void* lpObj);

char* cloudstorage_googledrive_getsslacceptservercertsignaturealgorithm(void* lpObj);

int cloudstorage_googledrive_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int cloudstorage_googledrive_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* cloudstorage_googledrive_getsslacceptservercertstorepassword(void* lpObj);
int cloudstorage_googledrive_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int cloudstorage_googledrive_getsslacceptservercertstoretype(void* lpObj);
int cloudstorage_googledrive_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* cloudstorage_googledrive_getsslacceptservercertsubjectaltnames(void* lpObj);

char* cloudstorage_googledrive_getsslacceptservercertthumbprintmd5(void* lpObj);

char* cloudstorage_googledrive_getsslacceptservercertthumbprintsha1(void* lpObj);

char* cloudstorage_googledrive_getsslacceptservercertthumbprintsha256(void* lpObj);

char* cloudstorage_googledrive_getsslacceptservercertusage(void* lpObj);

int cloudstorage_googledrive_getsslacceptservercertusageflags(void* lpObj);

char* cloudstorage_googledrive_getsslacceptservercertversion(void* lpObj);

char* cloudstorage_googledrive_getsslacceptservercertsubject(void* lpObj);
int cloudstorage_googledrive_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int cloudstorage_googledrive_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudstorage_googledrive_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

CloudStorageCertificate

SSLCert Property (GoogleDrive Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

CloudStorageCertificate* GetSSLCert();
int SetSSLCert(CloudStorageCertificate* val);

char* cloudstorage_googledrive_getsslcerteffectivedate(void* lpObj);

char* cloudstorage_googledrive_getsslcertexpirationdate(void* lpObj);

char* cloudstorage_googledrive_getsslcertextendedkeyusage(void* lpObj);

char* cloudstorage_googledrive_getsslcertfingerprint(void* lpObj);

char* cloudstorage_googledrive_getsslcertfingerprintsha1(void* lpObj);

char* cloudstorage_googledrive_getsslcertfingerprintsha256(void* lpObj);

char* cloudstorage_googledrive_getsslcertissuer(void* lpObj);

char* cloudstorage_googledrive_getsslcertprivatekey(void* lpObj);

int cloudstorage_googledrive_getsslcertprivatekeyavailable(void* lpObj);

char* cloudstorage_googledrive_getsslcertprivatekeycontainer(void* lpObj);

char* cloudstorage_googledrive_getsslcertpublickey(void* lpObj);

char* cloudstorage_googledrive_getsslcertpublickeyalgorithm(void* lpObj);

int cloudstorage_googledrive_getsslcertpublickeylength(void* lpObj);

char* cloudstorage_googledrive_getsslcertserialnumber(void* lpObj);

char* cloudstorage_googledrive_getsslcertsignaturealgorithm(void* lpObj);

int cloudstorage_googledrive_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudstorage_googledrive_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* cloudstorage_googledrive_getsslcertstorepassword(void* lpObj);
int cloudstorage_googledrive_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int cloudstorage_googledrive_getsslcertstoretype(void* lpObj);
int cloudstorage_googledrive_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* cloudstorage_googledrive_getsslcertsubjectaltnames(void* lpObj);

char* cloudstorage_googledrive_getsslcertthumbprintmd5(void* lpObj);

char* cloudstorage_googledrive_getsslcertthumbprintsha1(void* lpObj);

char* cloudstorage_googledrive_getsslcertthumbprintsha256(void* lpObj);

char* cloudstorage_googledrive_getsslcertusage(void* lpObj);

int cloudstorage_googledrive_getsslcertusageflags(void* lpObj);

char* cloudstorage_googledrive_getsslcertversion(void* lpObj);

char* cloudstorage_googledrive_getsslcertsubject(void* lpObj);
int cloudstorage_googledrive_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int cloudstorage_googledrive_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudstorage_googledrive_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

CloudStorageCertificate

SSLProvider Property (GoogleDrive Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int cloudstorage_googledrive_getsslprovider(void* lpObj);
int cloudstorage_googledrive_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCert Property (GoogleDrive Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

CloudStorageCertificate* GetSSLServerCert();

char* cloudstorage_googledrive_getsslservercerteffectivedate(void* lpObj);

char* cloudstorage_googledrive_getsslservercertexpirationdate(void* lpObj);

char* cloudstorage_googledrive_getsslservercertextendedkeyusage(void* lpObj);

char* cloudstorage_googledrive_getsslservercertfingerprint(void* lpObj);

char* cloudstorage_googledrive_getsslservercertfingerprintsha1(void* lpObj);

char* cloudstorage_googledrive_getsslservercertfingerprintsha256(void* lpObj);

char* cloudstorage_googledrive_getsslservercertissuer(void* lpObj);

char* cloudstorage_googledrive_getsslservercertprivatekey(void* lpObj);

int cloudstorage_googledrive_getsslservercertprivatekeyavailable(void* lpObj);

char* cloudstorage_googledrive_getsslservercertprivatekeycontainer(void* lpObj);

char* cloudstorage_googledrive_getsslservercertpublickey(void* lpObj);

char* cloudstorage_googledrive_getsslservercertpublickeyalgorithm(void* lpObj);

int cloudstorage_googledrive_getsslservercertpublickeylength(void* lpObj);

char* cloudstorage_googledrive_getsslservercertserialnumber(void* lpObj);

char* cloudstorage_googledrive_getsslservercertsignaturealgorithm(void* lpObj);

int cloudstorage_googledrive_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* cloudstorage_googledrive_getsslservercertstorepassword(void* lpObj);

int cloudstorage_googledrive_getsslservercertstoretype(void* lpObj);

char* cloudstorage_googledrive_getsslservercertsubjectaltnames(void* lpObj);

char* cloudstorage_googledrive_getsslservercertthumbprintmd5(void* lpObj);

char* cloudstorage_googledrive_getsslservercertthumbprintsha1(void* lpObj);

char* cloudstorage_googledrive_getsslservercertthumbprintsha256(void* lpObj);

char* cloudstorage_googledrive_getsslservercertusage(void* lpObj);

int cloudstorage_googledrive_getsslservercertusageflags(void* lpObj);

char* cloudstorage_googledrive_getsslservercertversion(void* lpObj);

char* cloudstorage_googledrive_getsslservercertsubject(void* lpObj);

int cloudstorage_googledrive_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

CloudStorageCertificate

StartByte Property (GoogleDrive Class)

The byte offset from which to start the upload or download.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetStartByte();
int SetStartByte(int64 lStartByte);

Unicode (Windows)
LONG64 GetStartByte();
INT SetStartByte(LONG64 lStartByte);

int64 cloudstorage_googledrive_getstartbyte(void* lpObj);
int cloudstorage_googledrive_setstartbyte(void* lpObj, int64 lStartByte);

qint64 GetStartByte();
int SetStartByte(qint64 lStartByte);

Default Value

0

Remarks

This property may be set to resume an upload or download; it specifies the offset in the file (or stream, when uploading) from which to resume. See UploadFile and DownloadFile for details about resuming uploads and downloads.

When uploading from a stream, the class will always seek forward in the stream if the value of StartByte is greater than 0 when UploadFile is called. Keep this in mind when resuming interrupted uploads.

This property is not available at design time.

Data Type

Long64

Timeout Property (GoogleDrive Class)

The timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int cloudstorage_googledrive_gettimeout(void* lpObj);
int cloudstorage_googledrive_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UseResumableUpload Property (GoogleDrive Class)

Whether to use resumable uploads.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseResumableUpload();
int SetUseResumableUpload(int bUseResumableUpload);

Unicode (Windows)
BOOL GetUseResumableUpload();
INT SetUseResumableUpload(BOOL bUseResumableUpload);

int cloudstorage_googledrive_getuseresumableupload(void* lpObj);
int cloudstorage_googledrive_setuseresumableupload(void* lpObj, int bUseResumableUpload);

bool GetUseResumableUpload();
int SetUseResumableUpload(bool bUseResumableUpload);

Default Value

FALSE

Remarks

This property controls whether simple or resumable uploads are used when UploadFile is called. The default value is false (simple uploads are used).

Refer to UploadFile for more information.

This property is not available at design time.

Data Type

Boolean

AddParents Method (GoogleDrive Class)

Adds folders to the list of parents for a file or folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddParents(const char* lpszResourceId, const char* lpszParentIds);

Unicode (Windows)
INT AddParents(LPCWSTR lpszResourceId, LPCWSTR lpszParentIds);

int cloudstorage_googledrive_addparents(void* lpObj, const char* lpszResourceId, const char* lpszParentIds);

int AddParents(const QString& qsResourceId, const QString& qsParentIds);

Remarks

This method adds one or more folders, specified by ParentIds, to the list of parents for the file or folder specified by ResourceId.

ParentIds should be specified as a comma-separated list of one or more resource Ids.

Note that resources within a shared drive must always have exactly one parent, and that only shared drive members with the "file organizer" or "organizer" roles can move files and folders within a shared drive.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddQueryParam Method (GoogleDrive Class)

Adds a query parameter to the QueryParams properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddQueryParam(const char* lpszName, const char* lpszValue);

Unicode (Windows)
INT AddQueryParam(LPCWSTR lpszName, LPCWSTR lpszValue);

int cloudstorage_googledrive_addqueryparam(void* lpObj, const char* lpszName, const char* lpszValue);

int AddQueryParam(const QString& qsName, const QString& qsValue);

Remarks

This method is used to add a query parameter to the QueryParams properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddSharedDriveMember Method (GoogleDrive Class)

Creates a new shared drive member.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* AddSharedDriveMember(const char* lpszSharedDriveId, int iRole, int iPermissionType, const char* lpszEmail);

Unicode (Windows)
LPWSTR AddSharedDriveMember(LPCWSTR lpszSharedDriveId, INT iRole, INT iPermissionType, LPCWSTR lpszEmail);

char* cloudstorage_googledrive_addshareddrivemember(void* lpObj, const char* lpszSharedDriveId, int iRole, int iPermissionType, const char* lpszEmail);

QString AddSharedDriveMember(const QString& qsSharedDriveId, int iRole, int iPermissionType, const QString& qsEmail);

Remarks

This is a convenience method that adds a new member to the shared drive specified by SharedDriveId by creating a permission on that shared drive. The Id of the newly-created permission is returned.

Role specifies the member's role. Valid values are:

PermissionType must be one of:

• 0 (ptUser) - A single user.
• 1 (ptGroup) - A group.

Email specifies the email address of the user or the group.

Refer to UpdatePermissions for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once. string sharedDriveId = "20983euijdsds"; // First, we'll add a new member to the shared drive. The two integer parameters signify: // * The role type. 2 is the "Writer" role, which provides read and write (but not organize) permissions. // * The permission type. 0 means this is a single user (versus a group). // The Id of the new permission we've created on the shared drive--which is what actually causes the user to // be a member of the shared drive--is returned. string permId = googledrive.AddSharedDriveMember(sharedDriveId, 2, 0, "fakeuser@example.com"); // At some point later, perhaps this user has abused their privileges and we wish to revoke their writer // permissions. We change their role to "Commenter", which provides reader and commenting permissions. googledrive.UpdateSharedDriveMember(sharedDriveId, permId, 1); // 1 is the "Commenter" role. // Or perhaps we wish to simply remove the user's shared drive membership completely. googledrive.RemoveSharedDriveMember(sharedDriveId, permId);

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Authorize Method (GoogleDrive Class)

Get the authorization string required to access the protected resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Authorize();

Unicode (Windows)
INT Authorize();

int cloudstorage_googledrive_authorize(void* lpObj);

int Authorize();

Remarks

This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the ClientProfile field and the GrantType field. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth property.

For more information, see the introduction section.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CalcAuthorization Method (GoogleDrive Class)

Calculates the Authorization header based on provided credentials.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CalcAuthorization();

Unicode (Windows)
INT CalcAuthorization();

int cloudstorage_googledrive_calcauthorization(void* lpObj);

int CalcAuthorization();

Remarks

This method calculates the Authorization value using the values provided in AuthScheme, User and Password.

In most cases this method does not need to be called. The class will automatically calculate any required authorization values when a method is called such as Get or Post.

This method may be useful in cases where the Authorization value needs to be calculated prior to sending a request.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (GoogleDrive Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* cloudstorage_googledrive_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CopyResource Method (GoogleDrive Class)

Copies a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CopyResource(const char* lpszResourceId, const char* lpszNewName, const char* lpszParentIds);

Unicode (Windows)
LPWSTR CopyResource(LPCWSTR lpszResourceId, LPCWSTR lpszNewName, LPCWSTR lpszParentIds);

char* cloudstorage_googledrive_copyresource(void* lpObj, const char* lpszResourceId, const char* lpszNewName, const char* lpszParentIds);

QString CopyResource(const QString& qsResourceId, const QString& qsNewName, const QString& qsParentIds);

Remarks

This method copies the file identified by ResourceId and returns the Id of the newly created copy.

The NewName parameter defines the name of the copied file.

The ParentIds parameter should be a comma-separated list of existing folder Ids to use as parents for the copied file. If left blank, the copied file will inherit the same parents of the original.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateFolder Method (GoogleDrive Class)

Creates a new folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CreateFolder(const char* lpszName, const char* lpszParentIds);

Unicode (Windows)
LPWSTR CreateFolder(LPCWSTR lpszName, LPCWSTR lpszParentIds);

char* cloudstorage_googledrive_createfolder(void* lpObj, const char* lpszName, const char* lpszParentIds);

QString CreateFolder(const QString& qsName, const QString& qsParentIds);

Remarks

This method creates a new folder with the specified Name and returns its Id. ParentIds can be a list of existing folder Ids to use as parents for the new folder, or empty string to create the folder at the root of the drive.

If the IncludeFolderProperties configuration setting is true when this method is called, the class will include the metadata held by the first item in the Resources properties when creating the folder. (Note that the Name and ParentIds passed to this method will take precedence.)

Google treats files and folders in the same way, and folders are included when listing resources. The Type field can be used to determine if a resource is a folder, a file, or a revision of a file.

To list, delete, and update folders use the ListResources, DeleteResource, and UpdateResource methods.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateSharedDrive Method (GoogleDrive Class)

Creates a new shared drive.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CreateSharedDrive(const char* lpszName, const char* lpszRequestId);

Unicode (Windows)
LPWSTR CreateSharedDrive(LPCWSTR lpszName, LPCWSTR lpszRequestId);

char* cloudstorage_googledrive_createshareddrive(void* lpObj, const char* lpszName, const char* lpszRequestId);

QString CreateSharedDrive(const QString& qsName, const QString& qsRequestId);

Remarks

This method creates a new shared drive and returns the newly-created shared drive's Id.

Name is the name of the new shared drive.

RequestId is a unique value used by the server to identify an idempotent request by the current user to create a shared drive. (That is, the server ensures that duplicate shared drives are not created if any given user makes repeated shared drive creation requests with the same Name and RequestId.)

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DeleteResource Method (GoogleDrive Class)

Deletes the specified file or folder permanently.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteResource(const char* lpszResourceId);

Unicode (Windows)
INT DeleteResource(LPCWSTR lpszResourceId);

int cloudstorage_googledrive_deleteresource(void* lpObj, const char* lpszResourceId);

int DeleteResource(const QString& qsResourceId);

Remarks

This method deletes the file or folder specified by ResourceId permanently.

Files and folders are not moved to the trash, they are deleted permanently. You can use TrashResource to move files or folders to the trash.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteSharedDrive Method (GoogleDrive Class)

Deletes a shared drive.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteSharedDrive(const char* lpszSharedDriveId);

Unicode (Windows)
INT DeleteSharedDrive(LPCWSTR lpszSharedDriveId);

int cloudstorage_googledrive_deleteshareddrive(void* lpObj, const char* lpszSharedDriveId);

int DeleteSharedDrive(const QString& qsSharedDriveId);

Remarks

This method deletes the shared drive specified by SharedDriveId.

Note that only members of a shared drive with the prOrganizer (5) role can delete it, and that the shared drive must be empty (or all of its items must be in the trash).

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DownloadFile Method (GoogleDrive Class)

Downloads, and optionally converts, a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DownloadFile(const char* lpszResourceId, const char* lpszMimeType);

Unicode (Windows)
INT DownloadFile(LPCWSTR lpszResourceId, LPCWSTR lpszMimeType);

int cloudstorage_googledrive_downloadfile(void* lpObj, const char* lpszResourceId, const char* lpszMimeType);

int DownloadFile(const QString& qsResourceId, const QString& qsMimeType);

Remarks

This method downloads the file specified by ResourceId.

If a stream has been specified using SetDownloadStream, the file data will be sent through it. If a stream is not specified, and LocalFile is set, the file will be saved to the specified location; otherwise, the file data will be held by ResourceData.

If the empty string is passed for MimeType, the file will be downloaded as-is. If the file is in one of the Google formats shown in the table below, one of the MIME types shown in the third column can be passed for MimeType instead to convert the file before downloading it.

Download Notes

To decrypt an encrypted file set EncryptionAlgorithm and EncryptionPassword before calling this method. googledrive.LocalFile = "../MyFile.zip"; googledrive.DownloadFile(googledrive.Resources[0].Id, "");

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyFile.zip"; googledrive.LocalFile = downloadFile; googledrive.DownloadFile(googledrive.Resources[0].Id, ""); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file googledrive.StartByte = new FileInfo(downloadFile).Length; googledrive.DownloadFile(googledrive.Resources[0].Id, "");

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.

If LocalFile is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile. googledrive.LocalFile = "../MyFile.zip"; googledrive.EncryptionPassword = "password"; googledrive.DownloadFile(googledrive.Resource[0].Id, ""); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially download temp file googledrive.StartByte = new FileInfo(googledrive.Config("DownloadTempFile")).Length; googledrive.DownloadFile(googledrive.Resource[0].Id, "");

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

EmptyTrash Method (GoogleDrive Class)

Permanently deletes all of the current user's trashed files.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EmptyTrash();

Unicode (Windows)
INT EmptyTrash();

int cloudstorage_googledrive_emptytrash(void* lpObj);

int EmptyTrash();

Remarks

This method permanently deletes all of the current user's trashed files by emptying the trash for their "My Drive".

It is not possible to recover trashed files after this method is called!

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetAccountInfo Method (GoogleDrive Class)

Gets information about the current user's account and space usage.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAccountInfo();

Unicode (Windows)
INT GetAccountInfo();

int cloudstorage_googledrive_getaccountinfo(void* lpObj);

int GetAccountInfo();

Remarks

This method gets information about the current user's account and space usage, populating the Account object property's fields.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetCurrentChangeMarker Method (GoogleDrive Class)

Gets the most current change marker.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCurrentChangeMarker();

Unicode (Windows)
INT GetCurrentChangeMarker();

int cloudstorage_googledrive_getcurrentchangemarker(void* lpObj);

int GetCurrentChangeMarker();

Remarks

This method populates NextChangeMarker with the most current change marker available.

Refer to ListChanges for more information.

If SharedDrive is set, this method will get the most current change marker available for that shared drive's changes.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetPermissionInfo Method (GoogleDrive Class)

Gets information about a specific permission.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPermissionInfo(const char* lpszResourceId, const char* lpszPermissionId);

Unicode (Windows)
INT GetPermissionInfo(LPCWSTR lpszResourceId, LPCWSTR lpszPermissionId);

int cloudstorage_googledrive_getpermissioninfo(void* lpObj, const char* lpszResourceId, const char* lpszPermissionId);

int GetPermissionInfo(const QString& qsResourceId, const QString& qsPermissionId);

Remarks

This method retrieves information about the permission specified by PermissionId on the file, folder, or shared drive specified by ResourceId.

Calling this method will fire the PermissionList event, and will populate the Permissions properties (clearing any previously-held items in the process).

Shared Drive Members

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetResourceInfo Method (GoogleDrive Class)

Gets information about specific files and folders.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetResourceInfo(const char* lpszResourceIds);

Unicode (Windows)
INT GetResourceInfo(LPCWSTR lpszResourceIds);

int cloudstorage_googledrive_getresourceinfo(void* lpObj, const char* lpszResourceIds);

int GetResourceInfo(const QString& qsResourceIds);

Remarks

This method retrieves information about the file and folder resources specified by ResourceIds (which should be specified as a comma-separated list of resource Ids).

Calling this method will fire the ResourceList event once for each resource, and will populate the Resources properties (clearing any previously-held items in the process).

Note that, unlike the ListResources and ListChildren methods, this method uses the resource Ids to retrieve information directly. This means that it does not support paged results or complex search queries (the "q" query parameter), does not need to know whether the resources are in shared drives, etc.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetSharedDriveInfo Method (GoogleDrive Class)

Gets information about a specific shared drive.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSharedDriveInfo(const char* lpszSharedDriveId);

Unicode (Windows)
INT GetSharedDriveInfo(LPCWSTR lpszSharedDriveId);

int cloudstorage_googledrive_getshareddriveinfo(void* lpObj, const char* lpszSharedDriveId);

int GetSharedDriveInfo(const QString& qsSharedDriveId);

Remarks

This method retrieves information about the shared drive specified by SharedDriveId.

Calling this method will fire the SharedDriveList event, and will populate the SharedDrives properties (clearing any previously-held items in the process).

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetUploadStatus Method (GoogleDrive Class)

Gets the status of a resumable upload session.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUploadStatus();

Unicode (Windows)
INT GetUploadStatus();

int cloudstorage_googledrive_getuploadstatus(void* lpObj);

int GetUploadStatus();

Remarks

This method gets the status of a resumable upload session. Set ResumeURL before calling this method. After calling this method StartByte will be populated.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (GoogleDrive Class)

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int cloudstorage_googledrive_interrupt(void* lpObj);

int Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListChanges Method (GoogleDrive Class)

Lists changes to resources and shared drives.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListChanges();

Unicode (Windows)
INT ListChanges();

int cloudstorage_googledrive_listchanges(void* lpObj);

int ListChanges();

Remarks

This method lists changes to resources and shared drives.

General Usage

If there are still more changes available to list when this method returns, the ChangeMarker property will be populated. Continue to call this method until ChangeMarker is empty to accumulate all pages of results in the Changes properties. (Once there aren't any more changes available to list, the NextChangeMarker property will be populated instead.) Alternatively, the AccumulatePages configuration setting can be disabled to clear the Changes properties every time a page of results is returned.

Calling GetCurrentChangeMarker will immediately populate NextChangeMarker. Regardless of whether it is populated because of a call to GetCurrentChangeMarker or to ListChanges, NextChangeMarker is always populated with a value that (at the time of population) points to the most current state. (Since "the most current state" implies that there are no further changes to list, calling ListChanges immediately after NextChangeMarker is populated will not return any further changes.)

Setting ChangeMarker to "1" will cause ListChanges to list changes beginning with the very first change available.

Example of Listing Changes // Start listing changes from the beginning, and list a maximum of 10 changes at a time. googledrive.ChangeMarker = "1"; googledrive.Config("MaxResults=10"); // List changes once. googledrive.ListChanges(); do { for (int i = 0; i < googledrive.Changes.Count; i++) { Console.WriteLine(googledrive.Changes[i].ResourceId); Console.WriteLine(googledrive.Changes[i].Time); Console.WriteLine(googledrive.Changes[i].Removed); } // Continue to call ListChanges() until ChangeMarker is the empty string (indicating there // are no more changes to list). googledrive.ListChanges(); } while (googledrive.ChangeMarker.Length > 0); // Now NextChangeMarker will be populated. If we were to call ListChanges() again right now, // nothing would be listed and NextChangeMarker would still be populated. // Wait 2 minutes and then try to list changes again. Thread.Sleep(120000); googledrive.ListChanges(); do { for (int i = 0; i < googledrive.Changes.Count; i++) { Console.WriteLine(googledrive.Changes[i].ResourceId); Console.WriteLine(googledrive.Changes[i].Time); Console.WriteLine(googledrive.Changes[i].Removed); } googledrive.ListChanges(); } while (googledrive.ChangeMarker.Length > 0);

Shared Drive Functionality

If SharedDrive is empty string, then changes for items in shared drives that the user has accessed will be included (in addition to the usual changes for the user's items). Changes to the shared drives themselves which the user is a member of will also be included.

If SharedDrive is populated with a shared drive resource Id, then only changes to items within that shared drive, as well as changes to that shared drive itself, will be returned.

A change's Type will reflect whether it is associated with a file or folder (0), or a shared drive itself (1).

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListChildren Method (GoogleDrive Class)

Lists the child resources of one or more folders.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListChildren(const char* lpszFolderIds);

Unicode (Windows)
INT ListChildren(LPCWSTR lpszFolderIds);

int cloudstorage_googledrive_listchildren(void* lpObj, const char* lpszFolderIds);

int ListChildren(const QString& qsFolderIds);

Remarks

This is a convenience method that works the same way as ListResources, but limits the results to children of one or more folders specified by FolderIds (which should be specified as a comma-separated list of folder resource Ids).

Calling this method will fire the ResourceList event once for each resource, and will also populate the Children properties.

If there are still more child resources available to list when this method returns, the ChildMarker property will be populated. Continue to call this method until ChildMarker is empty to accumulate all pages of results in the Children properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Children properties every time a page of results is returned.

Note that the string "root" may be used as a folder Id to represent the root folder of a drive.

Refer to ListResources for more information about how listing resources works in general, everything there applies to this method too. // ResourceList event handler. googledrive.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; // List all of the children of the given folder resource. do { googledrive.ListChildren("12978eyuihusd"); for (int i = 0; i < googledrive.Children.Count; i++) { // Process child resources here. } } while (!string.IsNullOrEmpty(googledrive.ChildMarker));

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListParents Method (GoogleDrive Class)

Lists the parent folders of a file or folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListParents(const char* lpszResourceId);

Unicode (Windows)
INT ListParents(LPCWSTR lpszResourceId);

int cloudstorage_googledrive_listparents(void* lpObj, const char* lpszResourceId);

int ListParents(const QString& qsResourceId);

Remarks

This is a convenience method that simply retrieves the parent Ids of the file or folder specified by ResourceId and passes them to GetResourceInfo.

Refer to GetResourceInfo for more information.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListPermissions Method (GoogleDrive Class)

Lists the permissions for a file, folder, or shared drive.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListPermissions(const char* lpszResourceId);

Unicode (Windows)
INT ListPermissions(LPCWSTR lpszResourceId);

int cloudstorage_googledrive_listpermissions(void* lpObj, const char* lpszResourceId);

int ListPermissions(const QString& qsResourceId);

Remarks

This method is used to list permissions for the file, folder, or shared drive specified by ResourceId.

Calling this method will fire the PermissionList event once for each permission, and will also populate the Permissions properties.

If there are still more permissions available to list when this method returns, the PermissionMarker property will be populated. Continue to call this method until PermissionMarker is empty to accumulate all pages of results in the Permissions properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Permissions properties every time a page of results is returned. // PermissionList event handler. googledrive.OnPermissionList += (s, e) => { Console.WriteLine("Permission Id: " + e.Id); }; // List all of the permissions on the given resource. do { googledrive.ListPermissions("fdjhskdf89o3wi"); for (int i = 0; i < googledrive.Permissions.Count; i++) { // Process permissions here. } } while (!string.IsNullOrEmpty(googledrive.PermissionMarker));

Shared Drive Members

Shared Drive Capabilities

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListResources Method (GoogleDrive Class)

Lists files and folders.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListResources();

Unicode (Windows)
INT ListResources();

int cloudstorage_googledrive_listresources(void* lpObj);

int ListResources();

Remarks

This method is used to list file and folders. Calling this method will fire the ResourceList event once for each resource, and will also populate the Resources properties.

If there are still more resources available to list when this method returns, the ResourceMarker property will be populated. Continue to call this method until ResourceMarker is empty to accumulate all pages of results in the Resources properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Resources properties every time a page of results is returned.

Listing Resources

To simply list the children or parents of specific resources, use ListChildren or ListParents. To retrieve information about specific resources, use GetResourceInfo.

For more complex queries, refer to the Google Drive API documentation for information on how to construct a search query, then use the AddQueryParam method to add a query parameter named "q" to the QueryParams properties before calling this method.

Result Scopes

When ListResources is called with ListResourcesScope set to the default of lrsUser (0), the results will consist of items that are in the current user's "My Drive" and "Shared with me" spaces.

If ListResourcesScope is set to lrsDomain (1), the results will instead consist of items which have been shared to the current user's domain, whether or not the user has actually accessed them.

(To clarify, items shared to a user's domain are only added to their "Shared with me" space once the user accesses them for the first time. So, items shared to a user's domain that they have not actually accessed before would not show up when ListResourcesScope is set to lrsUser (0), but would show up when it is set to lrsDomain (1).)

When ListResourcesScope is set to lrsSharedDrive (2), the SharedDrive property must be set to the resource Id of a shared drive, and the results of this method will consist only of items within that shared drive.

When ListResourcesScope is set to lrsAllDrives (3), the results will consist of anything in the user's "My Drive" and "Shared with me" spaces, and all items in all shared drives which the user is a member of.

Note: Under some circumstances, if a user is a member of many shared drives, using the lrsAllDrives (3) will not yield a complete set of results (even with paged results). This is a direct limitation of the Google Drive API, and the only solution is to use a narrower scope. When using the lrsAllDrives (3) scope, you should check the SearchIncomplete configuration setting after calling ListResources; it will return "True" if the result set is incomplete.

How Shared Drives Work

Just like a real user, a shared drive itself owns the files in its storage space (this is why the permissions for members of a shared drive use the "file organizer" and "organizer" roles instead of the "owner" role). Also like a real user, a shared drive's files can be explicitly shared with other users (even if they aren't members of the shared drive), and with the overall domain.

The difference, of course, is that a shared drive has a defined set of members, all of which have access to everything in the shared drive (though with varying capabilities). Refer to UpdatePermissions, AddSharedDriveMember, UpdateSharedDriveMember, and RemoveSharedDriveMember for more information. // ResourceList event handler. googledrive.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; // List all of the current user's resources. googledrive.ListResourcesScope = GoogledriveListResourcesScopes.lrsUser; do { googledrive.ListResources(); for (int i = 0; i < googledrive.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(googledrive.ResourceMarker)); // List all of the resources in the specified shared drive. googledrive.SharedDrive = "wfsr789vusijfv"; googledrive.ListResourcesScope = GoogledriveListResourcesScopes.lrsSharedDrive; do { googledrive.ListResources(); for (int i = 0; i < googledrive.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(googledrive.ResourceMarker));

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListRevisions Method (GoogleDrive Class)

List the revisions of a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListRevisions(const char* lpszFileId);

Unicode (Windows)
INT ListRevisions(LPCWSTR lpszFileId);

int cloudstorage_googledrive_listrevisions(void* lpObj, const char* lpszFileId);

int ListRevisions(const QString& qsFileId);

Remarks

This method will list the revisions of the specified file. Calling this method will fire the ResourceList event once for each revision, and will also populate the Resources properties. The Revision ID will be help in the ResourceId property.

If the Revision ID is set to the RevisionId configuration setting, the following methods can be used to interact with the specific revision:

• DeleteResource
• DownloadFile
• GetResourceInfo
• UpdateResource

After these methods are no longer needed, it is recommended to clear to the RevisionId configuration setting to avoid unattended changes to functionality.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListSharedDrives Method (GoogleDrive Class)

Lists shared drives that the current user is a member of.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListSharedDrives();

Unicode (Windows)
INT ListSharedDrives();

int cloudstorage_googledrive_listshareddrives(void* lpObj);

int ListSharedDrives();

Remarks

This method lists the shared drives which the current user is a member of.

Calling this method will fire the SharedDriveList event once for each shared drive, and will also populate the SharedDrives properties.

If there are still more shared drives available to list when this method returns, the SharedDriveMarker property will be populated. Continue to call this method until SharedDriveMarker is empty to accumulate all pages of results in the SharedDrives properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the SharedDrives properties every time a page of results is returned. // SharedDriveList event handler. googledrive.OnSharedDriveList += (s, e) => { Console.WriteLine(e.Name); }; // List all shared drives the current user is a member of. do { googledrive.ListSharedDrives(); for (int i = 0; i < googledrive.SharedDrives.Count; i++) { // Process shared drives here. } } while (!string.IsNullOrEmpty(googledrive.SharedDriveMarker));

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

MoveResource Method (GoogleDrive Class)

Moves a file or folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int MoveResource(const char* lpszResourceId, const char* lpszNewParentIds);

Unicode (Windows)
INT MoveResource(LPCWSTR lpszResourceId, LPCWSTR lpszNewParentIds);

int cloudstorage_googledrive_moveresource(void* lpObj, const char* lpszResourceId, const char* lpszNewParentIds);

int MoveResource(const QString& qsResourceId, const QString& qsNewParentIds);

Remarks

This method "moves" an existing file or folder specified by ResourceId to the folders specified by NewParentIds (which should be specified as a comma-separated list of folder resource Ids).

After this method returns, the folders specified by NewParentIds will be the only parents of in the resource's parent list. If you wish to add additional parents for the resource without removing its existing parents, use AddParents instead.

Note that resources within a shared drive must always have exactly one parent, and that only shared drive members with the "file organizer" or "organizer" roles can move files and folders within a shared drive.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RemoveParents Method (GoogleDrive Class)

Removes folders from the list of parents for a file or folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RemoveParents(const char* lpszResourceId, const char* lpszParentIds);

Unicode (Windows)
INT RemoveParents(LPCWSTR lpszResourceId, LPCWSTR lpszParentIds);

int cloudstorage_googledrive_removeparents(void* lpObj, const char* lpszResourceId, const char* lpszParentIds);

int RemoveParents(const QString& qsResourceId, const QString& qsParentIds);

Remarks

This method removes one or more folders, specified by ParentIds, from the list of parents for the file or folder specified by ResourceId.

ParentIds should be specified as a comma-separated list of one or more resource Ids.

Note that resources within a shared drive must always have exactly one parent, and that only shared drive members with the "file organizer" or "organizer" roles can move files and folders within a shared drive.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RemoveSharedDriveMember Method (GoogleDrive Class)

Removes an existing shared drive member.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RemoveSharedDriveMember(const char* lpszSharedDriveId, const char* lpszPermissionId);

Unicode (Windows)
INT RemoveSharedDriveMember(LPCWSTR lpszSharedDriveId, LPCWSTR lpszPermissionId);

int cloudstorage_googledrive_removeshareddrivemember(void* lpObj, const char* lpszSharedDriveId, const char* lpszPermissionId);

int RemoveSharedDriveMember(const QString& qsSharedDriveId, const QString& qsPermissionId);

Remarks

This is a convenience method that removes an existing member of a shared drive (specified by SharedDriveId) by deleting their associated permission (specified by PermissionId).

Refer to UpdatePermissions for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once. string sharedDriveId = "20983euijdsds"; // First, we'll add a new member to the shared drive. The two integer parameters signify: // * The role type. 2 is the "Writer" role, which provides read and write (but not organize) permissions. // * The permission type. 0 means this is a single user (versus a group). // The Id of the new permission we've created on the shared drive--which is what actually causes the user to // be a member of the shared drive--is returned. string permId = googledrive.AddSharedDriveMember(sharedDriveId, 2, 0, "fakeuser@example.com"); // At some point later, perhaps this user has abused their privileges and we wish to revoke their writer // permissions. We change their role to "Commenter", which provides reader and commenting permissions. googledrive.UpdateSharedDriveMember(sharedDriveId, permId, 1); // 1 is the "Commenter" role. // Or perhaps we wish to simply remove the user's shared drive membership completely. googledrive.RemoveSharedDriveMember(sharedDriveId, permId);

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (GoogleDrive Class)

Resets the class to its initial state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int cloudstorage_googledrive_reset(void* lpObj);

int Reset();

Remarks

This method resets the class to its initial state.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RestoreResource Method (GoogleDrive Class)

Restores a file or folder from the trash.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RestoreResource(const char* lpszResourceId);

Unicode (Windows)
INT RestoreResource(LPCWSTR lpszResourceId);

int cloudstorage_googledrive_restoreresource(void* lpObj, const char* lpszResourceId);

int RestoreResource(const QString& qsResourceId);

Remarks

This method restores the file or folder specified by ResourceId from the trash.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendCustomRequest Method (GoogleDrive Class)

Sends a custom request to the Google Drive API.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendCustomRequest(const char* lpszHttpMethod, const char* lpszRequestPath, const char* lpszRequestBody);

Unicode (Windows)
INT SendCustomRequest(LPCWSTR lpszHttpMethod, LPCWSTR lpszRequestPath, LPCWSTR lpszRequestBody);

int cloudstorage_googledrive_sendcustomrequest(void* lpObj, const char* lpszHttpMethod, const char* lpszRequestPath, const char* lpszRequestBody);

int SendCustomRequest(const QString& qsHttpMethod, const QString& qsRequestPath, const QString& qsRequestBody);

Remarks

This method can be used to send arbitrary requests to the Google Drive API.

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST
• PUT
• PATCH
• DELETE

The value passed for RequestPath must already be URL-encoded in a manner acceptable to the Google Drive API. The RequestBody parameter may be empty if not needed.

Usage

When this method is called, the class does the following:

1. Builds a request URL, including query parameters, as follows:
   • The specified RequestPath is appended to the Google Drive API endpoint, https://www.googleapis.com/drive/v3.
   • All query parameters in the QueryParams properties are added to the request URL.
2. Sends the request using the specified HttpMethod, the request URL build in step 1, the header information held by Authorization and OtherHeaders, and the given RequestBody (if non-empty).
3. Stores the response headers in the ParsedHeaders properties, and the response body in the stream specified using SetDownloadStream, the specified LocalFile, or ResourceData (using the same logic as DownloadFile).

If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetDownloadStream Method (GoogleDrive Class)

Sets the stream to which downloaded data will be written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetDownloadStream(CloudStorageStream* sDownloadStream);

Unicode (Windows)
INT SetDownloadStream(CloudStorageStream* sDownloadStream);

int cloudstorage_googledrive_setdownloadstream(void* lpObj, CloudStorageStream* sDownloadStream);

int SetDownloadStream(CloudStorageStream* sDownloadStream);

Remarks

If a download stream is set before data is downloaded, the downloaded data will be written to the stream. The stream should be open and normally set to position 0.

Note: Passing a non-null value for DownloadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetUploadStream Method (GoogleDrive Class)

Sets the stream from which data is read when uploading.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetUploadStream(CloudStorageStream* sUploadStream);

Unicode (Windows)
INT SetUploadStream(CloudStorageStream* sUploadStream);

int cloudstorage_googledrive_setuploadstream(void* lpObj, CloudStorageStream* sUploadStream);

int SetUploadStream(CloudStorageStream* sUploadStream);

Remarks

If an upload stream is set before data is uploaded, the content of the stream will be read by the class and uploaded to the server. The stream should be open and normally set to position 0.

Note: Passing a non-null value for UploadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ToggleSharedDriveHidden Method (GoogleDrive Class)

Hides or unhides a shared drive.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ToggleSharedDriveHidden(const char* lpszSharedDriveId, int bHidden);

Unicode (Windows)
INT ToggleSharedDriveHidden(LPCWSTR lpszSharedDriveId, BOOL bHidden);

int cloudstorage_googledrive_toggleshareddrivehidden(void* lpObj, const char* lpszSharedDriveId, int bHidden);

int ToggleSharedDriveHidden(const QString& qsSharedDriveId, bool bHidden);

Remarks

This method hides or unhides the shared drive specified by SharedDriveId.

If a shared drive is hidden, it will not show up in the Google Drive UI by default (but is still otherwise accessible). Google Drive tracks this setting separately for each user; i.e., each member of a shared drive can choose whether the shared drive should be hidden or not.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

TrashResource Method (GoogleDrive Class)

Moves the specified file or folder to the trash.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int TrashResource(const char* lpszResourceId);

Unicode (Windows)
INT TrashResource(LPCWSTR lpszResourceId);

int cloudstorage_googledrive_trashresource(void* lpObj, const char* lpszResourceId);

int TrashResource(const QString& qsResourceId);

Remarks

This method moves the file or folder specified by ResourceId to the trash. The resource may be restored from the trash by calling RestoreResource.

To permanently delete a resource, call DeleteResource. To empty the trash (thus permanently deleting all trashed items), call EmptyTrash.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdatePermissions Method (GoogleDrive Class)

Create, update, and delete permissions on a file, folder, or shared drive.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdatePermissions(const char* lpszResourceId);

Unicode (Windows)
INT UpdatePermissions(LPCWSTR lpszResourceId);

int cloudstorage_googledrive_updatepermissions(void* lpObj, const char* lpszResourceId);

int UpdatePermissions(const QString& qsResourceId);

Remarks

This method is used to create, update, and delete permissions for the file, folder, or shared drive specified by ResourceId.

Each item in the Permissions properties has a ModOp field which can be set to one of the following values:

When this method is called, the class will iterate through the Permissions properties and execute the requested operation for each permission.

For each permission operation which completes successfully, the class will change its ModOp field back to moNone (0).

Important: The class executes permission operations one-by-one due to how the Google Drive API works. If the class encounters an issue during one of the operations, it will fail with an error, and won't attempt to execute any remaining permission items' operations. The error message will indicate the index of the permission item which caused the error.

Usage

To create new permissions, add new items to the Permissions properties by incrementing the PermissionCount property as necessary.

For each permission being created or updated, set its fields to the desired values. The ModOp field should be set to a value other than moNone (0) for any permission that should be created, updated, or deleted.

Once the permission items have been set up as desired, call this method. // For simplicity's sake, assume that this file currently has no permissions on it. string fileId = "awd0s79uocijl23wf"; // Add permissions for a couple of users to the file. googledrive.Permissions.Add(new GDrivePermission() { Email = "fakeuser1@example.com", Role = GDrivePermissionRoles.prReader, ModOp = GDrivePermissionModOps.moCreate }); googledrive.Permissions.Add(new GDrivePermission() { Email = "fakeuser2@example.com", Role = GDrivePermissionRoles.prWriter, ModOp = GDrivePermissionModOps.moCreate }); googledrive.UpdatePermissions(fileId); // Now we'll update the permissions on the file, removing one of the users and // changing the other's role to "Commenter". Always list the permissions first // to ensure that the latest data is loaded into the class. googledrive.ListPermissions(fileId); googledrive.Permissions[0].ModOp = GDrivePermissionModOps.moDelete; googledrive.Permissions[1].Role = GDrivePermissionRoles.prCommenter; googledrive.Permissions[1].ModOp = GDrivePermissionModOps.moUpdate; // Now commit the changes. googledrive.UpdatePermissions(fileId);

Transferring Ownership

Note that this does not apply to shared drives themselves, or resources in shared drives. It also does not apply when moving resources into or out of shared drives.

Shared Drive Permissions

Since members are determined by the permissions on a shared drive, this method can of course be used to manipulate one or more shared drive members at once. For simpler use cases which only need to modify one member at a time, the AddSharedDriveMember, UpdateSharedDriveMember, and RemoveSharedDriveMember convenience methods can be used.

Note: Only the ptUser (0) and ptGroup (1) permission types are valid for permissions on a shared drive itself.

Just like in a regular user's drive, permissions can also be applied to files within a shared drive to explicitly share them with specific users (whether they're members of the shared drive or not).

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateResource Method (GoogleDrive Class)

Updates a file or folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateResource(const char* lpszResourceId);

Unicode (Windows)
INT UpdateResource(LPCWSTR lpszResourceId);

int cloudstorage_googledrive_updateresource(void* lpObj, const char* lpszResourceId);

int UpdateResource(const QString& qsResourceId);

Remarks

This method updates the metadata for the file or folder resource identified by ResourceId. For file resources, the file data can optionally be updated as well.

Usage

1. If necessary, call GetResourceInfo or ListResources to ensure an item with the resource's latest information is present in the Resources properties.
2. Modify the item's Resource* fields as desired; the following fields are supported:
   • ContentAccessible
   • Description
   • MIMEType (only updated for files, if not empty and new file data is uploaded)
   • ModifiedTime (only updated if not empty)
   • Name
   • Starred
   • Trashed
3. For file resources, you may call SetUploadStream or set LocalFile or ResourceData if you wish to update the file data on the server. (Refer to UploadFile for more information about simple vs. resumable uploads and encrypting the file data before uploading.)
4. Finally, call this method to update the resource.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateSharedDrive Method (GoogleDrive Class)

Updates a shared drive.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateSharedDrive(const char* lpszSharedDriveId, const char* lpszNewName, int iSetRestrictions, int iUnsetRestrictions);

Unicode (Windows)
INT UpdateSharedDrive(LPCWSTR lpszSharedDriveId, LPCWSTR lpszNewName, INT iSetRestrictions, INT iUnsetRestrictions);

int cloudstorage_googledrive_updateshareddrive(void* lpObj, const char* lpszSharedDriveId, const char* lpszNewName, int iSetRestrictions, int iUnsetRestrictions);

int UpdateSharedDrive(const QString& qsSharedDriveId, const QString& qsNewName, int iSetRestrictions, int iUnsetRestrictions);

Remarks

This method updates the name of and/or restrictions applied to the shared drive specified by SharedDriveId.

If the current user is allowed to rename the shared drive (i.e., if the Capabilities field has the 0x08000 flag set), then a new name can be provided using the NewName parameter. If the user is not allowed to rename the shared drive, or wishes to preserve its current name, pass empty string for NewName.

Similarly, if the current user is allowed to alter one or more of the shared drive's Restrictions (i.e., if the Capabilities field has the 0x00002, 0x00004, and/or 0x00010 flags set), then the desired restrictions can be set or unset by including their associated flags, listed below, in the values passed for the SetRestrictions and UnsetRestrictions parameters.

Note that calls to this method will fail if:

• A non-empty string is passed for NewName, but the current user isn't allowed to rename the shared drive.
• The values passed for SetRestrictions and/or UnsetRestrictions contains any flag that corresponds to a restriction the current user isn't allowed to alter.
• Any restriction flag appears in both SetRestrictions and UnsetRestrictions.

Changes requested using this method are "all-or-nothing"; e.g., if both a new name and a new set of restrictions are requested, but the current user isn't allowed to rename the shared drive, the entire request fails.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateSharedDriveMember Method (GoogleDrive Class)

Updates an existing shared drive member's role.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateSharedDriveMember(const char* lpszSharedDriveId, const char* lpszPermissionId, int iRole);

Unicode (Windows)
INT UpdateSharedDriveMember(LPCWSTR lpszSharedDriveId, LPCWSTR lpszPermissionId, INT iRole);

int cloudstorage_googledrive_updateshareddrivemember(void* lpObj, const char* lpszSharedDriveId, const char* lpszPermissionId, int iRole);

int UpdateSharedDriveMember(const QString& qsSharedDriveId, const QString& qsPermissionId, int iRole);

Remarks

This is a convenience method that updates the role of an existing member of a shared drive (specified by SharedDriveId) by modifying their associated permission (specified by PermissionId).

Role specifies the member's role. Valid values are:

Refer to UpdatePermissions for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once. string sharedDriveId = "20983euijdsds"; // First, we'll add a new member to the shared drive. The two integer parameters signify: // * The role type. 2 is the "Writer" role, which provides read and write (but not organize) permissions. // * The permission type. 0 means this is a single user (versus a group). // The Id of the new permission we've created on the shared drive--which is what actually causes the user to // be a member of the shared drive--is returned. string permId = googledrive.AddSharedDriveMember(sharedDriveId, 2, 0, "fakeuser@example.com"); // At some point later, perhaps this user has abused their privileges and we wish to revoke their writer // permissions. We change their role to "Commenter", which provides reader and commenting permissions. googledrive.UpdateSharedDriveMember(sharedDriveId, permId, 1); // 1 is the "Commenter" role. // Or perhaps we wish to simply remove the user's shared drive membership completely. googledrive.RemoveSharedDriveMember(sharedDriveId, permId);

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UploadFile Method (GoogleDrive Class)

Uploads, and optionally converts, a new file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* UploadFile(const char* lpszFileName, const char* lpszMimeType);

Unicode (Windows)
LPWSTR UploadFile(LPCWSTR lpszFileName, LPCWSTR lpszMimeType);

char* cloudstorage_googledrive_uploadfile(void* lpObj, const char* lpszFileName, const char* lpszMimeType);

QString UploadFile(const QString& qsFileName, const QString& qsMimeType);

Remarks

This method uploads a new file and returns the Id of the newly-created file resource.

If SetUploadStream has been used to set an upload stream, it will take priority as the file data source. If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ResourceData will be used.

Usage

If MimeType is "", the file will be uploaded as-is and its MIME type will be automatically determined. The file can be converted to one of the Google formats by explicitly setting MimeType to one of the MIME types in the table below.

Before calling this method, always set ResourceCount to 0 to clear the stored resource data. Then, if you wish to set file metadata and/or assign parent Ids when the file is uploaded, set ResourceCount to 1 and set the desired fields. (Note that the name and MIME type passed to this method will take precedence.)

To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.

Finally, call this method to upload the file, along with any metadata that may be set.

Upload Notes

Google Drive offers two ways to upload a file. For smaller files a simple upload option is provided to upload data in one request. This is the default option. For larger files, uploads can be fragmented into multiple pieces, allowing resuming of uploads that may be interrupted.

Simple

By default the class uses the simple upload mechanism. googledrive.LocalFile = "../MyFile.zip"; googledrive.UploadFile("MyFile.zip", "");

Resumable

To enable resumable uploads set UseResumableUpload to true. This is recommended for large files. The class will automatically fragment the specified file into smaller pieces and upload each individually. FragmentSize may be set to specify the size of the fragment if desired. The default fragment size is 10 MB.

When UseResumableUpload is set to true and UploadFile is called, a resumable upload session is started by the class. ResumeURL is populated with a URL identifying the session (this value may be needed for additional operations if the upload does not complete normally).

During a resumable upload, the FragmentComplete event fires after each fragment is uploaded to indicate overall progress. The class also updates StartByte as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that ResumeURL and StartByte are populated (if the same instance of the class is used, they should already be populated, and no special action should be needed). If uploading from a stream, be sure to reset its position to where it was the first time the upload was started (typically the beginning). Then call UploadFile again to resume the upload at the specified StartByte offset.

Note that if the upload is not resumed after some time the upload session will expire. GetUploadStatus may be used to check the status of a resumable upload. googledrive.LocalFile = "../MyFile.zip"; googledrive.UploadFile("MyFile.zip", ""); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte and ResumeURL are already populated from the previous //upload attempt. googledrive.UploadFile("MyFile.zip", ""); MemoryStream uploadStream = new MemoryStream(File.ReadAllBytes("../MyFile.zip")); googledrive.SetUploadStream(uploadStream); googledrive.UploadFile("MyFile.zip", ""); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte and ResumeURL are already populated from the previous //upload attempt. //You MUST reset the stream's position to where it was when you first started the upload! uploadStream.Position = 0; googledrive.UploadFile("MyFile.zip", "");

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ChangeList Event (GoogleDrive Class)

Fires once for each change when ListChanges is called.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireChangeList(GoogleDriveChangeListEventParams *e);

typedef struct {
  const char *ResourceId;
  const char *SharedDriveId;
  int Removed;
  const char *Time;
  int ChangeType;
  int reserved;
} GoogleDriveChangeListEventParams;


Unicode (Windows)
virtual INT FireChangeList(GoogleDriveChangeListEventParams *e);

typedef struct {
  LPCWSTR ResourceId;
  LPCWSTR SharedDriveId;
  BOOL Removed;
  LPCWSTR Time;
  INT ChangeType;
  INT reserved;
} GoogleDriveChangeListEventParams;

#define EID_GOOGLEDRIVE_CHANGELIST 1

virtual INT CLOUDSTORAGE_CALL FireChangeList(LPSTR &lpszResourceId, LPSTR &lpszSharedDriveId, BOOL &bRemoved, LPSTR &lpszTime, INT &iChangeType);

class GoogleDriveChangeListEventParams {
public:
  const QString &ResourceId();

  const QString &SharedDriveId();

  bool Removed();

  const QString &Time();

  int ChangeType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ChangeList(GoogleDriveChangeListEventParams *e);

// Or, subclass GoogleDrive and override this emitter function.
virtual int FireChangeList(GoogleDriveChangeListEventParams *e) {...}

Remarks

This event fires once for each change returned when ListChanges is called.

ResourceId is the Id of the file or folder to which the change applies.

SharedDriveId is the Id of the shared drive associated with the change.

Removed indicates whether the file or shared drive has been removed from the view of the change list. For example, if a file was permanently deleted or access to it was revoked, this would return true (it would still return false if the file was simply in the trash).

Time is a DateTime string representing the time of the change. This is a combined date-time value (formatted according to RFC 3339).

ChangeType indicates whether this is a file (0) or a shared drive (1) change.

Refer to ListChanges for more information.

EndTransfer Event (GoogleDrive Class)

This event fires when a document finishes transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(GoogleDriveEndTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} GoogleDriveEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(GoogleDriveEndTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} GoogleDriveEndTransferEventParams;

#define EID_GOOGLEDRIVE_ENDTRANSFER 2

virtual INT CLOUDSTORAGE_CALL FireEndTransfer(INT &iDirection);

class GoogleDriveEndTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(GoogleDriveEndTransferEventParams *e);

// Or, subclass GoogleDrive and override this emitter function.
virtual int FireEndTransfer(GoogleDriveEndTransferEventParams *e) {...}

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (GoogleDrive Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(GoogleDriveErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} GoogleDriveErrorEventParams;


Unicode (Windows)
virtual INT FireError(GoogleDriveErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} GoogleDriveErrorEventParams;

#define EID_GOOGLEDRIVE_ERROR 3

virtual INT CLOUDSTORAGE_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class GoogleDriveErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(GoogleDriveErrorEventParams *e);

// Or, subclass GoogleDrive and override this emitter function.
virtual int FireError(GoogleDriveErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

FragmentComplete Event (GoogleDrive Class)

Fires after each fragment of a resumable upload is completed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireFragmentComplete(GoogleDriveFragmentCompleteEventParams *e);

typedef struct {
  int FragmentNumber;
  int FragmentCount;
  int Interrupt;
  int reserved;
} GoogleDriveFragmentCompleteEventParams;


Unicode (Windows)
virtual INT FireFragmentComplete(GoogleDriveFragmentCompleteEventParams *e);

typedef struct {
  INT FragmentNumber;
  INT FragmentCount;
  BOOL Interrupt;
  INT reserved;
} GoogleDriveFragmentCompleteEventParams;

#define EID_GOOGLEDRIVE_FRAGMENTCOMPLETE 4

virtual INT CLOUDSTORAGE_CALL FireFragmentComplete(INT &iFragmentNumber, INT &iFragmentCount, BOOL &bInterrupt);

class GoogleDriveFragmentCompleteEventParams {
public:
  int FragmentNumber();

  int FragmentCount();

  bool Interrupt();
  void SetInterrupt(bool bInterrupt);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void FragmentComplete(GoogleDriveFragmentCompleteEventParams *e);

// Or, subclass GoogleDrive and override this emitter function.
virtual int FireFragmentComplete(GoogleDriveFragmentCompleteEventParams *e) {...}

Remarks

When UseResumableUpload is true and UploadFile is called, this event will fire after each fragment is uploaded, providing an indication of overall upload progress.

FragmentNumber is the number of the current fragment that has completed. This value starts at 1.

FragmentCount is the total number of fragments that will be uploaded.

Interrupt can be set to true to interrupt the upload. The upload may be resumed later.

Header Event (GoogleDrive Class)

Fired every time a header line comes in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHeader(GoogleDriveHeaderEventParams *e);

typedef struct {
  const char *Field;
  const char *Value;
  int reserved;
} GoogleDriveHeaderEventParams;


Unicode (Windows)
virtual INT FireHeader(GoogleDriveHeaderEventParams *e);

typedef struct {
  LPCWSTR Field;
  LPCWSTR Value;
  INT reserved;
} GoogleDriveHeaderEventParams;

#define EID_GOOGLEDRIVE_HEADER 5

virtual INT CLOUDSTORAGE_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);

class GoogleDriveHeaderEventParams {
public:
  const QString &Field();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Header(GoogleDriveHeaderEventParams *e);

// Or, subclass GoogleDrive and override this emitter function.
virtual int FireHeader(GoogleDriveHeaderEventParams *e) {...}

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (GoogleDrive Class)

Fired once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(GoogleDriveLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} GoogleDriveLogEventParams;


Unicode (Windows)
virtual INT FireLog(GoogleDriveLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} GoogleDriveLogEventParams;

#define EID_GOOGLEDRIVE_LOG 6

virtual INT CLOUDSTORAGE_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class GoogleDriveLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(GoogleDriveLogEventParams *e);

// Or, subclass GoogleDrive and override this emitter function.
virtual int FireLog(GoogleDriveLogEventParams *e) {...}

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

PermissionList Event (GoogleDrive Class)

This event fires once for each permission returned when listing permissions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePermissionList(GoogleDrivePermissionListEventParams *e);

typedef struct {
  const char *Id;
  int Role;
  int PermissionType;
  const char *Email;
  const char *Domain;
  int AllowFileDiscovery;
  int reserved;
} GoogleDrivePermissionListEventParams;


Unicode (Windows)
virtual INT FirePermissionList(GoogleDrivePermissionListEventParams *e);

typedef struct {
  LPCWSTR Id;
  INT Role;
  INT PermissionType;
  LPCWSTR Email;
  LPCWSTR Domain;
  BOOL AllowFileDiscovery;
  INT reserved;
} GoogleDrivePermissionListEventParams;

#define EID_GOOGLEDRIVE_PERMISSIONLIST 7

virtual INT CLOUDSTORAGE_CALL FirePermissionList(LPSTR &lpszId, INT &iRole, INT &iPermissionType, LPSTR &lpszEmail, LPSTR &lpszDomain, BOOL &bAllowFileDiscovery);

class GoogleDrivePermissionListEventParams {
public:
  const QString &Id();

  int Role();

  int PermissionType();

  const QString &Email();

  const QString &Domain();

  bool AllowFileDiscovery();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PermissionList(GoogleDrivePermissionListEventParams *e);

// Or, subclass GoogleDrive and override this emitter function.
virtual int FirePermissionList(GoogleDrivePermissionListEventParams *e) {...}

Remarks

When calling ListPermissions this event will fire once for each permission that is returned.

Id is the Id of the permission.

Role is the role of the permission. Possible values are:

PermissionType indicates the type of the permission. Possible values are: