Cloud Storage Integrator - Online Help
Cloud Storage Integrator
Questions / Feedback?

GoogleDrive Component

Properties   Methods   Events   Configuration Settings   Errors  

The GDrive component provides easy file and folder management.

Syntax

TicsGoogleDrive

Remarks

GDrive allows quick and simple management of files and folders stored in Google Drive.

To upload a file, simply call UploadFile and specify the file you wish to upload. To list files and folders, call ListResources. Resources are described by the Resource* properties. Setting ResourceIndex selects a specific resource and allows you to inspect the related properties.

Call DownloadFile to download a file. Other file and folder management functions include CreateFolder, CopyResource, DeleteResource, MoveToTrash, RestoreFromTrash, UpdateResource, and more.

In addition you can modify permissions and child-parent relationships. Please see the Methods section of the documentation for a full list of supported methods.

This service supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth component or a separate process. Once complete you should have an authorization string which looks like:

Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQ
Assign this value to the Authorization property before attempting any operations. Consult the Google documentation for this particular service for more information about supported scope values and more details on OAuth authentication.

Property List


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

AuthorizationOAuth 2.0 Authorization Token.
ChangeMarkerA marker when changes are paged.
ChangeCountThe number of records in the Change arrays.
ChangeDeletedWhether the file is deleted.
ChangeIdThe Id of the change.
ChangeResourceIdThe Id of the file to which the change applies.
ChildMarkerA marker when children are paged.
ConvertDocumentWhether to convert a document when uploading.
CookieCountThe number of records in the Cookie arrays.
CookieDomainThe domain of a received cookie.
CookieExpirationThis property contains an expiration time for the cookie (if provided by the server).
CookieNameThe name of the cookie.
CookiePathThis property contains a path name to limit the cookie to (if provided by the server).
CookieSecureThis property contains the security flag of the received cookie.
CookieValueThis property contains the value of the cookie.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdleThe current status of the component.
LocalFileThe location of the local file.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
OtherHeadersOther headers as determined by the user (optional).
OverwriteDetermines if local files are overwritten.
ParsedHeaderCountThe number of records in the ParsedHeader arrays.
ParsedHeaderFieldThis property contains the name of the HTTP header (same case as it is delivered).
ParsedHeaderValueThis property contains the header contents.
PermissionAdditionalRolesAdditional roles.
PermissionCountThe number of permissions for the file.
PermissionETagThe ETag of the permission.
PermissionIdThe Id of the permission.
PermissionIndexSpecifies the permission.
PermissionMarkerA marker when permissions are paged.
PermissionRoleThe role specified for the permission.
PermissionTypeThe type entity to which the permission applies.
PermissionValueThe value for the permission type.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
QueryParamsCountThe number of records in the QueryParams arrays.
QueryParamsNameThis property contains the name of the parameter to be used in a Query request.
QueryParamsValueThis property contains the value of the parameter to be used in a Query request.
ResourceChildCountThe number of records in the ResourceChild arrays.
ResourceChildIdThe Id of the child file or folder.
ResourceChildLinkThe Link of the child resource.
ResourceCountThe number of files and folders.
ResourceCreatedDateThe creation date of the file or folder.
ResourceDataHolds the file data after downloading or sets the file data before uploading or updating.
ResourceDescriptionA short description of the file or folder.
ResourceETagThe ETag of the resource.
ResourceExtensionThe extension of the file.
ResourceFormatsA comma separated list of file formats.
ResourceIdThe Id of the resource.
ResourceIndexSelects the file or folder.
ResourceMarkerA marker when resources are paged.
ResourceMD5ChecksumThe MD5 checksum of the file.
ResourceMIMETypeThe MIME type of the file.
ResourceModifiedDateThe modified date of the resource.
ResourceOriginalNameThe original name of the file.
ResourceOwnersA comma separated list of owners.
ResourceParentCountThe number of records in the ResourceParent arrays.
ResourceParentIdThe Id of the parent folder.
ResourceParentRootWhether the parent folder is the root folder.
ResourceRestrictedWhether the file is restricted.
ResourceSizeThe size of the file in bytes.
ResourceStarredWhether the resource is starred.
ResourceTitleThe title of the file or folder.
ResourceTrashedWhether the resource is in the trash.
ResourceTypeIndicates whether the current entry is a folder or a file.
ResourceViewedWhether the resource has been viewed.
ResumeURLThe URL for the resumable upload.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
StartByteThe byte offset from which to start the upload or download.
TimeoutA timeout for the component.
UseResumableUploadWhether to use resumable uploads.
XChildrenCountThe number of records in the XChild arrays.
XChildNameThe Name property provides the local name of the element.
XChildXTextThis property contains the inner text of the element.
XElementThe name of the current element.
XParentThe parent of the current element.
XPathProvides a way to point to a specific element in the response.
XSubTreeA snapshot of the current element in the document.
XTextThe text of the current element.

Method List


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

AddChildAdds a child file or folder to a parent folder.
AddParentAdds a parent folder for a file or folder.
AddPermissionAdds a permission to the specified file or folder.
AddQueryParamAdds a query parameter to the QueryParams properties.
ConfigSets or retrieves a configuration setting .
CopyResourceCopies a file.
CreateFolderThis method creates a new folder.
DeleteChildDeletes a child from a folder.
DeleteParentDeletes the parent from a file or folder.
DeletePermissionDeletes the specified permission.
DeleteResourceDeletes the specified file or folder.
DownloadFileDownloads the currently selected file.
GetResourceInfoThis method retrieves information about the file.
GetUploadStatusGet the status of a resumable upload session.
InterruptInterrupt the current method.
ListChangesLists changes for a user.
ListChildrenLists children of the current folder.
ListParentsLists the current file or folder parents.
ListPermissionsLists the permissions for the specified file or folder.
ListResourcesLists the files and folders for the current user.
MoveToTrashMoves the selected file or folder to the trash.
RestoreFromTrashRestores a file or folder from trash.
UpdatePermissionUpdate the permissions on a file or folder.
UpdateResourceUpdates a file or folder.
UploadFileUploads a new file.

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.

ChangeListThis event fires once for each change when ListChanges is called.
ChildListFires once for each child when calling ListChildren.
ConnectedFired immediately after a connection completes (or fails).
DisconnectedFired when a connection is closed.
EndTransferFired when a document finishes transferring.
ErrorInformation about errors during data delivery.
FragmentCompleteThis event fires after each fragment of a resumable upload is completed.
HeaderFired every time a header line comes in.
ParentListThis event fires once for each parent returned when calling ListParents.
PermissionListThis event fires once for each permission returned when calling ListPermissions.
ResourceListFires once for each resource when ListResources is called.
SetCookieFired for every cookie set by the server.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when a document starts transferring (after the headers).
StatusFired when the HTTP status line is received from the server.
TransferFired while a document transfers (delivers document).

Configuration Settings


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

PermissionNameThe name of the permission.
PermissionAuthKeyThe auth key of the permission.
IncludeFilesWhether files are included when calling ListResources.
IncludeFoldersWhether folders are included when calling ListResources.
IncludeFolderPropertiesWhether Resource properties apply when calling CreateFolder.
ListOnlyRootItemsWhether to list only resources in the root folder.
MaxResultsLimits the number of results.
EncryptionIVThe initialization vector to be used for encryption/decryption.
EncryptionKeyThe key to use during encryption/decryption.
FragmentSizeThe fragment size.
DownloadTempFileThe temporary file used when downloading encrypted data.
TempPathThe path to the directory where temporary files are created.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 1.0.6240.0