Click or drag to resize

CrestronFileTransferClient Class

FileTransferClient class is a File Transfer Class.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpCrestronFileTransferClient

Namespace: Crestron.SimplSharp
Assembly: SimplSharpHelperInterface (in SimplSharpHelperInterface.dll) Version: 2.21.121
Syntax
C#
public class CrestronFileTransferClient : IDisposable

The CrestronFileTransferClient type exposes the following members.

Constructors
 NameDescription
Public methodCrestronFileTransferClient The constructor of FileTransferClient class.
Top
Properties
 NameDescription
Public propertyDefaultAsyncWaitTime The default to wait on an Async Operation
Top
Methods
 NameDescription
Public methodAbort Aborts current blocking operation asynchronously
Public methodClose Shut down the Client process
Public methodDispose Destroys the Client
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize The destructor of FileTransferClient class.
(Overrides ObjectFinalize)
Public methodGetEffectiveUrl Gets the effective URL the client connects to
Public methodGetFile Retrieves the remote file pointed by URL. This method directly uses the URL supplied. The URL is retrieved to the destination (localPath) file. Port number can be embedded into URL. Some examples of valid URL prefixed with the specified protocol - http://host.com/myPath/MyFile.txt, https://host.com/myPath/MyFile.txt, ftp://host.com:21/myPath/MyFile.txt, etc.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetLastClientError Retrieves last client's internal error occurred (effective when one of the methods returned error code = 1).
Public methodGetLastClientStrError Gets a string describing the last error that occurred
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodPostFile Uploads local file to the remote destination pointed by URL.
Public methodPutFile Uploads local file to the remote destination pointed by URL. This method directly uses the URL supplied. Port number can be embedded into URL. Some examples of valid URL prefixed with the specified protocol - http://host.com/myPath/MyFile.txt, https://host.com/myPath/MyFile.txt, ftp://host.com:21/myPath/MyFile.txt, etc.
Public methodSetAddressScope(Int32) Set the Scope ID for IPv6 addresses
Public methodSetAddressScope(String) Set the Scope ID for IPv6 addresses by interface's name
Public methodSetCACertificate Sets the file holding one or more certificates to verify the peer with.
Public methodSetCAPath Sets the path holding one or more certificates to verify the peer with.
Public methodSetExtraVerbose Set option to enable/disable client's Extra debug output to the console.
Public methodSetHeader Set custom headers
Public methodSetHostVerification Set option to enable/disable host name verification.
Public methodSetHttpAuthMethod Sets HTTP server authentication methods to try.
Public methodSetIncludeHeaders Set option to enable/disable the include of headers in the response.
Public methodSetIPResolve Set IP protocol version to use
Public methodSetKeepAlive Set option to enable/disable feature preventing the client's connection from timing out.
Public methodSetPassword Sets the password to be used in protocol authentication.
Public methodSetPeerVerification Set option to enable/disable verification of the peer's certificate.
Public methodSetPostFieldSize(Int32) Set the size of the field to post
Public methodSetPostFieldSize(Int64) Set the size of the field to post
Public methodSetProgressCallBack Sets the callback info to receive a progress feedback from the client while uploading/downloading
Public methodSetProxy Sets the proxy's name or IP address.
Public methodSetProxyAuthMethod Sets HTTP proxy server authentication methods to try.
Public methodSetProxyPassword Sets the password to use for the transfer while connecting to the proxy.
Public methodSetProxyPort Sets the proxy port to use (e.g. 80, 1080, etc).
Public methodSetProxyType Sets the proxy type to use (e.g. HTTP, SOCKS5, etc).
Public methodSetProxyUserName Sets the user name to use for the transfer while connecting to the proxy.
Public methodSetSslVersion Set the ssl version
Public methodSetTimeout Set option for connection timeout.
Public methodSetUserName Sets the user name to be used in protocol authentication.
Public methodSetVerbose Set option to enable/disable client's debug output to the console.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also