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.

Class Name

CloudStorage_GoogleDrive

Procedural Interface

 cloudstorage_googledrive_open();
 cloudstorage_googledrive_close($res);
 cloudstorage_googledrive_register_callback($res, $id, $function);
 cloudstorage_googledrive_get_last_error($res);
 cloudstorage_googledrive_get_last_error_code($res);
 cloudstorage_googledrive_set($res, $id, $index, $value);
 cloudstorage_googledrive_get($res, $id, $index);
 cloudstorage_googledrive_do_addparents($res, $resourceid, $parentids);
 cloudstorage_googledrive_do_addqueryparam($res, $name, $value);
 cloudstorage_googledrive_do_addshareddrivemember($res, $shareddriveid, $role, $permissiontype, $email);
 cloudstorage_googledrive_do_authorize($res);
 cloudstorage_googledrive_do_calcauthorization($res);
 cloudstorage_googledrive_do_config($res, $configurationstring);
 cloudstorage_googledrive_do_copyresource($res, $resourceid, $newname, $parentids);
 cloudstorage_googledrive_do_createfolder($res, $name, $parentids);
 cloudstorage_googledrive_do_createshareddrive($res, $name, $requestid);
 cloudstorage_googledrive_do_deleteresource($res, $resourceid);
 cloudstorage_googledrive_do_deleteshareddrive($res, $shareddriveid);
 cloudstorage_googledrive_do_downloadfile($res, $resourceid, $mimetype);
 cloudstorage_googledrive_do_emptytrash($res);
 cloudstorage_googledrive_do_getaccountinfo($res);
 cloudstorage_googledrive_do_getcurrentchangemarker($res);
 cloudstorage_googledrive_do_getpermissioninfo($res, $resourceid, $permissionid);
 cloudstorage_googledrive_do_getresourceinfo($res, $resourceids);
 cloudstorage_googledrive_do_getshareddriveinfo($res, $shareddriveid);
 cloudstorage_googledrive_do_getuploadstatus($res);
 cloudstorage_googledrive_do_interrupt($res);
 cloudstorage_googledrive_do_listchanges($res);
 cloudstorage_googledrive_do_listchildren($res, $folderids);
 cloudstorage_googledrive_do_listparents($res, $resourceid);
 cloudstorage_googledrive_do_listpermissions($res, $resourceid);
 cloudstorage_googledrive_do_listresources($res);
 cloudstorage_googledrive_do_listrevisions($res, $fileid);
 cloudstorage_googledrive_do_listshareddrives($res);
 cloudstorage_googledrive_do_moveresource($res, $resourceid, $newparentids);
 cloudstorage_googledrive_do_removeparents($res, $resourceid, $parentids);
 cloudstorage_googledrive_do_removeshareddrivemember($res, $shareddriveid, $permissionid);
 cloudstorage_googledrive_do_reset($res);
 cloudstorage_googledrive_do_restoreresource($res, $resourceid);
 cloudstorage_googledrive_do_sendcustomrequest($res, $httpmethod, $requestpath, $requestbody);
 cloudstorage_googledrive_do_toggleshareddrivehidden($res, $shareddriveid, $hidden);
 cloudstorage_googledrive_do_trashresource($res, $resourceid);
 cloudstorage_googledrive_do_updatepermissions($res, $resourceid);
 cloudstorage_googledrive_do_updateresource($res, $resourceid);
 cloudstorage_googledrive_do_updateshareddrive($res, $shareddriveid, $newname, $setrestrictions, $unsetrestrictions);
 cloudstorage_googledrive_do_updateshareddrivemember($res, $shareddriveid, $permissionid, $role);
 cloudstorage_googledrive_do_uploadfile($res, $filename, $mimetype);

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 OAuthClientProfile and OAuthGrantType.

The class has the following defaults:

Below is a brief description of the different OAuthClientProfile and OAuthGrantType 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 OAuthAccessToken property will be populated. Additionally, if a refresh token was provided the OAuthRefreshToken property 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 OAuthAccessToken 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 OAuthAccessToken. 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 OAuthGrantType property. 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 OAuthGrantType property 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 OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, and OAuthServerTokenURL 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 OAuthAuthorizationCode property, 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 OAuthRefreshToken property 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 OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL 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

This profile is similar to setting the class to the Application profile and Authorization Code grant type except the class will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, OAuthServerTokenURL, and the OAuthReturnURL properties to be set. Before calling the Authorize method, the OAuthWebAuthURL property should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The redirect_uri parameter of this URL is mapped to the OAuthReturnURL property. The OAuthReturnURL property should be set to some web server that will parse the authorization code out of the query parameter from the redirect. Once the authorization code is parsed, it should be passed back to the server where it is then set to the OAuthAuthorizationCode property. Once that is set, the Authorize method can be called to exchange the authorization code for an access token and refresh token if provided. The class will then cache these values like normal and use them to make requests. If the OAuthRefreshToken field is set, or a refresh token is cached, then the Authorize method can immediately be called to make a request to the token server to get a new access token.

External OAuth Support

For complex profiles or grant types, or for more control of the flow, it is possible to perform OAuth authentication using the OAuth class or a separate process. Once complete you should have an authorization string which looks like:

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

Downloading an Encrypted File

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). 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", "");

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.

AccountCanCreateSharedDrives Property (CloudStorage_GoogleDrive Class)

Whether the account has permission to create shared drives.

Object Oriented Interface

public function getAccountCanCreateSharedDrives();

Procedural Interface

cloudstorage_googledrive_get($res, 1 );

Default Value

false

Remarks

Whether the account has permission to create shared drives.

This property reflects whether the account has the permissions necessary to create shared drives.

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

Data Type

Boolean

AccountDriveUsage Property (CloudStorage_GoogleDrive Class)

Amount of storage used in Google Drive.

Object Oriented Interface

public function getAccountDriveUsage();

Procedural Interface

cloudstorage_googledrive_get($res, 2 );

Default Value

-1

Remarks

Amount of storage used in Google Drive.

This property reflects the storage usage, in bytes, for all items in the account's Google Drive (including trashed items).

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

Data Type

Long64

AccountEmail Property (CloudStorage_GoogleDrive Class)

The email address of the account.

Object Oriented Interface

public function getAccountEmail();

Procedural Interface

cloudstorage_googledrive_get($res, 3 );

Default Value

''

Remarks

The email address of the account.

This property reflects the email address associated with the account.

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

Data Type

String

AccountName Property (CloudStorage_GoogleDrive Class)

The name of the account's user.

Object Oriented Interface

public function getAccountName();

Procedural Interface

cloudstorage_googledrive_get($res, 4 );

Default Value

''

Remarks

The name of the account's user.

This property reflects the name of the account's user.

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

Data Type

String

AccountPermissionId Property (CloudStorage_GoogleDrive Class)

The permission Id associated with the account.

Object Oriented Interface

public function getAccountPermissionId();

Procedural Interface

cloudstorage_googledrive_get($res, 5 );

Default Value

''

Remarks

The permission Id associated with the account.

This property reflects the permission Id associated with the account. Any permissions (including shared drive memberships) created for this account will include this Id.

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

Data Type

String

AccountStorageQuota Property (CloudStorage_GoogleDrive Class)

The account's storage quota.

Object Oriented Interface

public function getAccountStorageQuota();

Procedural Interface

cloudstorage_googledrive_get($res, 6 );

Default Value

-1

Remarks

The account's storage quota.

This property reflects the account's storage quota, in bytes, across all Google services (Google Drive, Gmail, etc.).

A value of -1 indicates that the account does not have a storage quota (i.e., it has unlimited storage).

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

Data Type

Long64

AccountStorageUsage Property (CloudStorage_GoogleDrive Class)

Amount of storage used across all Google services.

Object Oriented Interface

public function getAccountStorageUsage();

Procedural Interface

cloudstorage_googledrive_get($res, 7 );

Default Value

-1

Remarks

Amount of storage used across all Google services.

This property reflects the account's total storage usage, in bytes, across all Google services (Google Drive, Gmail, etc.).

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

Data Type

Long64

AccountTrashUsage Property (CloudStorage_GoogleDrive Class)

Amount of storage used by trashed items in Google Drive.

Object Oriented Interface

public function getAccountTrashUsage();

Procedural Interface

cloudstorage_googledrive_get($res, 8 );

Default Value

-1

Remarks

Amount of storage used by trashed items in Google Drive.

This property reflects the storage usage, in bytes, for all trashed items in the account's Google Drive.

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

Data Type

Long64

Authorization Property (CloudStorage_GoogleDrive Class)

OAuth 2.0 Authorization Token.

Object Oriented Interface

public function getAuthorization();
public function setAuthorization($value);

Procedural Interface

cloudstorage_googledrive_get($res, 9 );
cloudstorage_googledrive_set($res, 9, $value );

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

Assign this value to the Authorization property before attempting any operations. Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Data Type

String

ChangeMarker Property (CloudStorage_GoogleDrive Class)

A marker indicating what page of changes to return next.

Object Oriented Interface

public function getChangeMarker();
public function setChangeMarker($value);

Procedural Interface

cloudstorage_googledrive_get($res, 10 );
cloudstorage_googledrive_set($res, 10, $value );

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

ChangeCount Property (CloudStorage_GoogleDrive Class)

The number of records in the Change arrays.

Object Oriented Interface

public function getChangeCount();

Procedural Interface

cloudstorage_googledrive_get($res, 11 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ChangeRemoved
• ChangeResourceId
• ChangeSharedDriveId
• ChangeTime
• ChangeType

The array indices start at 0 and end at ChangeCount - 1.

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

Data Type

Integer

ChangeRemoved Property (CloudStorage_GoogleDrive Class)

Whether the file or shared drive has been removed.

Object Oriented Interface

public function getChangeRemoved($changeindex);

Procedural Interface

cloudstorage_googledrive_get($res, 12 , $changeindex);

Default Value

false

Remarks

Whether the file or shared drive has been removed.

This property indicates whether the file or shared drive to which the change applies has been removed.

The $changeindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChangeCount property.

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

Data Type

Boolean

ChangeResourceId Property (CloudStorage_GoogleDrive Class)

The Id of the file to which the change applies.

Object Oriented Interface

public function getChangeResourceId($changeindex);

Procedural Interface

cloudstorage_googledrive_get($res, 13 , $changeindex);

Default Value

''

Remarks

The Id of the file to which the change applies.

This property holds the Id of the file to which the change applies.

The $changeindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChangeCount property.

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

Data Type

String

ChangeSharedDriveId Property (CloudStorage_GoogleDrive Class)

The Id of the shared drive.

Object Oriented Interface

public function getChangeSharedDriveId($changeindex);

Procedural Interface

cloudstorage_googledrive_get($res, 14 , $changeindex);

Default Value

''

Remarks

The Id of the shared drive.

This property holds the Id of the shared drive to which the change applies (if ChangeType is ctSharedDrive (1)), or which owns the file to which the change applies (if ChangeType is ctFile (0)).

The $changeindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChangeCount property.

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

Data Type

String

ChangeTime Property (CloudStorage_GoogleDrive Class)

The time of the change.

Object Oriented Interface

public function getChangeTime($changeindex);

Procedural Interface

cloudstorage_googledrive_get($res, 15 , $changeindex);

Default Value

''

Remarks

The time of the change.

This property holds the time of the change. This is a combined date-time value (formatted according to RFC 3339).

The $changeindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChangeCount property.

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

Data Type

String

ChangeType Property (CloudStorage_GoogleDrive Class)

Whether the change is for a file or a shared drive.

Object Oriented Interface

public function getChangeType($changeindex);

Procedural Interface

cloudstorage_googledrive_get($res, 16 , $changeindex);

Default Value

0

Remarks

Whether the change is for a file or a shared drive.

This property indicates whether the change applies to a file or a shared drive. Possible values are:

• ctFile (0)
• ctSharedDrive (1)

The $changeindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChangeCount property.

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

Data Type

Integer

ChildMarker Property (CloudStorage_GoogleDrive Class)

A marker when child resources are paged.

Object Oriented Interface

public function getChildMarker();
public function setChildMarker($value);

Procedural Interface

cloudstorage_googledrive_get($res, 17 );
cloudstorage_googledrive_set($res, 17, $value );

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

ChildCount Property (CloudStorage_GoogleDrive Class)

The number of records in the Child arrays.

Object Oriented Interface

public function getChildCount();

Procedural Interface

cloudstorage_googledrive_get($res, 18 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ChildContentAccessible
• ChildCreatedTime
• ChildDescription
• ChildExtension
• ChildId
• ChildMD5Checksum
• ChildMIMEType
• ChildModifiedTime
• ChildName
• ChildOriginalName
• ChildOwner
• ChildOwnerEmail
• ChildParentIds
• ChildSharedDriveId
• ChildSize
• ChildStarred
• ChildTrashed
• ChildType
• ChildViewed
• ChildViewLink

The array indices start at 0 and end at ChildCount - 1.

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

Data Type

Integer

ChildContentAccessible Property (CloudStorage_GoogleDrive Class)

Whether the resource's content is accessible to less-privileged users.

Object Oriented Interface

public function getChildContentAccessible($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 19 , $childindex);

Default Value

false

Remarks

Whether the resource's content is accessible to less-privileged users.

This property indicates whether the resource's content is accessible. If the resource is not accessible, it cannot be copied, downloaded, or printed by a users unless they have at least "writer" permissions.

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

Boolean

ChildCreatedTime Property (CloudStorage_GoogleDrive Class)

The creation date of the resource.

Object Oriented Interface

public function getChildCreatedTime($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 20 , $childindex);

Default Value

''

Remarks

The creation date of the resource.

This property holds a DateTime string representing the creation date of the resource. This is a combined date-time value (formatted according to RFC 3339).

Note that while this property is writable, the class only uses it as input when UploadFile is called; it is ignored when calling UpdateResource.

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildDescription Property (CloudStorage_GoogleDrive Class)

A short description of the resource.

Object Oriented Interface

public function getChildDescription($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 21 , $childindex);

Default Value

''

Remarks

A short description of the resource.

This property specifies a short description of the resource.

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildExtension Property (CloudStorage_GoogleDrive Class)

The file extension of the resource.

Object Oriented Interface

public function getChildExtension($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 22 , $childindex);

Default Value

''

Remarks

The file extension of the resource.

This property indicates the file extension of the resource. It cannot be set, and is empty for folder resources. To specify the extension when creating a new file resource include it when calling UploadFile.

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildId Property (CloudStorage_GoogleDrive Class)

The Id of the resource.

Object Oriented Interface

public function getChildId($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 23 , $childindex);

Default Value

''

Remarks

The Id of the resource.

This property holds the Id of the resource.

This property must be set before calling UpdateResource.

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildMD5Checksum Property (CloudStorage_GoogleDrive Class)

The MD5 checksum of the file resource.

Object Oriented Interface

public function getChildMD5Checksum($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 24 , $childindex);

Default Value

''

Remarks

The MD5 checksum of the file resource.

This property holds the MD5 checksum of the resource, if it is a file resource.

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildMIMEType Property (CloudStorage_GoogleDrive Class)

The MIME type of the resource.

Object Oriented Interface

public function getChildMIMEType($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 25 , $childindex);

Default Value

''

Remarks

The MIME type of the resource.

This property specifies the MIME type of the resource.

When calling UploadFile, this property is ignored in favor of the MimeType parameter of UploadFile.

When calling UpdateResource, this property is only submitted if new file data is being uploaded.

Some Google Drive MIME types:

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildModifiedTime Property (CloudStorage_GoogleDrive Class)

The last modified date of the resource.

Object Oriented Interface

public function getChildModifiedTime($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 26 , $childindex);

Default Value

''

Remarks

The last modified date of the resource.

This property holds a DateTime string representing the last modified date of the resource. This is a combined date-time value (formatted according to RFC 3339).

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildName Property (CloudStorage_GoogleDrive Class)

The name of the resource.

Object Oriented Interface

public function getChildName($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 27 , $childindex);

Default Value

''

Remarks

The name of the resource.

This property specifies the name of the resource.

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildOriginalName Property (CloudStorage_GoogleDrive Class)

The original name of the file resource.

Object Oriented Interface

public function getChildOriginalName($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 28 , $childindex);

Default Value

''

Remarks

The original name of the file resource.

This property specifies the original name of a file resource if the file was uploaded manually, or if the name was set programmatically through the API.

Updating ChildName will not change this value.

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildOwner Property (CloudStorage_GoogleDrive Class)

The name of the resource's owner.

Object Oriented Interface

public function getChildOwner($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 29 , $childindex);

Default Value

''

Remarks

The name of the resource's owner.

This property holds the name of resource's owner.

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildOwnerEmail Property (CloudStorage_GoogleDrive Class)

The email address of the resource's owner.

Object Oriented Interface

public function getChildOwnerEmail($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 30 , $childindex);

Default Value

''

Remarks

The email address of the resource's owner.

This property holds the email address of the resource's owner.

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildParentIds Property (CloudStorage_GoogleDrive Class)

The Ids of the resource's parent folders.

Object Oriented Interface

public function getChildParentIds($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 31 , $childindex);

Default Value

''

Remarks

The Ids of the resource's parent folders.

This property holds a comma-separated list of Ids for the resource's parent folders.

Note that while this property is writable, the class only uses it as input when UploadFile is called. To modify a resource's parents in any other case, use the AddParents, RemoveParents, and MoveResource methods.

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildSharedDriveId Property (CloudStorage_GoogleDrive Class)

The Id of the shared drive the resource is in.

Object Oriented Interface

public function getChildSharedDriveId($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 32 , $childindex);

Default Value

''

Remarks

The Id of the shared drive the resource is in.

This property holds the Id of the shared drive that the resource is in, if applicable.

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildSize Property (CloudStorage_GoogleDrive Class)

The size of the file resource in bytes.

Object Oriented Interface

public function getChildSize($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 33 , $childindex);

Default Value

0

Remarks

The size of the file resource in bytes.

This property holds the size of a file resource in bytes. This is only applicable to files.

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

Long64

ChildStarred Property (CloudStorage_GoogleDrive Class)

Whether the resource is starred.

Object Oriented Interface

public function getChildStarred($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 34 , $childindex);

Default Value

false

Remarks

Whether the resource is starred.

This property indicates whether the resource is starred by the current user.

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

Boolean

ChildTrashed Property (CloudStorage_GoogleDrive Class)

Whether the resource is in the trash.

Object Oriented Interface

public function getChildTrashed($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 35 , $childindex);

Default Value

false

Remarks

Whether the resource is in the trash.

This property indicates whether the resource has been moved to trash.

Note that while this property is writable, the class only uses it as input when UpdateResource is called; it is ignored when calling UploadFile.

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

Boolean

ChildType Property (CloudStorage_GoogleDrive Class)

The resource's type.

Object Oriented Interface

public function getChildType($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 36 , $childindex);

Default Value

0

Remarks

The resource's type.

This property indicates whether the resource is a folder or a file. Possible values are:

Google treats files and folders in the same way, and folders are included when listing resources. The ResourceType property 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.

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

Integer

ChildViewed Property (CloudStorage_GoogleDrive Class)

Whether the resource has been viewed.

Object Oriented Interface

public function getChildViewed($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 37 , $childindex);

Default Value

false

Remarks

Whether the resource has been viewed.

This property indicates whether the resource has been viewed by the current user.

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

Boolean

ChildViewLink Property (CloudStorage_GoogleDrive Class)

A link for opening the resource in a relevant Google editor or viewer in a browser.

Object Oriented Interface

public function getChildViewLink($childindex);

Procedural Interface

cloudstorage_googledrive_get($res, 38 , $childindex);

Default Value

''

Remarks

A link for opening the resource in a relevant Google editor or viewer in a browser.

This property holds the link to the resource. The link may be used to view the resource in a browser or relevant editor.

The $childindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

EncryptionAlgorithm Property (CloudStorage_GoogleDrive Class)

The encryption algorithm.

Object Oriented Interface

public function getEncryptionAlgorithm();
public function setEncryptionAlgorithm($value);

Procedural Interface

cloudstorage_googledrive_get($res, 39 );
cloudstorage_googledrive_set($res, 39, $value );

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 (CloudStorage_GoogleDrive Class)

The encryption password.

Object Oriented Interface

public function getEncryptionPassword();
public function setEncryptionPassword($value);

Procedural Interface

cloudstorage_googledrive_get($res, 40 );
cloudstorage_googledrive_set($res, 40, $value );

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

FirewallAutoDetect Property (CloudStorage_GoogleDrive Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

cloudstorage_googledrive_get($res, 41 );
cloudstorage_googledrive_set($res, 41, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (CloudStorage_GoogleDrive Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

cloudstorage_googledrive_get($res, 42 );
cloudstorage_googledrive_set($res, 42, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (CloudStorage_GoogleDrive Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

cloudstorage_googledrive_get($res, 43 );
cloudstorage_googledrive_set($res, 43, $value );

Default Value

''

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (CloudStorage_GoogleDrive Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

cloudstorage_googledrive_get($res, 44 );
cloudstorage_googledrive_set($res, 44, $value );

Default Value

''

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (CloudStorage_GoogleDrive Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

cloudstorage_googledrive_get($res, 45 );
cloudstorage_googledrive_set($res, 45, $value );

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (CloudStorage_GoogleDrive Class)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

cloudstorage_googledrive_get($res, 46 );
cloudstorage_googledrive_set($res, 46, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (CloudStorage_GoogleDrive Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

cloudstorage_googledrive_get($res, 47 );

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 (CloudStorage_GoogleDrive Class)

Controls the scope of the results when listing resources.

Object Oriented Interface

public function getListResourcesScope();
public function setListResourcesScope($value);

Procedural Interface

cloudstorage_googledrive_get($res, 48 );
cloudstorage_googledrive_set($res, 48, $value );

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 (CloudStorage_GoogleDrive Class)

The location of the local file.

Object Oriented Interface

public function getLocalFile();
public function setLocalFile($value);

Procedural Interface

cloudstorage_googledrive_get($res, 49 );
cloudstorage_googledrive_set($res, 49, $value );

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.

Data Type

String

LocalHost Property (CloudStorage_GoogleDrive Class)

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

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

cloudstorage_googledrive_get($res, 50 );
cloudstorage_googledrive_set($res, 50, $value );

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 (CloudStorage_GoogleDrive Class)

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

Object Oriented Interface

public function getNextChangeMarker();
public function setNextChangeMarker($value);

Procedural Interface

cloudstorage_googledrive_get($res, 51 );
cloudstorage_googledrive_set($res, 51, $value );

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

OAuthAccessToken Property (CloudStorage_GoogleDrive Class)

The access token returned by the authorization server.

Object Oriented Interface

public function getOAuthAccessToken();
public function setOAuthAccessToken($value);

Procedural Interface

cloudstorage_googledrive_get($res, 52 );
cloudstorage_googledrive_set($res, 52, $value );

Default Value

''

Remarks

The access token returned by the authorization server. This is set when the class makes a request to the token server.

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (CloudStorage_GoogleDrive Class)

The authorization code that is exchanged for an access token.

Object Oriented Interface

public function getOAuthAuthorizationCode();
public function setOAuthAuthorizationCode($value);

Procedural Interface

cloudstorage_googledrive_get($res, 53 );
cloudstorage_googledrive_set($res, 53, $value );

Default Value

''

Remarks

The authorization code that is exchanged for an access token. This is required to be set when the OAuthClientProfile property is set to the Web profile. Otherwise, this field is for information purposes only.

This property is not available at design time.

Data Type

String

OAuthAuthorizationScope Property (CloudStorage_GoogleDrive Class)

The scope request or response parameter used during authorization.

Object Oriented Interface

public function getOAuthAuthorizationScope();
public function setOAuthAuthorizationScope($value);

Procedural Interface

cloudstorage_googledrive_get($res, 54 );
cloudstorage_googledrive_set($res, 54, $value );

Default Value

''

Remarks

The scope request or response parameter used during authorization.

This property is not available at design time.

Data Type

String

OAuthClientId Property (CloudStorage_GoogleDrive Class)

The id of the client assigned when registering the application.

Object Oriented Interface

public function getOAuthClientId();
public function setOAuthClientId($value);

Procedural Interface

cloudstorage_googledrive_get($res, 55 );
cloudstorage_googledrive_set($res, 55, $value );

Default Value

''

Remarks

The id of the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthClientProfile Property (CloudStorage_GoogleDrive Class)

The type of client that is requesting authorization.

Object Oriented Interface

public function getOAuthClientProfile();
public function setOAuthClientProfile($value);

Procedural Interface

cloudstorage_googledrive_get($res, 56 );
cloudstorage_googledrive_set($res, 56, $value );

Default Value

0

Remarks

The type of client that is requesting authorization. See the introduction section for more information. Possible values are:

This property is not available at design time.

Data Type

Integer

OAuthClientSecret Property (CloudStorage_GoogleDrive Class)

The secret value for the client assigned when registering the application.

Object Oriented Interface

public function getOAuthClientSecret();
public function setOAuthClientSecret($value);

Procedural Interface

cloudstorage_googledrive_get($res, 57 );
cloudstorage_googledrive_set($res, 57, $value );

Default Value

''

Remarks

The secret value for the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthGrantType Property (CloudStorage_GoogleDrive Class)

The OAuth grant type used to acquire an OAuth access token.

Object Oriented Interface

public function getOAuthGrantType();
public function setOAuthGrantType($value);

Procedural Interface

cloudstorage_googledrive_get($res, 58 );
cloudstorage_googledrive_set($res, 58, $value );

Default Value

0

Remarks

The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:

This property is not available at design time.

Data Type

Integer

OAuthRefreshToken Property (CloudStorage_GoogleDrive Class)

Specifies the refresh token received from or sent to the authorization server.

Object Oriented Interface

public function getOAuthRefreshToken();
public function setOAuthRefreshToken($value);

Procedural Interface

cloudstorage_googledrive_get($res, 59 );
cloudstorage_googledrive_set($res, 59, $value );

Default Value

''

Remarks

Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens.

This property is not available at design time.

Data Type

String

OAuthRequestRefreshToken Property (CloudStorage_GoogleDrive Class)

Specifies whether the class will request a refresh token during authorization.

Object Oriented Interface

public function getOAuthRequestRefreshToken();
public function setOAuthRequestRefreshToken($value);

Procedural Interface

cloudstorage_googledrive_get($res, 60 );
cloudstorage_googledrive_set($res, 60, $value );

Default Value

true

Remarks

Specifies whether the class will request a refresh token during authorization. By default, this value is True.

When True, the class will automatically add the necessary scopes or parameters to obtain a refresh token. When False, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.

Note: This property is only applicable when the OAuthGrantType property is set to cogtAuthorizationCode.

This property is not available at design time.

Data Type

Boolean

OAuthReturnURL Property (CloudStorage_GoogleDrive Class)

The URL where the user (browser) returns after authenticating.

Object Oriented Interface

public function getOAuthReturnURL();
public function setOAuthReturnURL($value);

Procedural Interface

cloudstorage_googledrive_get($res, 61 );
cloudstorage_googledrive_set($res, 61, $value );

Default Value

''

Remarks

The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.

This property is not available at design time.

Data Type

String

OAuthServerAuthURL Property (CloudStorage_GoogleDrive Class)

The URL of the authorization server.

Object Oriented Interface

public function getOAuthServerAuthURL();
public function setOAuthServerAuthURL($value);

Procedural Interface

cloudstorage_googledrive_get($res, 62 );
cloudstorage_googledrive_set($res, 62, $value );

Default Value

''

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (CloudStorage_GoogleDrive Class)

The URL of the token server used to obtain the access token.

Object Oriented Interface

public function getOAuthServerTokenURL();
public function setOAuthServerTokenURL($value);

Procedural Interface

cloudstorage_googledrive_get($res, 63 );
cloudstorage_googledrive_set($res, 63, $value );

Default Value

''

Remarks

The URL of the token server used to obtain the access token.

This property is not available at design time.

Data Type

String

OAuthWebAuthURL Property (CloudStorage_GoogleDrive Class)

The URL to which the user should be re-directed for authorization.

Object Oriented Interface

public function getOAuthWebAuthURL();

Procedural Interface

cloudstorage_googledrive_get($res, 64 );

Default Value

''

Remarks

The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.

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

Data Type

String

OtherHeaders Property (CloudStorage_GoogleDrive Class)

Other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();
public function setOtherHeaders($value);

Procedural Interface

cloudstorage_googledrive_get($res, 65 );
cloudstorage_googledrive_set($res, 65, $value );

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 (CloudStorage_GoogleDrive Class)

Determines if local files are overwritten.

Object Oriented Interface

public function getOverwrite();
public function setOverwrite($value);

Procedural Interface

cloudstorage_googledrive_get($res, 66 );
cloudstorage_googledrive_set($res, 66, $value );

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

ParsedHeaderCount Property (CloudStorage_GoogleDrive Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

cloudstorage_googledrive_get($res, 67 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

The array indices start at 0 and end at ParsedHeaderCount - 1.

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

Data Type

Integer

ParsedHeaderField Property (CloudStorage_GoogleDrive Class)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Object Oriented Interface

public function getParsedHeaderField($parsedheaderindex);

Procedural Interface

cloudstorage_googledrive_get($res, 68 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

ParsedHeaderValue Property (CloudStorage_GoogleDrive Class)

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

cloudstorage_googledrive_get($res, 69 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the Header contents.

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

PermissionMarker Property (CloudStorage_GoogleDrive Class)

A marker when permissions are paged.

Object Oriented Interface

public function getPermissionMarker();
public function setPermissionMarker($value);

Procedural Interface

cloudstorage_googledrive_get($res, 70 );
cloudstorage_googledrive_set($res, 70, $value );

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

PermissionCount Property (CloudStorage_GoogleDrive Class)

The number of records in the Permission arrays.

Object Oriented Interface

public function getPermissionCount();
public function setPermissionCount($value);

Procedural Interface

cloudstorage_googledrive_get($res, 71 );
cloudstorage_googledrive_set($res, 71, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• PermissionAllowFileDiscovery
• PermissionDomain
• PermissionEmail
• PermissionId
• PermissionModOp
• PermissionRole
• PermissionType

The array indices start at 0 and end at PermissionCount - 1.

This property is not available at design time.

Data Type

Integer

PermissionAllowFileDiscovery Property (CloudStorage_GoogleDrive Class)

Whether the permission allows the file or folder to be discovered through search.

Object Oriented Interface

public function getPermissionAllowFileDiscovery($permissionindex);
public function setPermissionAllowFileDiscovery($permissionindex, $value);

Procedural Interface

cloudstorage_googledrive_get($res, 72 , $permissionindex);
cloudstorage_googledrive_set($res, 72, $value , $permissionindex);

Default Value

false

Remarks

Whether the permission allows the file or folder to be discovered through search.

This property indicates whether the permission allows the file or folder to which it applies to be discovered through search.

This property is only applicable if the permission's PermissionType is set to 2 (ptDomain) or 3 (ptAnyone).

The $permissionindex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

Boolean

PermissionDomain Property (CloudStorage_GoogleDrive Class)

The domain to which the permission applies.

Object Oriented Interface

public function getPermissionDomain($permissionindex);
public function setPermissionDomain($permissionindex, $value);

Procedural Interface

cloudstorage_googledrive_get($res, 73 , $permissionindex);
cloudstorage_googledrive_set($res, 73, $value , $permissionindex);

Default Value

''

Remarks

The domain to which the permission applies.

This property is used to define the domain to which the permission applies when PermissionType is set to 2 (ptDomain).

The $permissionindex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

String

PermissionEmail Property (CloudStorage_GoogleDrive Class)

The user or group to which the permission applies.

Object Oriented Interface

public function getPermissionEmail($permissionindex);
public function setPermissionEmail($permissionindex, $value);

Procedural Interface

cloudstorage_googledrive_get($res, 74 , $permissionindex);
cloudstorage_googledrive_set($res, 74, $value , $permissionindex);

Default Value

''

Remarks

The user or group to which the permission applies.

This property is used to define the user or group to which the permission applies when PermissionType is set to 0 (ptUser) or 1 (ptGroup).

The $permissionindex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

String

PermissionId Property (CloudStorage_GoogleDrive Class)

The Id of the permission.

Object Oriented Interface

public function getPermissionId($permissionindex);
public function setPermissionId($permissionindex, $value);

Procedural Interface

cloudstorage_googledrive_get($res, 75 , $permissionindex);
cloudstorage_googledrive_set($res, 75, $value , $permissionindex);

Default Value

''

Remarks

The Id of the permission.

This property holds the Id of the permission.

The $permissionindex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

String

PermissionModOp Property (CloudStorage_GoogleDrive Class)

The operation to perform on the permission.

Object Oriented Interface

public function getPermissionModOp($permissionindex);
public function setPermissionModOp($permissionindex, $value);

Procedural Interface

cloudstorage_googledrive_get($res, 76 , $permissionindex);
cloudstorage_googledrive_set($res, 76, $value , $permissionindex);

Default Value

0

Remarks

The operation to perform on the permission.

This property is used to specify the operation that the class should perform on the permission when UpdatePermissions is called. Valid values are:

Refer to UpdatePermissions for more information.

The $permissionindex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

Integer

PermissionRole Property (CloudStorage_GoogleDrive Class)

The role specified by the permission.

Object Oriented Interface

public function getPermissionRole($permissionindex);
public function setPermissionRole($permissionindex, $value);

Procedural Interface

cloudstorage_googledrive_get($res, 77 , $permissionindex);
cloudstorage_googledrive_set($res, 77, $value , $permissionindex);

Default Value

0

Remarks

The role specified by the permission.

This property defines the role specified by the permission. Possible values are:

The $permissionindex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

Integer

PermissionType Property (CloudStorage_GoogleDrive Class)

The set of users to which the permission applies.

Object Oriented Interface

public function getPermissionType($permissionindex);
public function setPermissionType($permissionindex, $value);

Procedural Interface

cloudstorage_googledrive_get($res, 78 , $permissionindex);
cloudstorage_googledrive_set($res, 78, $value , $permissionindex);

Default Value

0

Remarks

The set of users to which the permission applies.

This property defines the set of users to which the permission role defined in PermissionRole applies.

The PermissionEmail and PermissionDomain properties are used to define the user, group, or domain to which the permission applies. The following table shows which property is associated with which permission type:

The $permissionindex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

Integer

ProxyAuthScheme Property (CloudStorage_GoogleDrive Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

cloudstorage_googledrive_get($res, 79 );
cloudstorage_googledrive_set($res, 79, $value );

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the class will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (CloudStorage_GoogleDrive Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

cloudstorage_googledrive_get($res, 80 );
cloudstorage_googledrive_set($res, 80, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (CloudStorage_GoogleDrive Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

cloudstorage_googledrive_get($res, 81 );
cloudstorage_googledrive_set($res, 81, $value );

Default Value

''

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (CloudStorage_GoogleDrive Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

cloudstorage_googledrive_get($res, 82 );
cloudstorage_googledrive_set($res, 82, $value );

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (CloudStorage_GoogleDrive Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

cloudstorage_googledrive_get($res, 83 );
cloudstorage_googledrive_set($res, 83, $value );

Default Value

''

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (CloudStorage_GoogleDrive Class)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

cloudstorage_googledrive_get($res, 84 );
cloudstorage_googledrive_set($res, 84, $value );

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (CloudStorage_GoogleDrive Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

cloudstorage_googledrive_get($res, 85 );
cloudstorage_googledrive_set($res, 85, $value );

Default Value

''

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

QueryParamCount Property (CloudStorage_GoogleDrive Class)

The number of records in the QueryParam arrays.

Object Oriented Interface

public function getQueryParamCount();
public function setQueryParamCount($value);

Procedural Interface

cloudstorage_googledrive_get($res, 86 );
cloudstorage_googledrive_set($res, 86, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• QueryParamName
• QueryParamValue

The array indices start at 0 and end at QueryParamCount - 1.

This property is not available at design time.

Data Type

Integer

QueryParamName Property (CloudStorage_GoogleDrive Class)

The name of the query parameter.

Object Oriented Interface

public function getQueryParamName($queryparamindex);
public function setQueryParamName($queryparamindex, $value);

Procedural Interface

cloudstorage_googledrive_get($res, 87 , $queryparamindex);
cloudstorage_googledrive_set($res, 87, $value , $queryparamindex);

Default Value

''

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The $queryparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

QueryParamValue Property (CloudStorage_GoogleDrive Class)

The value of the query parameter.

Object Oriented Interface

public function getQueryParamValue($queryparamindex);
public function setQueryParamValue($queryparamindex, $value);

Procedural Interface

cloudstorage_googledrive_get($res, 88 , $queryparamindex);
cloudstorage_googledrive_set($res, 88, $value , $queryparamindex);

Default Value

''

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request.

The $queryparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

ResourceData Property (CloudStorage_GoogleDrive Class)

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

Object Oriented Interface

public function getResourceData();
public function setResourceData($value);

Procedural Interface

cloudstorage_googledrive_get($res, 89 );
cloudstorage_googledrive_set($res, 89, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

ResourceMarker Property (CloudStorage_GoogleDrive Class)

A marker indicating what page of resources to return next.

Object Oriented Interface

public function getResourceMarker();
public function setResourceMarker($value);

Procedural Interface

cloudstorage_googledrive_get($res, 90 );
cloudstorage_googledrive_set($res, 90, $value );

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

ResourceCount Property (CloudStorage_GoogleDrive Class)

The number of records in the Resource arrays.

Object Oriented Interface

public function getResourceCount();
public function setResourceCount($value);

Procedural Interface

cloudstorage_googledrive_get($res, 91 );
cloudstorage_googledrive_set($res, 91, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ResourceContentAccessible
• ResourceCreatedTime
• ResourceDescription
• ResourceExtension
• ResourceId
• ResourceMD5Checksum
• ResourceMIMEType
• ResourceModifiedTime
• ResourceName
• ResourceOriginalName
• ResourceOwner
• ResourceOwnerEmail
• ResourceParentIds
• ResourceSharedDriveId
• ResourceSize
• ResourceStarred
• ResourceTrashed
• ResourceType
• ResourceViewed
• ResourceViewLink

The array indices start at 0 and end at ResourceCount - 1.

This property is not available at design time.

Data Type

Integer

ResourceContentAccessible Property (CloudStorage_GoogleDrive Class)

Whether the resource's content is accessible to less-privileged users.

Object Oriented Interface

public function getResourceContentAccessible($resourceindex);
public function setResourceContentAccessible($resourceindex, $value);

Procedural Interface

cloudstorage_googledrive_get($res, 92 , $resourceindex);
cloudstorage_googledrive_set($res, 92, $value , $resourceindex);

Default Value

false

Remarks

Whether the resource's content is accessible to less-privileged users.

This property indicates whether the resource's content is accessible. If the resource is not accessible, it cannot be copied, downloaded, or printed by a users unless they have at least "writer" permissions.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is not available at design time.

Data Type

Boolean

ResourceCreatedTime Property (CloudStorage_GoogleDrive Class)

The creation date of the resource.

Object Oriented Interface

public function getResourceCreatedTime($resourceindex);
public function setResourceCreatedTime($resourceindex, $value);

Procedural Interface

cloudstorage_googledrive_get($res, 93 , $resourceindex);
cloudstorage_googledrive_set($res, 93, $value , $resourceindex);

Default Value

''

Remarks

The creation date of the resource.

This property holds a DateTime string representing the creation date of the resource. This is a combined date-time value (formatted according to RFC 3339).

Note that while this property is writable, the class only uses it as input when UploadFile is called; it is ignored when calling UpdateResource.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is not available at design time.

Data Type

String

ResourceDescription Property (CloudStorage_GoogleDrive Class)

A short description of the resource.

Object Oriented Interface

public function getResourceDescription($resourceindex);
public function setResourceDescription($resourceindex, $value);

Procedural Interface

cloudstorage_googledrive_get($res, 94 , $resourceindex);
cloudstorage_googledrive_set($res, 94, $value , $resourceindex);

Default Value

''

Remarks

A short description of the resource.

This property specifies a short description of the resource.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is not available at design time.

Data Type

String

ResourceExtension Property (CloudStorage_GoogleDrive Class)

The file extension of the resource.

Object Oriented Interface

public function getResourceExtension($resourceindex);

Procedural Interface

cloudstorage_googledrive_get($res, 95 , $resourceindex);

Default Value

''

Remarks

The file extension of the resource.

This property indicates the file extension of the resource. It cannot be set, and is empty for folder resources. To specify the extension when creating a new file resource include it when calling UploadFile.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceId Property (CloudStorage_GoogleDrive Class)

The Id of the resource.

Object Oriented Interface

public function getResourceId($resourceindex);
public function setResourceId($resourceindex, $value);

Procedural Interface

cloudstorage_googledrive_get($res, 96 , $resourceindex);
cloudstorage_googledrive_set($res, 96, $value , $resourceindex);

Default Value

''

Remarks

The Id of the resource.

This property holds the Id of the resource.

This property must be set before calling UpdateResource.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is not available at design time.

Data Type

String

ResourceMD5Checksum Property (CloudStorage_GoogleDrive Class)

The MD5 checksum of the file resource.

Object Oriented Interface

public function getResourceMD5Checksum($resourceindex);

Procedural Interface

cloudstorage_googledrive_get($res, 97 , $resourceindex);

Default Value

''

Remarks

The MD5 checksum of the file resource.

This property holds the MD5 checksum of the resource, if it is a file resource.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceMIMEType Property (CloudStorage_GoogleDrive Class)

The MIME type of the resource.

Object Oriented Interface

public function getResourceMIMEType($resourceindex);
public function setResourceMIMEType($resourceindex, $value);

Procedural Interface

cloudstorage_googledrive_get($res, 98 , $resourceindex);
cloudstorage_googledrive_set($res, 98, $value , $resourceindex);

Default Value

''

Remarks

The MIME type of the resource.

This property specifies the MIME type of the resource.

When calling UploadFile, this property is ignored in favor of the MimeType parameter of UploadFile.

When calling UpdateResource, this property is only submitted if new file data is being uploaded.

Some Google Drive MIME types:

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is not available at design time.

Data Type

String

ResourceModifiedTime Property (CloudStorage_GoogleDrive Class)

The last modified date of the resource.

Object Oriented Interface

public function getResourceModifiedTime($resourceindex);
public function setResourceModifiedTime($resourceindex, $value);

Procedural Interface

cloudstorage_googledrive_get($res, 99 , $resourceindex);
cloudstorage_googledrive_set($res, 99, $value , $resourceindex);

Default Value

''

Remarks

The last modified date of the resource.

This property holds a DateTime string representing the last modified date of the resource. This is a combined date-time value (formatted according to RFC 3339).

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is not available at design time.

Data Type

String

ResourceName Property (CloudStorage_GoogleDrive Class)

The name of the resource.

Object Oriented Interface

public function getResourceName($resourceindex);
public function setResourceName($resourceindex, $value);

Procedural Interface

cloudstorage_googledrive_get($res, 100 , $resourceindex);
cloudstorage_googledrive_set($res, 100, $value , $resourceindex);

Default Value

''

Remarks

The name of the resource.

This property specifies the name of the resource.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is not available at design time.

Data Type

String

ResourceOriginalName Property (CloudStorage_GoogleDrive Class)

The original name of the file resource.

Object Oriented Interface

public function getResourceOriginalName($resourceindex);

Procedural Interface

cloudstorage_googledrive_get($res, 101 , $resourceindex);

Default Value

''

Remarks

The original name of the file resource.

This property specifies the original name of a file resource if the file was uploaded manually, or if the name was set programmatically through the API.

Updating ResourceName will not change this value.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceOwner Property (CloudStorage_GoogleDrive Class)

The name of the resource's owner.

Object Oriented Interface

public function getResourceOwner($resourceindex);

Procedural Interface

cloudstorage_googledrive_get($res, 102 , $resourceindex);

Default Value

''

Remarks

The name of the resource's owner.

This property holds the name of resource's owner.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceOwnerEmail Property (CloudStorage_GoogleDrive Class)

The email address of the resource's owner.

Object Oriented Interface

public function getResourceOwnerEmail($resourceindex);

Procedural Interface

cloudstorage_googledrive_get($res, 103 , $resourceindex);

Default Value

''

Remarks

The email address of the resource's owner.

This property holds the email address of the resource's owner.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceParentIds Property (CloudStorage_GoogleDrive Class)

The Ids of the resource's parent folders.

Object Oriented Interface

public function getResourceParentIds($resourceindex);
public function setResourceParentIds($resourceindex, $value);

Procedural Interface

cloudstorage_googledrive_get($res, 104 , $resourceindex);
cloudstorage_googledrive_set($res, 104, $value , $resourceindex);

Default Value

''

Remarks

The Ids of the resource's parent folders.

This property holds a comma-separated list of Ids for the resource's parent folders.

Note that while this property is writable, the class only uses it as input when UploadFile is called. To modify a resource's parents in any other case, use the AddParents, RemoveParents, and MoveResource methods.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is not available at design time.

Data Type

String

ResourceSharedDriveId Property (CloudStorage_GoogleDrive Class)

The Id of the shared drive the resource is in.

Object Oriented Interface

public function getResourceSharedDriveId($resourceindex);

Procedural Interface

cloudstorage_googledrive_get($res, 105 , $resourceindex);

Default Value

''

Remarks

The Id of the shared drive the resource is in.

This property holds the Id of the shared drive that the resource is in, if applicable.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceSize Property (CloudStorage_GoogleDrive Class)

The size of the file resource in bytes.

Object Oriented Interface

public function getResourceSize($resourceindex);

Procedural Interface

cloudstorage_googledrive_get($res, 106 , $resourceindex);

Default Value

0

Remarks

The size of the file resource in bytes.

This property holds the size of a file resource in bytes. This is only applicable to files.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

Long64

ResourceStarred Property (CloudStorage_GoogleDrive Class)

Whether the resource is starred.

Object Oriented Interface

public function getResourceStarred($resourceindex);
public function setResourceStarred($resourceindex, $value);

Procedural Interface

cloudstorage_googledrive_get($res, 107 , $resourceindex);
cloudstorage_googledrive_set($res, 107, $value , $resourceindex);

Default Value

false

Remarks

Whether the resource is starred.

This property indicates whether the resource is starred by the current user.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is not available at design time.

Data Type

Boolean

ResourceTrashed Property (CloudStorage_GoogleDrive Class)

Whether the resource is in the trash.

Object Oriented Interface

public function getResourceTrashed($resourceindex);
public function setResourceTrashed($resourceindex, $value);

Procedural Interface

cloudstorage_googledrive_get($res, 108 , $resourceindex);
cloudstorage_googledrive_set($res, 108, $value , $resourceindex);

Default Value

false

Remarks

Whether the resource is in the trash.

This property indicates whether the resource has been moved to trash.

Note that while this property is writable, the class only uses it as input when UpdateResource is called; it is ignored when calling UploadFile.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is not available at design time.

Data Type

Boolean

ResourceType Property (CloudStorage_GoogleDrive Class)

The resource's type.

Object Oriented Interface

public function getResourceType($resourceindex);

Procedural Interface

cloudstorage_googledrive_get($res, 109 , $resourceindex);

Default Value

0

Remarks

The resource's type.

This property indicates whether the resource is a folder or a file. Possible values are:

Google treats files and folders in the same way, and folders are included when listing resources. The ResourceType property 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.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

Integer

ResourceViewed Property (CloudStorage_GoogleDrive Class)

Whether the resource has been viewed.

Object Oriented Interface

public function getResourceViewed($resourceindex);

Procedural Interface

cloudstorage_googledrive_get($res, 110 , $resourceindex);

Default Value

false

Remarks

Whether the resource has been viewed.

This property indicates whether the resource has been viewed by the current user.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

Boolean

ResourceViewLink Property (CloudStorage_GoogleDrive Class)

A link for opening the resource in a relevant Google editor or viewer in a browser.

Object Oriented Interface

public function getResourceViewLink($resourceindex);

Procedural Interface

cloudstorage_googledrive_get($res, 111 , $resourceindex);

Default Value

''

Remarks

A link for opening the resource in a relevant Google editor or viewer in a browser.

This property holds the link to the resource. The link may be used to view the resource in a browser or relevant editor.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResumeURL Property (CloudStorage_GoogleDrive Class)

The resumable upload URL.

Object Oriented Interface

public function getResumeURL();
public function setResumeURL($value);

Procedural Interface

cloudstorage_googledrive_get($res, 112 );
cloudstorage_googledrive_set($res, 112, $value );

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 (CloudStorage_GoogleDrive Class)

The shared drive to list file and folder resources for.

Object Oriented Interface

public function getSharedDrive();
public function setSharedDrive($value);

Procedural Interface

cloudstorage_googledrive_get($res, 113 );
cloudstorage_googledrive_set($res, 113, $value );

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 (CloudStorage_GoogleDrive Class)

A marker when shared drives are paged.

Object Oriented Interface

public function getSharedDriveMarker();
public function setSharedDriveMarker($value);

Procedural Interface

cloudstorage_googledrive_get($res, 114 );
cloudstorage_googledrive_set($res, 114, $value );

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

SharedDriveCount Property (CloudStorage_GoogleDrive Class)

The number of records in the SharedDrive arrays.

Object Oriented Interface

public function getSharedDriveCount();

Procedural Interface

cloudstorage_googledrive_get($res, 115 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SharedDriveCapabilities
• SharedDriveCreatedTime
• SharedDriveHidden
• SharedDriveId
• SharedDriveName
• SharedDriveRestrictions

The array indices start at 0 and end at SharedDriveCount - 1.

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

Data Type

Integer

SharedDriveCapabilities Property (CloudStorage_GoogleDrive Class)

The capabilities that the current user has for the shared drive.

Object Oriented Interface

public function getSharedDriveCapabilities($shareddriveindex);

Procedural Interface

cloudstorage_googledrive_get($res, 116 , $shareddriveindex);

Default Value

0

Remarks

The capabilities that the current user has for the shared drive.

This property describes the effective capabilities that the current user has for the shared drive. The value is a bit field comprised of one or more of the following, OR'ed together:

The $shareddriveindex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedDriveCount property.

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

Data Type

Integer

SharedDriveCreatedTime Property (CloudStorage_GoogleDrive Class)

The creation date of the shared drive.

Object Oriented Interface

public function getSharedDriveCreatedTime($shareddriveindex);

Procedural Interface

cloudstorage_googledrive_get($res, 117 , $shareddriveindex);

Default Value

''

Remarks

The creation date of the shared drive.

This property holds a DateTime string representing the creation date of the shared drive. This is a combined date-time value (formatted according to RFC 3339).

The $shareddriveindex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedDriveCount property.

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

Data Type

String

SharedDriveHidden Property (CloudStorage_GoogleDrive Class)

Whether the shared drive is hidden from default view.

Object Oriented Interface

public function getSharedDriveHidden($shareddriveindex);

Procedural Interface

cloudstorage_googledrive_get($res, 118 , $shareddriveindex);

Default Value

false

Remarks

Whether the shared drive is hidden from default view.

This property specifies whether the shared drive is hidden from default view. To hide or unhide a shared drive, call the ToggleSharedDriveHidden method.

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.

The $shareddriveindex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedDriveCount property.

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

Data Type

Boolean

SharedDriveId Property (CloudStorage_GoogleDrive Class)

The Id of the shared drive.

Object Oriented Interface

public function getSharedDriveId($shareddriveindex);

Procedural Interface

cloudstorage_googledrive_get($res, 119 , $shareddriveindex);

Default Value

''

Remarks

The Id of the shared drive.

This property holds the Id of the shared drive.

The $shareddriveindex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedDriveCount property.

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

Data Type

String

SharedDriveName Property (CloudStorage_GoogleDrive Class)

The name of the shared drive.

Object Oriented Interface

public function getSharedDriveName($shareddriveindex);

Procedural Interface

cloudstorage_googledrive_get($res, 120 , $shareddriveindex);

Default Value

''

Remarks

The name of the shared drive.

This property reflects the name of the shared drive.

The UpdateSharedDrive method can be used to rename the shared drive if the current user is allowed to do so (i.e., if the SharedDriveCapabilities property has the 0x08000 flag set).

The $shareddriveindex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedDriveCount property.

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

Data Type

String

SharedDriveRestrictions Property (CloudStorage_GoogleDrive Class)

The restrictions that apply to the shared drive.

Object Oriented Interface

public function getSharedDriveRestrictions($shareddriveindex);

Procedural Interface

cloudstorage_googledrive_get($res, 121 , $shareddriveindex);

Default Value

0

Remarks

The restrictions that apply to the shared drive.

This property specifies the restrictions that apply to the shared drive. The value is a bitmask comprised of one or more of the following, OR'ed together:

The UpdateSharedDrive method can be used to change any of the shared drive's restrictions that the current user is allowed to alter (indicated by the presence of the 0x00002, 0x00004, and/or 0x00010 flags in the SharedDriveCapabilities property).

The $shareddriveindex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedDriveCount property.

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

Data Type

Integer

SSLAcceptServerCertEffectiveDate Property (CloudStorage_GoogleDrive Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

cloudstorage_googledrive_get($res, 122 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (CloudStorage_GoogleDrive Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

cloudstorage_googledrive_get($res, 123 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (CloudStorage_GoogleDrive Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

cloudstorage_googledrive_get($res, 124 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (CloudStorage_GoogleDrive Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

cloudstorage_googledrive_get($res, 125 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (CloudStorage_GoogleDrive Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

cloudstorage_googledrive_get($res, 126 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (CloudStorage_GoogleDrive Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

cloudstorage_googledrive_get($res, 127 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (CloudStorage_GoogleDrive Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

cloudstorage_googledrive_get($res, 128 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (CloudStorage_GoogleDrive Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

cloudstorage_googledrive_get($res, 129 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (CloudStorage_GoogleDrive Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_googledrive_get($res, 130 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (CloudStorage_GoogleDrive Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

cloudstorage_googledrive_get($res, 131 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (CloudStorage_GoogleDrive Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

cloudstorage_googledrive_get($res, 132 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (CloudStorage_GoogleDrive Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_googledrive_get($res, 133 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (CloudStorage_GoogleDrive Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

cloudstorage_googledrive_get($res, 134 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (CloudStorage_GoogleDrive Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

cloudstorage_googledrive_get($res, 135 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (CloudStorage_GoogleDrive Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

cloudstorage_googledrive_get($res, 136 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (CloudStorage_GoogleDrive Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

cloudstorage_googledrive_get($res, 137 );
cloudstorage_googledrive_set($res, 137, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (CloudStorage_GoogleDrive Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

cloudstorage_googledrive_get($res, 138 );
cloudstorage_googledrive_set($res, 138, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (CloudStorage_GoogleDrive Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

cloudstorage_googledrive_get($res, 139 );
cloudstorage_googledrive_set($res, 139, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (CloudStorage_GoogleDrive Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

cloudstorage_googledrive_get($res, 140 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (CloudStorage_GoogleDrive Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

cloudstorage_googledrive_get($res, 141 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (CloudStorage_GoogleDrive Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

cloudstorage_googledrive_get($res, 142 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (CloudStorage_GoogleDrive Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

cloudstorage_googledrive_get($res, 143 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (CloudStorage_GoogleDrive Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

cloudstorage_googledrive_get($res, 144 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (CloudStorage_GoogleDrive Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

cloudstorage_googledrive_get($res, 145 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (CloudStorage_GoogleDrive Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

cloudstorage_googledrive_get($res, 146 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (CloudStorage_GoogleDrive Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

cloudstorage_googledrive_get($res, 147 );
cloudstorage_googledrive_set($res, 147, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (CloudStorage_GoogleDrive Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

cloudstorage_googledrive_get($res, 148 );
cloudstorage_googledrive_set($res, 148, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (CloudStorage_GoogleDrive Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

cloudstorage_googledrive_get($res, 149 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (CloudStorage_GoogleDrive Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

cloudstorage_googledrive_get($res, 150 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (CloudStorage_GoogleDrive Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

cloudstorage_googledrive_get($res, 151 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (CloudStorage_GoogleDrive Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

cloudstorage_googledrive_get($res, 152 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (CloudStorage_GoogleDrive Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

cloudstorage_googledrive_get($res, 153 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (CloudStorage_GoogleDrive Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

cloudstorage_googledrive_get($res, 154 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (CloudStorage_GoogleDrive Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

cloudstorage_googledrive_get($res, 155 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (CloudStorage_GoogleDrive Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

cloudstorage_googledrive_get($res, 156 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (CloudStorage_GoogleDrive Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_googledrive_get($res, 157 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (CloudStorage_GoogleDrive Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

cloudstorage_googledrive_get($res, 158 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (CloudStorage_GoogleDrive Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

cloudstorage_googledrive_get($res, 159 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (CloudStorage_GoogleDrive Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_googledrive_get($res, 160 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (CloudStorage_GoogleDrive Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

cloudstorage_googledrive_get($res, 161 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (CloudStorage_GoogleDrive Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

cloudstorage_googledrive_get($res, 162 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (CloudStorage_GoogleDrive Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

cloudstorage_googledrive_get($res, 163 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (CloudStorage_GoogleDrive Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

cloudstorage_googledrive_get($res, 164 );
cloudstorage_googledrive_set($res, 164, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (CloudStorage_GoogleDrive Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

cloudstorage_googledrive_get($res, 165 );
cloudstorage_googledrive_set($res, 165, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (CloudStorage_GoogleDrive Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

cloudstorage_googledrive_get($res, 166 );
cloudstorage_googledrive_set($res, 166, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (CloudStorage_GoogleDrive Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

cloudstorage_googledrive_get($res, 167 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (CloudStorage_GoogleDrive Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

cloudstorage_googledrive_get($res, 168 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (CloudStorage_GoogleDrive Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

cloudstorage_googledrive_get($res, 169 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (CloudStorage_GoogleDrive Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

cloudstorage_googledrive_get($res, 170 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (CloudStorage_GoogleDrive Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

cloudstorage_googledrive_get($res, 171 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (CloudStorage_GoogleDrive Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

cloudstorage_googledrive_get($res, 172 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (CloudStorage_GoogleDrive Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

cloudstorage_googledrive_get($res, 173 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (CloudStorage_GoogleDrive Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

cloudstorage_googledrive_get($res, 174 );
cloudstorage_googledrive_set($res, 174, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (CloudStorage_GoogleDrive Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

cloudstorage_googledrive_get($res, 175 );
cloudstorage_googledrive_set($res, 175, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (CloudStorage_GoogleDrive Class)

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

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

cloudstorage_googledrive_get($res, 176 );
cloudstorage_googledrive_set($res, 176, $value );

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:

Additional Notes

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

SSLServerCertEffectiveDate Property (CloudStorage_GoogleDrive Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

cloudstorage_googledrive_get($res, 177 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (CloudStorage_GoogleDrive Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

cloudstorage_googledrive_get($res, 178 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (CloudStorage_GoogleDrive Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

cloudstorage_googledrive_get($res, 179 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (CloudStorage_GoogleDrive Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

cloudstorage_googledrive_get($res, 180 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (CloudStorage_GoogleDrive Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

cloudstorage_googledrive_get($res, 181 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (CloudStorage_GoogleDrive Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

cloudstorage_googledrive_get($res, 182 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (CloudStorage_GoogleDrive Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

cloudstorage_googledrive_get($res, 183 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (CloudStorage_GoogleDrive Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

cloudstorage_googledrive_get($res, 184 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (CloudStorage_GoogleDrive Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_googledrive_get($res, 185 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (CloudStorage_GoogleDrive Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

cloudstorage_googledrive_get($res, 186 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (CloudStorage_GoogleDrive Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

cloudstorage_googledrive_get($res, 187 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (CloudStorage_GoogleDrive Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_googledrive_get($res, 188 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (CloudStorage_GoogleDrive Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

cloudstorage_googledrive_get($res, 189 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (CloudStorage_GoogleDrive Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

cloudstorage_googledrive_get($res, 190 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (CloudStorage_GoogleDrive Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

cloudstorage_googledrive_get($res, 191 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (CloudStorage_GoogleDrive Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

cloudstorage_googledrive_get($res, 192 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (CloudStorage_GoogleDrive Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

cloudstorage_googledrive_get($res, 193 );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (CloudStorage_GoogleDrive Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

cloudstorage_googledrive_get($res, 194 );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (CloudStorage_GoogleDrive Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

cloudstorage_googledrive_get($res, 195 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (CloudStorage_GoogleDrive Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

cloudstorage_googledrive_get($res, 196 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (CloudStorage_GoogleDrive Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

cloudstorage_googledrive_get($res, 197 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (CloudStorage_GoogleDrive Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

cloudstorage_googledrive_get($res, 198 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (CloudStorage_GoogleDrive Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

cloudstorage_googledrive_get($res, 199 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (CloudStorage_GoogleDrive Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

cloudstorage_googledrive_get($res, 200 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (CloudStorage_GoogleDrive Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

cloudstorage_googledrive_get($res, 201 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (CloudStorage_GoogleDrive Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

cloudstorage_googledrive_get($res, 202 );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (CloudStorage_GoogleDrive Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudstorage_googledrive_get($res, 203 );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

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

Data Type

Binary String

StartByte Property (CloudStorage_GoogleDrive Class)

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

Object Oriented Interface

public function getStartByte();
public function setStartByte($value);

Procedural Interface

cloudstorage_googledrive_get($res, 204 );
cloudstorage_googledrive_set($res, 204, $value );

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Long64

Timeout Property (CloudStorage_GoogleDrive Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

cloudstorage_googledrive_get($res, 205 );
cloudstorage_googledrive_set($res, 205, $value );

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 (CloudStorage_GoogleDrive Class)

Whether to use resumable uploads.

Object Oriented Interface

public function getUseResumableUpload();
public function setUseResumableUpload($value);

Procedural Interface

cloudstorage_googledrive_get($res, 206 );
cloudstorage_googledrive_set($res, 206, $value );

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 (CloudStorage_GoogleDrive Class)

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

Object Oriented Interface

public function doAddParents($resourceid, $parentids);

Procedural Interface

cloudstorage_googledrive_do_addparents($res, $resourceid, $parentids);

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.

AddQueryParam Method (CloudStorage_GoogleDrive Class)

Adds a query parameter to the QueryParams properties.

Object Oriented Interface

public function doAddQueryParam($name, $value);

Procedural Interface

cloudstorage_googledrive_do_addqueryparam($res, $name, $value);

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.

AddSharedDriveMember Method (CloudStorage_GoogleDrive Class)

Creates a new shared drive member.

Object Oriented Interface

public function doAddSharedDriveMember($shareddriveid, $role, $permissiontype, $email);

Procedural Interface

cloudstorage_googledrive_do_addshareddrivemember($res, $shareddriveid, $role, $permissiontype, $email);

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);

Authorize Method (CloudStorage_GoogleDrive Class)

Get the authorization string required to access the protected resource.

Object Oriented Interface

public function doAuthorize();

Procedural Interface

cloudstorage_googledrive_do_authorize($res);

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 OAuthClientProfile property and the OAuthGrantType property. 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.

CalcAuthorization Method (CloudStorage_GoogleDrive Class)

Calculates the Authorization header based on provided credentials.

Object Oriented Interface

public function doCalcAuthorization();

Procedural Interface

cloudstorage_googledrive_do_calcauthorization($res);

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.

Config Method (CloudStorage_GoogleDrive Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudstorage_googledrive_do_config($res, $configurationstring);

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.

CopyResource Method (CloudStorage_GoogleDrive Class)

Copies a file.

Object Oriented Interface

public function doCopyResource($resourceid, $newname, $parentids);

Procedural Interface

cloudstorage_googledrive_do_copyresource($res, $resourceid, $newname, $parentids);

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.

CreateFolder Method (CloudStorage_GoogleDrive Class)

Creates a new folder.

Object Oriented Interface

public function doCreateFolder($name, $parentids);

Procedural Interface

cloudstorage_googledrive_do_createfolder($res, $name, $parentids);

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 ResourceType property 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.

CreateSharedDrive Method (CloudStorage_GoogleDrive Class)

Creates a new shared drive.

Object Oriented Interface

public function doCreateSharedDrive($name, $requestid);

Procedural Interface

cloudstorage_googledrive_do_createshareddrive($res, $name, $requestid);

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.)

DeleteResource Method (CloudStorage_GoogleDrive Class)

Deletes the specified file or folder permanently.

Object Oriented Interface

public function doDeleteResource($resourceid);

Procedural Interface

cloudstorage_googledrive_do_deleteresource($res, $resourceid);

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.

DeleteSharedDrive Method (CloudStorage_GoogleDrive Class)

Deletes a shared drive.

Object Oriented Interface

public function doDeleteSharedDrive($shareddriveid);

Procedural Interface

cloudstorage_googledrive_do_deleteshareddrive($res, $shareddriveid);

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).

DownloadFile Method (CloudStorage_GoogleDrive Class)

Downloads, and optionally converts, a file.

Object Oriented Interface

public function doDownloadFile($resourceid, $mimetype);

Procedural Interface

cloudstorage_googledrive_do_downloadfile($res, $resourceid, $mimetype);

Remarks

This method downloads the file specified by ResourceId.

If 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

Downloading an Encrypted File

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, "");

EmptyTrash Method (CloudStorage_GoogleDrive Class)

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

Object Oriented Interface

public function doEmptyTrash();

Procedural Interface

cloudstorage_googledrive_do_emptytrash($res);

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!

GetAccountInfo Method (CloudStorage_GoogleDrive Class)

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

Object Oriented Interface

public function doGetAccountInfo();

Procedural Interface

cloudstorage_googledrive_do_getaccountinfo($res);

Remarks

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

GetCurrentChangeMarker Method (CloudStorage_GoogleDrive Class)

Gets the most current change marker.

Object Oriented Interface

public function doGetCurrentChangeMarker();

Procedural Interface

cloudstorage_googledrive_do_getcurrentchangemarker($res);

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.

GetPermissionInfo Method (CloudStorage_GoogleDrive Class)

Gets information about a specific permission.

Object Oriented Interface

public function doGetPermissionInfo($resourceid, $permissionid);

Procedural Interface

cloudstorage_googledrive_do_getpermissioninfo($res, $resourceid, $permissionid);

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

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.

GetResourceInfo Method (CloudStorage_GoogleDrive Class)

Gets information about specific files and folders.

Object Oriented Interface

public function doGetResourceInfo($resourceids);

Procedural Interface

cloudstorage_googledrive_do_getresourceinfo($res, $resourceids);

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.

GetSharedDriveInfo Method (CloudStorage_GoogleDrive Class)

Gets information about a specific shared drive.

Object Oriented Interface

public function doGetSharedDriveInfo($shareddriveid);

Procedural Interface

cloudstorage_googledrive_do_getshareddriveinfo($res, $shareddriveid);

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).

GetUploadStatus Method (CloudStorage_GoogleDrive Class)

Gets the status of a resumable upload session.

Object Oriented Interface

public function doGetUploadStatus();

Procedural Interface

cloudstorage_googledrive_do_getuploadstatus($res);

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.

Interrupt Method (CloudStorage_GoogleDrive Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

cloudstorage_googledrive_do_interrupt($res);

Remarks

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

ListChanges Method (CloudStorage_GoogleDrive Class)

Lists changes to resources and shared drives.

Object Oriented Interface

public function doListChanges();

Procedural Interface

cloudstorage_googledrive_do_listchanges($res);

Remarks

This method lists changes to resources and shared drives.

General Usage

When this method is called, it will use the change marker stored in either ChangeMarker or NextChangeMarker (only one can be populated at a time) to request the next page of changes. This method causes the ChangeList event to fire once for each change, and will also populate the Changes properties.

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

When working in the context of shared drives, there are additional properties that can be configured to specify what kinds of changes should returned.

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 ChangeType will reflect whether it is associated with a file or folder (0), or a shared drive itself (1).

ListChildren Method (CloudStorage_GoogleDrive Class)

Lists the child resources of one or more folders.

Object Oriented Interface

public function doListChildren($folderids);

Procedural Interface

cloudstorage_googledrive_do_listchildren($res, $folderids);

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));

ListParents Method (CloudStorage_GoogleDrive Class)

Lists the parent folders of a file or folder.

Object Oriented Interface

public function doListParents($resourceid);

Procedural Interface

cloudstorage_googledrive_do_listparents($res, $resourceid);

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.

ListPermissions Method (CloudStorage_GoogleDrive Class)

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

Object Oriented Interface

public function doListPermissions($resourceid);

Procedural Interface

cloudstorage_googledrive_do_listpermissions($res, $resourceid);

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

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.

Shared Drive Capabilities

To determine the effective capabilities the current user has for shared drives that they're a member of, call ListSharedDrives instead and inspect the SharedDriveCapabilities property of the returned items.

ListResources Method (CloudStorage_GoogleDrive Class)

Lists files and folders.

Object Oriented Interface

public function doListResources();

Procedural Interface

cloudstorage_googledrive_do_listresources($res);

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

By default, all files and folders in the scope specified by the ListResourcesScope property will be returned. The ListResourcesMode configuration setting can be used to specify that only files or only folders should be returned. Refer to the "Result Scopes" section, below, for more information about what the results for each scope are comprised of.

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

There are a number of different search scopes which the results of this method can be drawn from, some of which are exclusive to shared drives.

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

Shared drives are, more than anything else, very similar to a normal user account. Once this is understood, it becomes much easier to understand how shared drives fit into the overall Google Drive architecture.

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));

ListRevisions Method (CloudStorage_GoogleDrive Class)

List the revisions of a file.

Object Oriented Interface

public function doListRevisions($fileid);

Procedural Interface

cloudstorage_googledrive_do_listrevisions($res, $fileid);

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.

ListSharedDrives Method (CloudStorage_GoogleDrive Class)

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

Object Oriented Interface

public function doListSharedDrives();

Procedural Interface

cloudstorage_googledrive_do_listshareddrives($res);

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));

MoveResource Method (CloudStorage_GoogleDrive Class)

Moves a file or folder.

Object Oriented Interface

public function doMoveResource($resourceid, $newparentids);

Procedural Interface

cloudstorage_googledrive_do_moveresource($res, $resourceid, $newparentids);

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.

RemoveParents Method (CloudStorage_GoogleDrive Class)

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

Object Oriented Interface

public function doRemoveParents($resourceid, $parentids);

Procedural Interface

cloudstorage_googledrive_do_removeparents($res, $resourceid, $parentids);

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.

RemoveSharedDriveMember Method (CloudStorage_GoogleDrive Class)

Removes an existing shared drive member.

Object Oriented Interface

public function doRemoveSharedDriveMember($shareddriveid, $permissionid);

Procedural Interface

cloudstorage_googledrive_do_removeshareddrivemember($res, $shareddriveid, $permissionid);

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);

Reset Method (CloudStorage_GoogleDrive Class)

Resets the class to its initial state.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudstorage_googledrive_do_reset($res);

Remarks

This method resets the class to its initial state.

RestoreResource Method (CloudStorage_GoogleDrive Class)

Restores a file or folder from the trash.

Object Oriented Interface

public function doRestoreResource($resourceid);

Procedural Interface

cloudstorage_googledrive_do_restoreresource($res, $resourceid);

Remarks

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

SendCustomRequest Method (CloudStorage_GoogleDrive Class)

Sends a custom request to the Google Drive API.

Object Oriented Interface

public function doSendCustomRequest($httpmethod, $requestpath, $requestbody);

Procedural Interface

cloudstorage_googledrive_do_sendcustomrequest($res, $httpmethod, $requestpath, $requestbody);

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 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.

ToggleSharedDriveHidden Method (CloudStorage_GoogleDrive Class)

Hides or unhides a shared drive.

Object Oriented Interface

public function doToggleSharedDriveHidden($shareddriveid, $hidden);

Procedural Interface

cloudstorage_googledrive_do_toggleshareddrivehidden($res, $shareddriveid, $hidden);

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.

TrashResource Method (CloudStorage_GoogleDrive Class)

Moves the specified file or folder to the trash.

Object Oriented Interface

public function doTrashResource($resourceid);

Procedural Interface

cloudstorage_googledrive_do_trashresource($res, $resourceid);

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.

UpdatePermissions Method (CloudStorage_GoogleDrive Class)

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

Object Oriented Interface

public function doUpdatePermissions($resourceid);

Procedural Interface

cloudstorage_googledrive_do_updatepermissions($res, $resourceid);

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 PermissionModOp property 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 PermissionModOp property 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

ListPermissions must be called before using this method in order to populate the Permissions properties with a resource's existing permissions. (When creating new permissions, calling ListPermissions first is optional, but still recommended to ensure that the class reflects the latest information.)

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 properties to the desired values. The PermissionModOp property 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

When creating or updating a permission with the prOwner (3) role on a file or folder, the old owner will have their role downgraded to prWriter (2). The TransferOwnership configuration setting must be set to "True" before calling UpdatePermissions to acknowledge this side effect.

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

The permissions on a shared drive itself determine what users are members of the shared drive, and what capabilities they have within the shared drive. Said another way, creating, updating, and deleting the permissions on a shared drive will create, update the capabilities of, and delete shared drive memberships.

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).

UpdateResource Method (CloudStorage_GoogleDrive Class)

Updates a file or folder.

Object Oriented Interface

public function doUpdateResource($resourceid);

Procedural Interface

cloudstorage_googledrive_do_updateresource($res, $resourceid);

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

There must be a GDriveResource properties whose ResourceId property matches the specified ResourceId value before this method is called.

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* properties as desired; the following properties are supported:
   • ResourceContentAccessible
   • ResourceDescription
   • ResourceMIMEType (only updated for files, if not empty and new file data is uploaded)
   • ResourceModifiedTime (only updated if not empty)
   • ResourceName
   • ResourceStarred
   • ResourceTrashed
3. For file resources, you may 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.

// Load the latest information about the resource into the Resources collection. string resId = "2309urjdojwefs0d09u"; googledrive.GetResourceInfo(resId); // We'll update the file resource's name, description, and content. googledrive.ResourceData = "new file content"; googledrive.Resources[0].Name = "CoolStuff2.txt"; googledrive.Resources[0].Description = "This is a text file with cool stuff in it"; googledrive.UpdateResource(resId);

UpdateSharedDrive Method (CloudStorage_GoogleDrive Class)

Updates a shared drive.

Object Oriented Interface

public function doUpdateSharedDrive($shareddriveid, $newname, $setrestrictions, $unsetrestrictions);

Procedural Interface

cloudstorage_googledrive_do_updateshareddrive($res, $shareddriveid, $newname, $setrestrictions, $unsetrestrictions);

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 SharedDriveCapabilities property 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 SharedDriveRestrictions (i.e., if the SharedDriveCapabilities property 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.

UpdateSharedDriveMember Method (CloudStorage_GoogleDrive Class)

Updates an existing shared drive member's role.

Object Oriented Interface

public function doUpdateSharedDriveMember($shareddriveid, $permissionid, $role);

Procedural Interface

cloudstorage_googledrive_do_updateshareddrivemember($res, $shareddriveid, $permissionid, $role);

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);

UploadFile Method (CloudStorage_GoogleDrive Class)

Uploads, and optionally converts, a new file.

Object Oriented Interface

public function doUploadFile($filename, $mimetype);

Procedural Interface

cloudstorage_googledrive_do_uploadfile($res, $filename, $mimetype);

Remarks

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

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

The name specified by the FileName parameter should include a file extension.

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 properties. (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). 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", "");

ChangeList Event (CloudStorage_GoogleDrive Class)

Fires once for each change when ListChanges is called.

Object Oriented Interface

public function fireChangeList($param);

Procedural Interface

cloudstorage_googledrive_register_callback($res, 1, array($this, 'fireChangeList'));

Parameter List

 'resourceid'
 'shareddriveid'
 'removed'
 'time'
 'changetype'

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 (CloudStorage_GoogleDrive Class)

This event fires when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

cloudstorage_googledrive_register_callback($res, 2, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

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 (CloudStorage_GoogleDrive Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudstorage_googledrive_register_callback($res, 3, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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 (CloudStorage_GoogleDrive Class)

Fires after each fragment of a resumable upload is completed.

Object Oriented Interface

public function fireFragmentComplete($param);

Procedural Interface

cloudstorage_googledrive_register_callback($res, 4, array($this, 'fireFragmentComplete'));

Parameter List

 'fragmentnumber'
 'fragmentcount'
 'interrupt'

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 (CloudStorage_GoogleDrive Class)

Fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

cloudstorage_googledrive_register_callback($res, 5, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

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 (CloudStorage_GoogleDrive Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudstorage_googledrive_register_callback($res, 6, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

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 (CloudStorage_GoogleDrive Class)

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

Object Oriented Interface

public function firePermissionList($param);

Procedural Interface

cloudstorage_googledrive_register_callback($res, 7, array($this, 'firePermissionList'));

Parameter List

 'id'
 'role'
 'permissiontype'
 'email'
 'domain'
 'allowfilediscovery'

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:

Email holds the email address of the user or group that the permission applies to when Type is 0 or 1.

Domain holds the domain that the permission applies to when Type is 2.

AllowFileDiscovery signifies whether the permission allows the file to be discovered through search. It is only applicable when Type is 2 or 3.

Progress Event (CloudStorage_GoogleDrive Class)

Fires during an upload or download to indicate transfer progress.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

cloudstorage_googledrive_register_callback($res, 8, array($this, 'fireProgress'));

Parameter List

 'direction'
 'bytestransferred'
 'totalbytes'
 'percentdone'

Remarks

This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.

Direction indicates whether the transfer is an upload (0) or a download (1).

BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.

PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.

Note: By default, the class tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.

For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.

This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the class will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.

ResourceList Event (CloudStorage_GoogleDrive Class)

Fires once for each resource returned when listing resources.

Object Oriented Interface

public function fireResourceList($param);

Procedural Interface

cloudstorage_googledrive_register_callback($res, 9, array($this, 'fireResourceList'));

Parameter List

 'id'
 'name'
 'extension'
 'description'
 'resourcetype'
 'shareddriveid'
 'createdtime'
 'modifiedtime'
 'size'
 'trashed'

Remarks

This event fires once for each resource returned when ListResources, ListChildren, ListParents, or GetResourceInfo is called.

Id is the Id of the resource.

Name holds the resource's name.

Extension is the file extension.

Description holds a short description of the resource (if any).

ResourceType indicates whether the resource is a file or folder. Possible values are:

SharedDriveId is the Id of the shared drive which the resource is in, or empty string if it is not in a shared drive.

CreatedTime holds a DateTime string representing the creation date of the resource. This is a combined date-time value (formatted according to RFC 3339).

ModifiedTime holds a DateTime string representing the last modified date of the resource. This is a combined date-time value (formatted according to RFC 3339).

Size holds the size of the file in bytes. This is only applicable to files.

Trashed indicates whether the resource is in the trash.

SharedDriveList Event (CloudStorage_GoogleDrive Class)

Fires once for each shared drive returned when listing shared drives.

Object Oriented Interface

public function fireSharedDriveList($param);

Procedural Interface

cloudstorage_googledrive_register_callback($res, 10, array($this, 'fireSharedDriveList'));

Parameter List

 'id'
 'name'
 'createdtime'
 'hidden'
 'capabilities'
 'restrictions'

Remarks

This event fires once for each shared drive returned when ListSharedDrives is called.

Id is the Id of the shared drive.

Name holds the shared drive's name.

CreatedTime holds a DateTime string representing the creation date of the resource. This is a combined date-time value (formatted according to RFC 3339).

Hidden indicates whether the shared drive is hidden from default view (i.e., whether it is shown by default in the Google Drive UI).

Capabilities describes the effective capabilities that the current user has for the shared drive. The value is a bit field comprised of one or more of the following, OR'ed together:

Restrictions describes any restrictions that apply to the shared drive and/or its contents. The value is a bit field comprised of one or more of the following, OR'ed together:

SSLServerAuthentication Event (CloudStorage_GoogleDrive Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudstorage_googledrive_register_callback($res, 11, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (CloudStorage_GoogleDrive Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudstorage_googledrive_register_callback($res, 12, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (CloudStorage_GoogleDrive Class)

This event fires when a document starts transferring (after the headers).

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

cloudstorage_googledrive_register_callback($res, 13, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

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

Transfer Event (CloudStorage_GoogleDrive Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

cloudstorage_googledrive_register_callback($res, 14, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

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

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (GoogleDrive Class)

The class accepts one or more of the following configuration settings. Configuration 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.

GoogleDrive Config Settings

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (GoogleDrive Class)

Common Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors