GoogleDrive Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

nsoftware.CloudStorage.GoogleDrive

Remarks

The GoogleDrive component 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 component requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property to set the appropriate fields for the chosen ClientProfile and GrantType.

The component has the following defaults:

Below is a brief description of the different ClientProfile and GrantType values that are supported by this component. 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 component. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.

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

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

Authorization Code

When using the Authorization Code grant type, the component will use an authorization code to get an access token. For this GrantType the component expects a ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the component will parse the authorization code, setting the AuthorizationCode field, from the redirect. Immediately, the component will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the RefreshToken field is set, or a refresh token is cached, then the component 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 component will request the authorization server to get an access token. For this GrantType the component expects a ClientId, ClientSecret, and ServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the component 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 component will not be able to automatically get a fresh token once it expires.

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

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

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

Listing Resources

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

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

Downloading Files

The DownloadFile method is used to download files.

Download Notes

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

Resuming Downloads

The component 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 component 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 component 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 component 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 component. 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 component 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 component is used, they should already be populated, and no special action should be needed). If uploading from a stream, be sure to reset its position to where it was the first time the upload was started (typically the beginning). Then call UploadFile again to resume the upload at the specified StartByte offset.

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

Shared Drive Support

The GoogleDrive component 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 component 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 component 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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

Account Property (GoogleDrive Component)

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

Syntax

• C#
• VB.NET

public GDriveAccount Account { get; }

Public ReadOnly Property Account As GDriveAccount

Remarks

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

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

Authorization Property (GoogleDrive Component)

OAuth 2.0 Authorization Token

Syntax

• C#
• VB.NET

public string Authorization { get; set; }

Public Property Authorization As String

Default Value

""

Remarks

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

Bearer ACCESS_TOKEN

ChangeMarker Property (GoogleDrive Component)

A marker indicating what page of changes to return next.

Syntax

• C#
• VB.NET

public string ChangeMarker { get; set; }

Public Property ChangeMarker As String

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.

Changes Property (GoogleDrive Component)

A collection of changes.

Syntax

• C#
• VB.NET

public GDriveChangeList Changes { get; }

Public ReadOnly Property Changes As GDriveChangeList

Remarks

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

Refer to ListChanges for more information.

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

ChildMarker Property (GoogleDrive Component)

A marker when child resources are paged.

Syntax

• C#
• VB.NET

public string ChildMarker { get; set; }

Public Property ChildMarker As String

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.

Children Property (GoogleDrive Component)

A collection of child resources.

Syntax

• C#
• VB.NET

public GDriveResourceList Children { get; }

Public ReadOnly Property Children As GDriveResourceList

Remarks

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

Calling ListChildren will populate this collection.

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

EncryptionAlgorithm Property (GoogleDrive Component)

The encryption algorithm.

Syntax

• C#
• VB.NET

public GoogleDriveEncryptionAlgorithms EncryptionAlgorithm { get; set; }

enum GoogleDriveEncryptionAlgorithms {
  eaAES,
  eaBlowfish,
  eaCAST,
  eaDES,
  eaIDEA,
  eaRC2,
  eaRC4,
  eaTEA,
  eaTripleDES,
  eaTwofish,
  eaRijndael,
  eaChaCha,
  eaXSalsa20
}

Public Property EncryptionAlgorithm As GoogledriveEncryptionAlgorithms

Enum GoogleDriveEncryptionAlgorithms
  eaAES
  eaBlowfish
  eaCAST
  eaDES
  eaIDEA
  eaRC2
  eaRC4
  eaTEA
  eaTripleDES
  eaTwofish
  eaRijndael
  eaChaCha
  eaXSalsa20
End Enum

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:

EncryptionPassword Property (GoogleDrive Component)

The encryption password.

Syntax

• C#
• VB.NET

public string EncryptionPassword { get; set; }

Public Property EncryptionPassword As String

Default Value

""

Remarks

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

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

Firewall Property (GoogleDrive Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

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

Idle Property (GoogleDrive Component)

The current status of the component.

Syntax

• C#
• VB.NET

public bool Idle { get; }

Public ReadOnly Property Idle As Boolean

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.

ListResourcesScope Property (GoogleDrive Component)

Controls the scope of the results when listing resources.

Syntax

• C#
• VB.NET

public GoogleDriveListResourcesScopes ListResourcesScope { get; set; }

enum GoogleDriveListResourcesScopes {
  lrsUser,
  lrsDomain,
  lrsSharedDrive,
  lrsAllDrives
}

Public Property ListResourcesScope As GoogledriveListResourcesScopes

Enum GoogleDriveListResourcesScopes
  lrsUser
  lrsDomain
  lrsSharedDrive
  lrsAllDrives
End Enum

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.

LocalFile Property (GoogleDrive Component)

The location of the local file.

Syntax

• C#
• VB.NET

public string LocalFile { get; set; }

Public Property LocalFile As String

Default Value

""

Remarks

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

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

LocalHost Property (GoogleDrive Component)

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

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

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 component initiate connections (or accept in the case of server components) 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 component 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.

NextChangeMarker Property (GoogleDrive Component)

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

Syntax

• C#
• VB.NET

public string NextChangeMarker { get; set; }

Public Property NextChangeMarker As String

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.

OAuth Property (GoogleDrive Component)

This property holds the OAuth Settings.

Syntax

• C#
• VB.NET

public OAuthSettings OAuth { get; }

Public ReadOnly Property OAuth As OAuthSettings

Remarks

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

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

OtherHeaders Property (GoogleDrive Component)

Other headers as determined by the user (optional).

Syntax

• C#
• VB.NET

public string OtherHeaders { get; set; }

Public Property OtherHeaders As String

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 component beyond what is provided.

This property is not available at design time.

Overwrite Property (GoogleDrive Component)

Determines if local files are overwritten.

Syntax

• C#
• VB.NET

public bool Overwrite { get; set; }

Public Property Overwrite As Boolean

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.

ParsedHeaders Property (GoogleDrive Component)

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

Syntax

• C#
• VB.NET

public HeaderList ParsedHeaders { get; }

Public ReadOnly Property ParsedHeaders As HeaderList

Remarks

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

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

This collection is indexed from 0 to count -1.

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

PermissionMarker Property (GoogleDrive Component)

A marker when permissions are paged.

Syntax

• C#
• VB.NET

public string PermissionMarker { get; set; }

Public Property PermissionMarker As String

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.

Permissions Property (GoogleDrive Component)

A collection of permissions.

Syntax

• C#
• VB.NET

public GDrivePermissionList Permissions { get; }

Public Property Permissions As GDrivePermissionList

Remarks

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

Calling ListPermissions will populate this collection.

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

This property is not available at design time.

Proxy Property (GoogleDrive Component)

A set of properties related to proxy access.

Syntax

• C#
• VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

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

QueryParams Property (GoogleDrive Component)

Additional query parameters to be included in the request.

Syntax

• C#
• VB.NET

public QueryParamList QueryParams { get; }

Public Property QueryParams As QueryParamList

Remarks

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

ResourceData Property (GoogleDrive Component)

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

Syntax

• C#
• VB.NET

public string ResourceData { get; set; }
public byte[] ResourceDataB { get; set; }

Public Property ResourceData As String
Public Property ResourceDataB As Byte()

Default Value

""

Remarks

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

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

This property is not available at design time.

ResourceMarker Property (GoogleDrive Component)

A marker indicating what page of resources to return next.

Syntax

• C#
• VB.NET

public string ResourceMarker { get; set; }

Public Property ResourceMarker As String

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.

Resources Property (GoogleDrive Component)

A collection of resources.

Syntax

• C#
• VB.NET

public GDriveResourceList Resources { get; }

Public Property Resources As GDriveResourceList

Remarks

This collection holds a list of file and folder resources.

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

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

This property is not available at design time.

ResumeURL Property (GoogleDrive Component)

The resumable upload URL.

Syntax

• C#
• VB.NET

public string ResumeURL { get; set; }

Public Property ResumeURL As String

Default Value

""

Remarks

This property holds the URL of the resumable upload session. This is populated by the component 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.

SharedDrive Property (GoogleDrive Component)

The shared drive to list file and folder resources for.

Syntax

• C#
• VB.NET

public string SharedDrive { get; set; }

Public Property SharedDrive As String

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.

SharedDriveMarker Property (GoogleDrive Component)

A marker when shared drives are paged.

Syntax

• C#
• VB.NET

public string SharedDriveMarker { get; set; }

Public Property SharedDriveMarker As String

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.

SharedDrives Property (GoogleDrive Component)

A collection of shared drives.

Syntax

• C#
• VB.NET

public GDriveSharedDriveList SharedDrives { get; }

Public ReadOnly Property SharedDrives As GDriveSharedDriveList

Remarks

This collection holds a list of shared drives.

Calling ListSharedDrives will populate this collection.

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

SSLAcceptServerCert Property (GoogleDrive Component)

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

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

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

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

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

SSLCert Property (GoogleDrive Component)

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

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

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

SSLProvider Property (GoogleDrive Component)

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

Syntax

• C#
• VB.NET

public GoogleDriveSSLProviders SSLProvider { get; set; }

enum GoogleDriveSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As GoogledriveSSLProviders

Enum GoogleDriveSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

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 component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

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

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

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (GoogleDrive Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

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

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

StartByte Property (GoogleDrive Component)

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

Syntax

• C#
• VB.NET

public long StartByte { get; set; }

Public Property StartByte As Long

Default Value

0

Remarks

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

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

This property is not available at design time.

Timeout Property (GoogleDrive Component)

The timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

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 component will wait for the operation to complete before returning control.

The component 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 component throws an exception.

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.

UseResumableUpload Property (GoogleDrive Component)

Whether to use resumable uploads.

Syntax

• C#
• VB.NET

public bool UseResumableUpload { get; set; }

Public Property UseResumableUpload As Boolean

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.

AddParents Method (GoogleDrive Component)

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

Syntax

• C#
• VB.NET

public void AddParents(string resourceId, string parentIds);

Async Version
public async Task AddParents(string resourceId, string parentIds);
public async Task AddParents(string resourceId, string parentIds, CancellationToken cancellationToken);

Public Sub AddParents(ByVal ResourceId As String, ByVal ParentIds As String)

Async Version
Public Sub AddParents(ByVal ResourceId As String, ByVal ParentIds As String) As Task
Public Sub AddParents(ByVal ResourceId As String, ByVal ParentIds As String, cancellationToken As CancellationToken) As Task

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 (GoogleDrive Component)

Adds a query parameter to the QueryParams properties.

Syntax

• C#
• VB.NET

public void AddQueryParam(string name, string value);

Async Version
public async Task AddQueryParam(string name, string value);
public async Task AddQueryParam(string name, string value, CancellationToken cancellationToken);

Public Sub AddQueryParam(ByVal Name As String, ByVal Value As String)

Async Version
Public Sub AddQueryParam(ByVal Name As String, ByVal Value As String) As Task
Public Sub AddQueryParam(ByVal Name As String, ByVal Value As String, cancellationToken As CancellationToken) As Task

Remarks

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

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

AddSharedDriveMember Method (GoogleDrive Component)

Creates a new shared drive member.

Syntax

• C#
• VB.NET

public string AddSharedDriveMember(string sharedDriveId, int role, int permissionType, string email);

Async Version
public async Task<string> AddSharedDriveMember(string sharedDriveId, int role, int permissionType, string email);
public async Task<string> AddSharedDriveMember(string sharedDriveId, int role, int permissionType, string email, CancellationToken cancellationToken);

Public Function AddSharedDriveMember(ByVal SharedDriveId As String, ByVal Role As Integer, ByVal PermissionType As Integer, ByVal Email As String) As String

Async Version
Public Function AddSharedDriveMember(ByVal SharedDriveId As String, ByVal Role As Integer, ByVal PermissionType As Integer, ByVal Email As String) As Task(Of String)
Public Function AddSharedDriveMember(ByVal SharedDriveId As String, ByVal Role As Integer, ByVal PermissionType As Integer, ByVal Email As String, cancellationToken As CancellationToken) As Task(Of String)

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 (GoogleDrive Component)

Get the authorization string required to access the protected resource.

Syntax

• C#
• VB.NET

public void Authorize();

Async Version
public async Task Authorize();
public async Task Authorize(CancellationToken cancellationToken);

Public Sub Authorize()

Async Version
Public Sub Authorize() As Task
Public Sub Authorize(cancellationToken As CancellationToken) As Task

Remarks

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

For more information, see the introduction section.

CalcAuthorization Method (GoogleDrive Component)

Calculates the Authorization header based on provided credentials.

Syntax

• C#
• VB.NET

public void CalcAuthorization();

Async Version
public async Task CalcAuthorization();
public async Task CalcAuthorization(CancellationToken cancellationToken);

Public Sub CalcAuthorization()

Async Version
Public Sub CalcAuthorization() As Task
Public Sub CalcAuthorization(cancellationToken As CancellationToken) As Task

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 component 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 (GoogleDrive Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 (GoogleDrive Component)

Copies a file.

Syntax

• C#
• VB.NET

public string CopyResource(string resourceId, string newName, string parentIds);

Async Version
public async Task<string> CopyResource(string resourceId, string newName, string parentIds);
public async Task<string> CopyResource(string resourceId, string newName, string parentIds, CancellationToken cancellationToken);

Public Function CopyResource(ByVal ResourceId As String, ByVal NewName As String, ByVal ParentIds As String) As String

Async Version
Public Function CopyResource(ByVal ResourceId As String, ByVal NewName As String, ByVal ParentIds As String) As Task(Of String)
Public Function CopyResource(ByVal ResourceId As String, ByVal NewName As String, ByVal ParentIds As String, cancellationToken As CancellationToken) As Task(Of String)

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 (GoogleDrive Component)

Creates a new folder.

Syntax

• C#
• VB.NET

public string CreateFolder(string name, string parentIds);

Async Version
public async Task<string> CreateFolder(string name, string parentIds);
public async Task<string> CreateFolder(string name, string parentIds, CancellationToken cancellationToken);

Public Function CreateFolder(ByVal Name As String, ByVal ParentIds As String) As String

Async Version
Public Function CreateFolder(ByVal Name As String, ByVal ParentIds As String) As Task(Of String)
Public Function CreateFolder(ByVal Name As String, ByVal ParentIds As String, cancellationToken As CancellationToken) As Task(Of String)

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 component will include the metadata held by the first item in the Resources collection 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 GDriveResource.Type field can be used to determine if a resource is a folder, a file, or a revision of a file.

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

CreateSharedDrive Method (GoogleDrive Component)

Creates a new shared drive.

Syntax

• C#
• VB.NET

public string CreateSharedDrive(string name, string requestId);

Async Version
public async Task<string> CreateSharedDrive(string name, string requestId);
public async Task<string> CreateSharedDrive(string name, string requestId, CancellationToken cancellationToken);

Public Function CreateSharedDrive(ByVal Name As String, ByVal RequestId As String) As String

Async Version
Public Function CreateSharedDrive(ByVal Name As String, ByVal RequestId As String) As Task(Of String)
Public Function CreateSharedDrive(ByVal Name As String, ByVal RequestId As String, cancellationToken As CancellationToken) As Task(Of String)

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 (GoogleDrive Component)

Deletes the specified file or folder permanently.

Syntax

• C#
• VB.NET

public void DeleteResource(string resourceId);

Async Version
public async Task DeleteResource(string resourceId);
public async Task DeleteResource(string resourceId, CancellationToken cancellationToken);

Public Sub DeleteResource(ByVal ResourceId As String)

Async Version
Public Sub DeleteResource(ByVal ResourceId As String) As Task
Public Sub DeleteResource(ByVal ResourceId As String, cancellationToken As CancellationToken) As Task

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 (GoogleDrive Component)

Deletes a shared drive.

Syntax

• C#
• VB.NET

public void DeleteSharedDrive(string sharedDriveId);

Async Version
public async Task DeleteSharedDrive(string sharedDriveId);
public async Task DeleteSharedDrive(string sharedDriveId, CancellationToken cancellationToken);

Public Sub DeleteSharedDrive(ByVal SharedDriveId As String)

Async Version
Public Sub DeleteSharedDrive(ByVal SharedDriveId As String) As Task
Public Sub DeleteSharedDrive(ByVal SharedDriveId As String, cancellationToken As CancellationToken) As Task

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 (GoogleDrive Component)

Downloads, and optionally converts, a file.

Syntax

• C#
• VB.NET

public void DownloadFile(string resourceId, string mimeType);

Async Version
public async Task DownloadFile(string resourceId, string mimeType);
public async Task DownloadFile(string resourceId, string mimeType, CancellationToken cancellationToken);

Public Sub DownloadFile(ByVal ResourceId As String, ByVal MimeType As String)

Async Version
Public Sub DownloadFile(ByVal ResourceId As String, ByVal MimeType As String) As Task
Public Sub DownloadFile(ByVal ResourceId As String, ByVal MimeType As String, cancellationToken As CancellationToken) As Task

Remarks

This method downloads the file specified by ResourceId.

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

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

Download Notes

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

Resuming Downloads

The component 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 component 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 (GoogleDrive Component)

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

Syntax

• C#
• VB.NET

public void EmptyTrash();

Async Version
public async Task EmptyTrash();
public async Task EmptyTrash(CancellationToken cancellationToken);

Public Sub EmptyTrash()

Async Version
Public Sub EmptyTrash() As Task
Public Sub EmptyTrash(cancellationToken As CancellationToken) As Task

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 (GoogleDrive Component)

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

Syntax

• C#
• VB.NET

public void GetAccountInfo();

Async Version
public async Task GetAccountInfo();
public async Task GetAccountInfo(CancellationToken cancellationToken);

Public Sub GetAccountInfo()

Async Version
Public Sub GetAccountInfo() As Task
Public Sub GetAccountInfo(cancellationToken As CancellationToken) As Task

Remarks

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

GetCurrentChangeMarker Method (GoogleDrive Component)

Gets the most current change marker.

Syntax

• C#
• VB.NET

public void GetCurrentChangeMarker();

Async Version
public async Task GetCurrentChangeMarker();
public async Task GetCurrentChangeMarker(CancellationToken cancellationToken);

Public Sub GetCurrentChangeMarker()

Async Version
Public Sub GetCurrentChangeMarker() As Task
Public Sub GetCurrentChangeMarker(cancellationToken As CancellationToken) As Task

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 (GoogleDrive Component)

Gets information about a specific permission.

Syntax

• C#
• VB.NET

public void GetPermissionInfo(string resourceId, string permissionId);

Async Version
public async Task GetPermissionInfo(string resourceId, string permissionId);
public async Task GetPermissionInfo(string resourceId, string permissionId, CancellationToken cancellationToken);

Public Sub GetPermissionInfo(ByVal ResourceId As String, ByVal PermissionId As String)

Async Version
Public Sub GetPermissionInfo(ByVal ResourceId As String, ByVal PermissionId As String) As Task
Public Sub GetPermissionInfo(ByVal ResourceId As String, ByVal PermissionId As String, cancellationToken As CancellationToken) As Task

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 collection (clearing any previously-held items in the process).

Shared Drive Members

GetResourceInfo Method (GoogleDrive Component)

Gets information about specific files and folders.

Syntax

• C#
• VB.NET

public void GetResourceInfo(string resourceIds);

Async Version
public async Task GetResourceInfo(string resourceIds);
public async Task GetResourceInfo(string resourceIds, CancellationToken cancellationToken);

Public Sub GetResourceInfo(ByVal ResourceIds As String)

Async Version
Public Sub GetResourceInfo(ByVal ResourceIds As String) As Task
Public Sub GetResourceInfo(ByVal ResourceIds As String, cancellationToken As CancellationToken) As Task

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 collection (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 (GoogleDrive Component)

Gets information about a specific shared drive.

Syntax

• C#
• VB.NET

public void GetSharedDriveInfo(string sharedDriveId);

Async Version
public async Task GetSharedDriveInfo(string sharedDriveId);
public async Task GetSharedDriveInfo(string sharedDriveId, CancellationToken cancellationToken);

Public Sub GetSharedDriveInfo(ByVal SharedDriveId As String)

Async Version
Public Sub GetSharedDriveInfo(ByVal SharedDriveId As String) As Task
Public Sub GetSharedDriveInfo(ByVal SharedDriveId As String, cancellationToken As CancellationToken) As Task

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 collection (clearing any previously-held items in the process).

GetUploadStatus Method (GoogleDrive Component)

Gets the status of a resumable upload session.

Syntax

• C#
• VB.NET

public void GetUploadStatus();

Async Version
public async Task GetUploadStatus();
public async Task GetUploadStatus(CancellationToken cancellationToken);

Public Sub GetUploadStatus()

Async Version
Public Sub GetUploadStatus() As Task
Public Sub GetUploadStatus(cancellationToken As CancellationToken) As Task

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 (GoogleDrive Component)

This method interrupts the current method.

Syntax

• C#
• VB.NET

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);

Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

Remarks

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

ListChanges Method (GoogleDrive Component)

Lists changes to resources and shared drives.

Syntax

• C#
• VB.NET

public void ListChanges();

Async Version
public async Task ListChanges();
public async Task ListChanges(CancellationToken cancellationToken);

Public Sub ListChanges()

Async Version
Public Sub ListChanges() As Task
Public Sub ListChanges(cancellationToken As CancellationToken) As Task

Remarks

This method lists changes to resources and shared drives.

General Usage

If there are still more changes available to list when this method returns, the ChangeMarker property will be populated. Continue to call this method until ChangeMarker is empty to accumulate all pages of results in the Changes collection. (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 collection every time a page of results is returned.

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

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

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

Shared Drive Functionality

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

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

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

ListChildren Method (GoogleDrive Component)

Lists the child resources of one or more folders.

Syntax

• C#
• VB.NET

public void ListChildren(string folderIds);

Async Version
public async Task ListChildren(string folderIds);
public async Task ListChildren(string folderIds, CancellationToken cancellationToken);

Public Sub ListChildren(ByVal FolderIds As String)

Async Version
Public Sub ListChildren(ByVal FolderIds As String) As Task
Public Sub ListChildren(ByVal FolderIds As String, cancellationToken As CancellationToken) As Task

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

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 collection. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Children collection 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 (GoogleDrive Component)

Lists the parent folders of a file or folder.

Syntax

• C#
• VB.NET

public void ListParents(string resourceId);

Async Version
public async Task ListParents(string resourceId);
public async Task ListParents(string resourceId, CancellationToken cancellationToken);

Public Sub ListParents(ByVal ResourceId As String)

Async Version
Public Sub ListParents(ByVal ResourceId As String) As Task
Public Sub ListParents(ByVal ResourceId As String, cancellationToken As CancellationToken) As Task

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 (GoogleDrive Component)

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

Syntax

• C#
• VB.NET

public void ListPermissions(string resourceId);

Async Version
public async Task ListPermissions(string resourceId);
public async Task ListPermissions(string resourceId, CancellationToken cancellationToken);

Public Sub ListPermissions(ByVal ResourceId As String)

Async Version
Public Sub ListPermissions(ByVal ResourceId As String) As Task
Public Sub ListPermissions(ByVal ResourceId As String, cancellationToken As CancellationToken) As Task

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

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 collection. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Permissions collection every time a page of results is returned. // PermissionList event handler. googledrive.OnPermissionList += (s, e) => { Console.WriteLine("Permission Id: " + e.Id); }; // List all of the permissions on the given resource. do { googledrive.ListPermissions("fdjhskdf89o3wi"); for (int i = 0; i < googledrive.Permissions.Count; i++) { // Process permissions here. } } while (!string.IsNullOrEmpty(googledrive.PermissionMarker));

Shared Drive Members

Shared Drive Capabilities

ListResources Method (GoogleDrive Component)

Lists files and folders.

Syntax

• C#
• VB.NET

public void ListResources();

Async Version
public async Task ListResources();
public async Task ListResources(CancellationToken cancellationToken);

Public Sub ListResources()

Async Version
Public Sub ListResources() As Task
Public Sub ListResources(cancellationToken As CancellationToken) As Task

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

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 collection. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Resources collection every time a page of results is returned.

Listing Resources

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

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

Result Scopes

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

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

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

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

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

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

How Shared Drives Work

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

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

ListRevisions Method (GoogleDrive Component)

List the revisions of a file.

Syntax

• C#
• VB.NET

public void ListRevisions(string fileId);

Async Version
public async Task ListRevisions(string fileId);
public async Task ListRevisions(string fileId, CancellationToken cancellationToken);

Public Sub ListRevisions(ByVal FileId As String)

Async Version
Public Sub ListRevisions(ByVal FileId As String) As Task
Public Sub ListRevisions(ByVal FileId As String, cancellationToken As CancellationToken) As Task

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 collection. The Revision ID will be help in the GDriveResource Id field.

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 (GoogleDrive Component)

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

Syntax

• C#
• VB.NET

public void ListSharedDrives();

Async Version
public async Task ListSharedDrives();
public async Task ListSharedDrives(CancellationToken cancellationToken);

Public Sub ListSharedDrives()

Async Version
Public Sub ListSharedDrives() As Task
Public Sub ListSharedDrives(cancellationToken As CancellationToken) As Task

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

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 collection. Alternatively, the AccumulatePages configuration setting can be disabled to clear the SharedDrives collection 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 (GoogleDrive Component)

Moves a file or folder.

Syntax

• C#
• VB.NET

public void MoveResource(string resourceId, string newParentIds);

Async Version
public async Task MoveResource(string resourceId, string newParentIds);
public async Task MoveResource(string resourceId, string newParentIds, CancellationToken cancellationToken);

Public Sub MoveResource(ByVal ResourceId As String, ByVal NewParentIds As String)

Async Version
Public Sub MoveResource(ByVal ResourceId As String, ByVal NewParentIds As String) As Task
Public Sub MoveResource(ByVal ResourceId As String, ByVal NewParentIds As String, cancellationToken As CancellationToken) As Task

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 (GoogleDrive Component)

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

Syntax

• C#
• VB.NET

public void RemoveParents(string resourceId, string parentIds);

Async Version
public async Task RemoveParents(string resourceId, string parentIds);
public async Task RemoveParents(string resourceId, string parentIds, CancellationToken cancellationToken);

Public Sub RemoveParents(ByVal ResourceId As String, ByVal ParentIds As String)

Async Version
Public Sub RemoveParents(ByVal ResourceId As String, ByVal ParentIds As String) As Task
Public Sub RemoveParents(ByVal ResourceId As String, ByVal ParentIds As String, cancellationToken As CancellationToken) As Task

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 (GoogleDrive Component)

Removes an existing shared drive member.

Syntax

• C#
• VB.NET

public void RemoveSharedDriveMember(string sharedDriveId, string permissionId);

Async Version
public async Task RemoveSharedDriveMember(string sharedDriveId, string permissionId);
public async Task RemoveSharedDriveMember(string sharedDriveId, string permissionId, CancellationToken cancellationToken);

Public Sub RemoveSharedDriveMember(ByVal SharedDriveId As String, ByVal PermissionId As String)

Async Version
Public Sub RemoveSharedDriveMember(ByVal SharedDriveId As String, ByVal PermissionId As String) As Task
Public Sub RemoveSharedDriveMember(ByVal SharedDriveId As String, ByVal PermissionId As String, cancellationToken As CancellationToken) As Task

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 (GoogleDrive Component)

Resets the component to its initial state.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

This method resets the component to its initial state.

RestoreResource Method (GoogleDrive Component)

Restores a file or folder from the trash.

Syntax

• C#
• VB.NET

public void RestoreResource(string resourceId);

Async Version
public async Task RestoreResource(string resourceId);
public async Task RestoreResource(string resourceId, CancellationToken cancellationToken);

Public Sub RestoreResource(ByVal ResourceId As String)

Async Version
Public Sub RestoreResource(ByVal ResourceId As String) As Task
Public Sub RestoreResource(ByVal ResourceId As String, cancellationToken As CancellationToken) As Task

Remarks

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

SendCustomRequest Method (GoogleDrive Component)

Sends a custom request to the Google Drive API.

Syntax

• C#
• VB.NET

public void SendCustomRequest(string httpMethod, string requestPath, string requestBody);

Async Version
public async Task SendCustomRequest(string httpMethod, string requestPath, string requestBody);
public async Task SendCustomRequest(string httpMethod, string requestPath, string requestBody, CancellationToken cancellationToken);

Public Sub SendCustomRequest(ByVal HttpMethod As String, ByVal RequestPath As String, ByVal RequestBody As String)

Async Version
Public Sub SendCustomRequest(ByVal HttpMethod As String, ByVal RequestPath As String, ByVal RequestBody As String) As Task
Public Sub SendCustomRequest(ByVal HttpMethod As String, ByVal RequestPath As String, ByVal RequestBody As String, cancellationToken As CancellationToken) As Task

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 component 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 collection 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 collection, and the response body in the stream specified using SetDownloadStream, the specified LocalFile, or ResourceData (using the same logic as DownloadFile).

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

SetDownloadStream Method (GoogleDrive Component)

Sets the stream to which downloaded data will be written.

Syntax

• C#
• VB.NET

public void SetDownloadStream(System.IO.Stream downloadStream);

Async Version
public async Task SetDownloadStream(System.IO.Stream downloadStream);
public async Task SetDownloadStream(System.IO.Stream downloadStream, CancellationToken cancellationToken);

Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream)

Async Version
Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream) As Task
Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

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

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

SetUploadStream Method (GoogleDrive Component)

Sets the stream from which data is read when uploading.

Syntax

• C#
• VB.NET

public void SetUploadStream(System.IO.Stream uploadStream);

Async Version
public async Task SetUploadStream(System.IO.Stream uploadStream);
public async Task SetUploadStream(System.IO.Stream uploadStream, CancellationToken cancellationToken);

Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream)

Async Version
Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream) As Task
Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

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

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

ToggleSharedDriveHidden Method (GoogleDrive Component)

Hides or unhides a shared drive.

Syntax

• C#
• VB.NET

public void ToggleSharedDriveHidden(string sharedDriveId, bool hidden);

Async Version
public async Task ToggleSharedDriveHidden(string sharedDriveId, bool hidden);
public async Task ToggleSharedDriveHidden(string sharedDriveId, bool hidden, CancellationToken cancellationToken);

Public Sub ToggleSharedDriveHidden(ByVal SharedDriveId As String, ByVal Hidden As Boolean)

Async Version
Public Sub ToggleSharedDriveHidden(ByVal SharedDriveId As String, ByVal Hidden As Boolean) As Task
Public Sub ToggleSharedDriveHidden(ByVal SharedDriveId As String, ByVal Hidden As Boolean, cancellationToken As CancellationToken) As Task

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 (GoogleDrive Component)

Moves the specified file or folder to the trash.

Syntax

• C#
• VB.NET

public void TrashResource(string resourceId);

Async Version
public async Task TrashResource(string resourceId);
public async Task TrashResource(string resourceId, CancellationToken cancellationToken);

Public Sub TrashResource(ByVal ResourceId As String)

Async Version
Public Sub TrashResource(ByVal ResourceId As String) As Task
Public Sub TrashResource(ByVal ResourceId As String, cancellationToken As CancellationToken) As Task

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 (GoogleDrive Component)

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

Syntax

• C#
• VB.NET

public void UpdatePermissions(string resourceId);

Async Version
public async Task UpdatePermissions(string resourceId);
public async Task UpdatePermissions(string resourceId, CancellationToken cancellationToken);

Public Sub UpdatePermissions(ByVal ResourceId As String)

Async Version
Public Sub UpdatePermissions(ByVal ResourceId As String) As Task
Public Sub UpdatePermissions(ByVal ResourceId As String, cancellationToken As CancellationToken) As Task

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 collection has a ModOp field which can be set to one of the following values:

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

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

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

Usage

To create new permissions, add new GDrivePermission items to the Permissions collection .

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

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

Transferring Ownership

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

Shared Drive Permissions

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

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

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

UpdateResource Method (GoogleDrive Component)

Updates a file or folder.

Syntax

• C#
• VB.NET

public void UpdateResource(string resourceId);

Async Version
public async Task UpdateResource(string resourceId);
public async Task UpdateResource(string resourceId, CancellationToken cancellationToken);

Public Sub UpdateResource(ByVal ResourceId As String)

Async Version
Public Sub UpdateResource(ByVal ResourceId As String) As Task
Public Sub UpdateResource(ByVal ResourceId As String, cancellationToken As CancellationToken) As Task

Remarks

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

Usage

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

UpdateSharedDrive Method (GoogleDrive Component)

Updates a shared drive.

Syntax

• C#
• VB.NET

public void UpdateSharedDrive(string sharedDriveId, string newName, int setRestrictions, int unsetRestrictions);

Async Version
public async Task UpdateSharedDrive(string sharedDriveId, string newName, int setRestrictions, int unsetRestrictions);
public async Task UpdateSharedDrive(string sharedDriveId, string newName, int setRestrictions, int unsetRestrictions, CancellationToken cancellationToken);

Public Sub UpdateSharedDrive(ByVal SharedDriveId As String, ByVal NewName As String, ByVal SetRestrictions As Integer, ByVal UnsetRestrictions As Integer)

Async Version
Public Sub UpdateSharedDrive(ByVal SharedDriveId As String, ByVal NewName As String, ByVal SetRestrictions As Integer, ByVal UnsetRestrictions As Integer) As Task
Public Sub UpdateSharedDrive(ByVal SharedDriveId As String, ByVal NewName As String, ByVal SetRestrictions As Integer, ByVal UnsetRestrictions As Integer, cancellationToken As CancellationToken) As Task

Remarks

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

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

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

Note that calls to this method will fail if:

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

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

UpdateSharedDriveMember Method (GoogleDrive Component)

Updates an existing shared drive member's role.

Syntax

• C#
• VB.NET

public void UpdateSharedDriveMember(string sharedDriveId, string permissionId, int role);

Async Version
public async Task UpdateSharedDriveMember(string sharedDriveId, string permissionId, int role);
public async Task UpdateSharedDriveMember(string sharedDriveId, string permissionId, int role, CancellationToken cancellationToken);

Public Sub UpdateSharedDriveMember(ByVal SharedDriveId As String, ByVal PermissionId As String, ByVal Role As Integer)

Async Version
Public Sub UpdateSharedDriveMember(ByVal SharedDriveId As String, ByVal PermissionId As String, ByVal Role As Integer) As Task
Public Sub UpdateSharedDriveMember(ByVal SharedDriveId As String, ByVal PermissionId As String, ByVal Role As Integer, cancellationToken As CancellationToken) As Task

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 (GoogleDrive Component)

Uploads, and optionally converts, a new file.

Syntax

• C#
• VB.NET

public string UploadFile(string fileName, string mimeType);

Async Version
public async Task<string> UploadFile(string fileName, string mimeType);
public async Task<string> UploadFile(string fileName, string mimeType, CancellationToken cancellationToken);

Public Function UploadFile(ByVal FileName As String, ByVal MimeType As String) As String

Async Version
Public Function UploadFile(ByVal FileName As String, ByVal MimeType As String) As Task(Of String)
Public Function UploadFile(ByVal FileName As String, ByVal MimeType As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

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

Usage

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

Before calling this method, always clear the Resources collection. Then, if you wish to set file metadata and/or assign parent Ids when the file is uploaded, add a new GDriveResource item to the collection and set the desired fields. (Note that the name and MIME type passed to this method will take precedence.)

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

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

Upload Notes

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

Simple

By default the component 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 component 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 component. 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 component 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 component is used, they should already be populated, and no special action should be needed). If uploading from a stream, be sure to reset its position to where it was the first time the upload was started (typically the beginning). Then call UploadFile again to resume the upload at the specified StartByte offset.

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

ChangeList Event (GoogleDrive Component)

Fires once for each change when ListChanges is called.

Syntax

• C#
• VB.NET

public event OnChangeListHandler OnChangeList;

public delegate void OnChangeListHandler(object sender, GoogleDriveChangeListEventArgs e);

public class GoogleDriveChangeListEventArgs : EventArgs {
  public string ResourceId { get; }
  public string SharedDriveId { get; }
  public bool Removed { get; }
  public string Time { get; }
  public int ChangeType { get; }
}

Public Event OnChangeList As OnChangeListHandler

Public Delegate Sub OnChangeListHandler(sender As Object, e As GoogleDriveChangeListEventArgs)

Public Class GoogleDriveChangeListEventArgs Inherits EventArgs
  Public ReadOnly Property ResourceId As String
  Public ReadOnly Property SharedDriveId As String
  Public ReadOnly Property Removed As Boolean
  Public ReadOnly Property Time As String
  Public ReadOnly Property ChangeType As Integer
End Class

Remarks

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

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

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

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

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

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

Refer to ListChanges for more information.

EndTransfer Event (GoogleDrive Component)

This event fires when a document finishes transferring.

Syntax

• C#
• VB.NET

public event OnEndTransferHandler OnEndTransfer;

public delegate void OnEndTransferHandler(object sender, GoogleDriveEndTransferEventArgs e);

public class GoogleDriveEndTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnEndTransfer As OnEndTransferHandler

Public Delegate Sub OnEndTransferHandler(sender As Object, e As GoogleDriveEndTransferEventArgs)

Public Class GoogleDriveEndTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

Remarks

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

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

Error Event (GoogleDrive Component)

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, GoogleDriveErrorEventArgs e);

public class GoogleDriveErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As GoogleDriveErrorEventArgs)

Public Class GoogleDriveErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

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

FragmentComplete Event (GoogleDrive Component)

Fires after each fragment of a resumable upload is completed.

Syntax

• C#
• VB.NET

public event OnFragmentCompleteHandler OnFragmentComplete;

public delegate void OnFragmentCompleteHandler(object sender, GoogleDriveFragmentCompleteEventArgs e);

public class GoogleDriveFragmentCompleteEventArgs : EventArgs {
  public int FragmentNumber { get; }
  public int FragmentCount { get; }
  public bool Interrupt { get; set; }
}

Public Event OnFragmentComplete As OnFragmentCompleteHandler

Public Delegate Sub OnFragmentCompleteHandler(sender As Object, e As GoogleDriveFragmentCompleteEventArgs)

Public Class GoogleDriveFragmentCompleteEventArgs Inherits EventArgs
  Public ReadOnly Property FragmentNumber As Integer
  Public ReadOnly Property FragmentCount As Integer
  Public Property Interrupt As Boolean
End Class

Remarks

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

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

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

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

Header Event (GoogleDrive Component)

Fired every time a header line comes in.

Syntax

• C#
• VB.NET

public event OnHeaderHandler OnHeader;

public delegate void OnHeaderHandler(object sender, GoogleDriveHeaderEventArgs e);

public class GoogleDriveHeaderEventArgs : EventArgs {
  public string Field { get; }
  public string Value { get; }
}

Public Event OnHeader As OnHeaderHandler

Public Delegate Sub OnHeaderHandler(sender As Object, e As GoogleDriveHeaderEventArgs)

Public Class GoogleDriveHeaderEventArgs Inherits EventArgs
  Public ReadOnly Property Field As String
  Public ReadOnly Property Value As String
End Class

Remarks

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

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

Log Event (GoogleDrive Component)

Fired once for each log message.

Syntax

• C#
• VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, GoogleDriveLogEventArgs e);

public class GoogleDriveLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As GoogleDriveLogEventArgs)

Public Class GoogleDriveLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

Remarks

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

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

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

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

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

Message is the log entry.

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

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

PermissionList Event (GoogleDrive Component)

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

Syntax

• C#
• VB.NET

public event OnPermissionListHandler OnPermissionList;

public delegate void OnPermissionListHandler(object sender, GoogleDrivePermissionListEventArgs e);

public class GoogleDrivePermissionListEventArgs : EventArgs {
  public string Id { get; }
  public int Role { get; }
  public int PermissionType { get; }
  public string Email { get; }
  public string Domain { get; }
  public bool AllowFileDiscovery { get; }
}

Public Event OnPermissionList As OnPermissionListHandler

Public Delegate Sub OnPermissionListHandler(sender As Object, e As GoogleDrivePermissionListEventArgs)

Public Class GoogleDrivePermissionListEventArgs Inherits EventArgs
  Public ReadOnly Property Id As String
  Public ReadOnly Property Role As Integer
  Public ReadOnly Property PermissionType As Integer
  Public ReadOnly Property Email As String
  Public ReadOnly Property Domain As String
  Public ReadOnly Property AllowFileDiscovery As Boolean
End Class

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 (GoogleDrive Component)

Fires during an upload or download to indicate transfer progress.

Syntax

• C#
• VB.NET

public event OnProgressHandler OnProgress;

public delegate void OnProgressHandler(object sender, GoogleDriveProgressEventArgs e);

public class GoogleDriveProgressEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public long TotalBytes { get; }
  public int PercentDone { get; }
}

Public Event OnProgress As OnProgressHandler

Public Delegate Sub OnProgressHandler(sender As Object, e As GoogleDriveProgressEventArgs)

Public Class GoogleDriveProgressEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property TotalBytes As Long
  Public ReadOnly Property PercentDone As Integer
End Class

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 component 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 component 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 (GoogleDrive Component)

Fires once for each resource returned when listing resources.

Syntax

• C#
• VB.NET

public event OnResourceListHandler OnResourceList;

public delegate void OnResourceListHandler(object sender, GoogleDriveResourceListEventArgs e);

public class GoogleDriveResourceListEventArgs : EventArgs {
  public string Id { get; }
  public string Name { get; }
  public string Extension { get; }
  public string Description { get; }
  public int ResourceType { get; }
  public string SharedDriveId { get; }
  public string CreatedTime { get; }
  public string ModifiedTime { get; }
  public long Size { get; }
  public bool Trashed { get; }
}

Public Event OnResourceList As OnResourceListHandler

Public Delegate Sub OnResourceListHandler(sender As Object, e As GoogleDriveResourceListEventArgs)

Public Class GoogleDriveResourceListEventArgs Inherits EventArgs
  Public ReadOnly Property Id As String
  Public ReadOnly Property Name As String
  Public ReadOnly Property Extension As String
  Public ReadOnly Property Description As String
  Public ReadOnly Property ResourceType As Integer
  Public ReadOnly Property SharedDriveId As String
  Public ReadOnly Property CreatedTime As String
  Public ReadOnly Property ModifiedTime As String
  Public ReadOnly Property Size As Long
  Public ReadOnly Property Trashed As Boolean
End Class

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 (GoogleDrive Component)

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

Syntax

• C#
• VB.NET

public event OnSharedDriveListHandler OnSharedDriveList;

public delegate void OnSharedDriveListHandler(object sender, GoogleDriveSharedDriveListEventArgs e);

public class GoogleDriveSharedDriveListEventArgs : EventArgs {
  public string Id { get; }
  public string Name { get; }
  public string CreatedTime { get; }
  public bool Hidden { get; }
  public int Capabilities { get; }
  public int Restrictions { get; }
}

Public Event OnSharedDriveList As OnSharedDriveListHandler

Public Delegate Sub OnSharedDriveListHandler(sender As Object, e As GoogleDriveSharedDriveListEventArgs)

Public Class GoogleDriveSharedDriveListEventArgs Inherits EventArgs
  Public ReadOnly Property Id As String
  Public ReadOnly Property Name As String
  Public ReadOnly Property CreatedTime As String
  Public ReadOnly Property Hidden As Boolean
  Public ReadOnly Property Capabilities As Integer
  Public ReadOnly Property Restrictions As Integer
End Class

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 (GoogleDrive Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, GoogleDriveSSLServerAuthenticationEventArgs e);

public class GoogleDriveSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As GoogleDriveSSLServerAuthenticationEventArgs)

Public Class GoogleDriveSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

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 (GoogleDrive Component)

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, GoogleDriveSSLStatusEventArgs e);

public class GoogleDriveSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As GoogleDriveSSLStatusEventArgs)

Public Class GoogleDriveSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

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

StartTransfer Event (GoogleDrive Component)

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

Syntax

• C#
• VB.NET

public event OnStartTransferHandler OnStartTransfer;

public delegate void OnStartTransferHandler(object sender, GoogleDriveStartTransferEventArgs e);

public class GoogleDriveStartTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnStartTransfer As OnStartTransferHandler

Public Delegate Sub OnStartTransferHandler(sender As Object, e As GoogleDriveStartTransferEventArgs)

Public Class GoogleDriveStartTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

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 (GoogleDrive Component)

Fired while a document transfers (delivers document).

Syntax

• C#
• VB.NET

public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, GoogleDriveTransferEventArgs e);

public class GoogleDriveTransferEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public int PercentDone { get; }
  public string Text { get; }
  public byte[] TextB { get; }
}

Public Event OnTransfer As OnTransferHandler

Public Delegate Sub OnTransferHandler(sender As Object, e As GoogleDriveTransferEventArgs)

Public Class GoogleDriveTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property PercentDone As Integer
  Public ReadOnly Property Text As String
  Public ReadOnly Property TextB As Byte()
End Class

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.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

• C#
• VB.NET