WebUpload Class

Properties   Methods   Events   Config Settings   Errors  

The WebUpload Class is used to upload files to RFC1867-compliant web servers.

Syntax

ipworks.webupload()

Remarks

The WebUpload Class supports both plaintext and SSL/TLS connections. When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method.

To use the class as a file upload client, provide the file names (paths) in the FileVars properties and optional form variables in the FormVars properties.

Then, set the URL property to the address of the page or script that accepts the files, and call the Upload method. Alternatively you can call the UploadTo method with URL as a parameter.

The UploadProgress event is fired during upload which shows the progress of the upload. The Transfer event shows the server response (normally an HTML page).

Property List

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

Method List

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

Event List

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

Config Settings

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

WebUpload.Accept Property

This property includes a list of acceptable MIME types for the request.

Syntax

getAccept(): string;
setAccept(accept: string): void;

Default Value

""

Remarks

If this property contains a nonempty string, an HTTP Accept header is added to the request.

The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.

WebUpload.Authorization Property

This property includes the Authorization string to be sent to the server.

Syntax

getAuthorization(): string;
setAuthorization(authorization: string): void;

Default Value

""

Remarks

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

WebUpload.AuthScheme Property

The authentication scheme to use when server authentication is required.

Syntax

getAuthScheme(): WebuploadAuthSchemes;
setAuthScheme(authScheme: WebuploadAuthSchemes): void;

enum WebuploadAuthSchemes {
  authBasic,
  authDigest,
  authProprietary,
  authNone,
  authNtlm,
  authNegotiate,
  authOAuth
}

Default Value

0

Remarks

This property will tell the class which type of authorization to perform when the User and Password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the User and Password properties are set, the class will attempt HTTP Basic Authentication. If AuthScheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token must be supplied through the Authorization property.

If AuthScheme is set to authOAuth (6), then the authorization string must be supplied through the Authorization property.

Note: If you set the Authorization property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme will be set automatically to authProprietary (2) by the class.

For security, changing the value of this property will cause the class to clear the values of User, Password, and Authorization.

WebUpload.Connected Property

This shows whether the class is connected.

Syntax

isConnected(): boolean;

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

WebUpload.ContentType Property

This property includes the content type for posts and puts.

Syntax

getContentType(): string;
setContentType(contentType: string): void;

Default Value

""

Remarks

If this property contains a nonempty string, a Content-Type HTTP request header is added to the request. The purpose of the header is to show the contents of the data during a Post or Put to the server.

The most common example is posting of HTML form input data. In that case, this property must be set to "application/x-www-form-urlencoded".

This property is not available at design time.

WebUpload.Cookies Property

This property includes a collection of cookies.

Syntax

getCookies(): HTTPCookieList;
setCookies(cookies: HTTPCookieList): void;

Default Value

Remarks

This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type HTTPCookie) to this collection.

To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies.

MaxHTTPCookies can be used to control the maximum number of cookies saved.

This property is not available at design time.

WebUpload.FileVars Property

File variables for the current request.

Syntax

getFileVars(): FileVarList;
setFileVars(fileVars: FileVarList): void;

Default Value

0

Remarks

This property describes the collection of files that are to be posted. The FileVars collection contains the variables as FileVar types, which contains fields describing these files.

Please refer to FormVars and FileVars for more information on form and file variables and how they are managed.

Example (Submit Post)

WebUploadControl.Reset() WebUploadControl.AddFormVar("formvarname1", "formvarvalue1") WebUploadControl.AddFileVar("filename1", "c:\filename1.txt") WebUploadControl.Upload() Example (Submit Post using FormVar Arrays) WebUploadControl.Reset() WebUploadControl.FormVarCount = 1 WebUploadControl.FormVarName(0) = "formvarname1" WebUploadControl.FormVarValue(0) = "formvarvalue1" WebUploadControl.FileVarCount = 1 WebUploadControl.FileVarName(0) = "filename1" WebUploadControl.FileVarValue(0) = "C:\filename1.txt" WebUploadControl.UploadTo(url)

This property is not available at design time.

WebUpload.Firewall Property

A set of properties related to firewall access.

Syntax

getFirewall(): Firewall;
setFirewall(firewall: Firewall): void;

Default Value

Remarks

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

WebUpload.FollowRedirects Property

This property determines what happens when the server issues a redirect.

Syntax

getFollowRedirects(): WebuploadFollowRedirects;
setFollowRedirects(followRedirects: WebuploadFollowRedirects): void;

enum WebuploadFollowRedirects {
  frNever,
  frAlways,
  frSameScheme
}

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new URL for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same; otherwise, the class .

Note: Following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the class instead.

WebUpload.FormVars Property

Form variables for the current request.

Syntax

getFormVars(): FormVarList;
setFormVars(formVars: FormVarList): void;

Default Value

0

Remarks

This property contains form variables that are to be posted with the current request. The FormVars collection contains the variables as FormVar types, which contains fields describing these variables.

This property is not available at design time.

WebUpload.From Property

This property includes the email address of the HTTP agent (optional).

Syntax

getFrom(): string;
setFrom(from: string): void;

Default Value

""

Remarks

This property contains the email address of the HTTP agent (optional). If it contains a nonempty string, an HTTP From: header is added to the request. This header generally gives the email address of the requester of the document.

This property is not available at design time.

WebUpload.Idle Property

The current status of the class.

Syntax

isIdle(): boolean;

Default Value

TRUE

Remarks

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

This property is read-only.

WebUpload.LocalFile Property

This property includes the path to a local file for downloading. If the file exists, it is overwritten.

Syntax

getLocalFile(): string;
setLocalFile(localFile: string): void;

Default Value

""

Remarks

This property is used when getting a document.

If this property is empty, then the received data are provided through TransferredData and the Transfer event.

WebUpload.LocalHost Property

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

Syntax

getLocalHost(): string;
setLocalHost(localHost: string): void;

Default Value

""

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed 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.

WebUpload.OtherHeaders Property

This property includes other headers as determined by the user (optional).

Syntax

getOtherHeaders(): string;
setOtherHeaders(otherHeaders: string): void;

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 .

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

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

This property is not available at design time.

WebUpload.ParsedHeaders Property

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

Syntax

getParsedHeaders(): HeaderList;

Default Value

Remarks

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

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

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

WebUpload.Password Property

This property includes a password if authentication is to be used.

Syntax

getPassword(): string;
setPassword(password: string): void;

Default Value

""

Remarks

This property contains a password if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the class will attempt to authenticate using the current user's credentials.

WebUpload.Proxy Property

A set of properties related to proxy access.

Syntax

getProxy(): Proxy;
setProxy(proxy: Proxy): void;

Default Value

Remarks

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

WebUpload.Referer Property

This property includes the referer URL/document (optional).

Syntax

getReferer(): string;
setReferer(referer: string): void;

Default Value

""

Remarks

If this property contains a nonempty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

This property is not available at design time.

WebUpload.SSLAcceptServerCert Property

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

Syntax

getSSLAcceptServerCert(): Certificate;
setSSLAcceptServerCert(SSLAcceptServerCert: Certificate): void;

Default Value

Remarks

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

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

Please note that this functionality is provided only for cases where 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.

WebUpload.SSLCert Property

The certificate to be used during SSL negotiation.

Syntax

getSSLCert(): Certificate;
setSSLCert(SSLCert: Certificate): void;

Default Value

Remarks

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

WebUpload.SSLProvider Property

This specifies the SSL/TLS implementation to use.

Syntax

getSSLProvider(): WebuploadSSLProviders;
setSSLProvider(SSLProvider: WebuploadSSLProviders): void;

enum WebuploadSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Default Value

0

Remarks

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

Possible values are:

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

When Automatic is selected the platform implementation will be used by default in all cases in the JavaScript edition.

Note: The Internal provider is not support at this time.

WebUpload.SSLServerCert Property

The server certificate for the last established connection.

Syntax

getSSLServerCert(): Certificate;

Default Value

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

WebUpload.StatusLine Property

This property is the first line of the last server response.

Syntax

getStatusLine(): string;

Default Value

""

Remarks

This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the class, the error string is the same as the StatusLine property.

The HTTP protocol specifies the structure of the StatusLine as follows: [HTTP version] [Result Code] [Description].

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

WebUpload.Timeout Property

A timeout for the class.

Syntax

getTimeout(): number;
setTimeout(timeout: number): void;

Default Value

60

Remarks

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

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

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

If Timeout expires, and the operation is not yet complete, the class .

Please note that by default, all timeouts are inactivity timeouts, i.e. 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.

WebUpload.TransferredData Property

This property includes the contents of the last response from the server.

Syntax

getTransferredData(): Uint8Array;

Default Value

""

Remarks

This property contains the contents of the last response from the server. If the LocalFile is empty, the data are accumulated in TransferredData and also can be received in the Transfer event. Otherwise, this property returns an empty string.

TransferredDataLimit controls the maximum amount of data accumulated in TransferredData (by default there is no limit).

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

WebUpload.TransferredDataLimit Property

This property specifies the the maximum amount of data to be transferred.

Syntax

getTransferredDataLimit(): number;
setTransferredDataLimit(transferredDataLimit: number): void;

Default Value

0

Remarks

This property contains the maximum amount of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the TransferredData property.

WebUpload.TransferredHeaders Property

This property includes the full set of headers as received from the server.

Syntax

getTransferredHeaders(): string;

Default Value

""

Remarks

This property returns the complete set of raw headers as received from the server.

The Header event shows the individual headers as parsed by the class.

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

WebUpload.URL Property

The URL to post information to.

Syntax

getURL(): string;
setURL(URL: string): void;

Default Value

""

Remarks

This property specifies the web page to post the files and form data to. It is the same as the value specified by '<FORM ACTION=...>' in HTML forms.

This property must be set before calling the Upload method.

WebUpload.User Property

This property includes a user name if authentication is to be used.

Syntax

getUser(): string;
setUser(user: string): void;

Default Value

""

Remarks

This property contains a user name if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM, and User and Password are empty, the class will attempt to authenticate using the current user's credentials.

WebUpload.addCookie Method

This method adds a cookie and the corresponding value to the outgoing request headers.

Syntax

async webupload.addCookie(cookieName : string, cookieValue : string): Promise<void>

Remarks

This property adds a cookie and the corresponding value to the outgoing request headers. Please refer to the Cookies property for more information on cookies and how they are managed.

WebUpload.addFileVar Method

Adds a file variable and the corresponding file name.

Syntax

async webupload.addFileVar(fileVar : string, fileName : string): Promise<void>

Remarks

Please refer to the FileVars properties for more information on file variables and how they are managed.

WebUpload.addFormVar Method

Adds a form variable and the corresponding value.

Syntax

async webupload.addFormVar(varName : string, varValue : string): Promise<void>

Remarks

Please refer to FormVars and FileVars for more information on form and file variables and how they are managed.

Example (Submit Post)

WebUploadControl.Reset() WebUploadControl.AddFormVar("formvarname1", "formvarvalue1") WebUploadControl.AddFileVar("filename1", "c:\filename1.txt") WebUploadControl.Upload() Example (Submit Post using FormVar Arrays) WebUploadControl.Reset() WebUploadControl.FormVarCount = 1 WebUploadControl.FormVarName(0) = "formvarname1" WebUploadControl.FormVarValue(0) = "formvarvalue1" WebUploadControl.FileVarCount = 1 WebUploadControl.FileVarName(0) = "filename1" WebUploadControl.FileVarValue(0) = "C:\filename1.txt" WebUploadControl.UploadTo(url)

WebUpload.config Method

Sets or retrieves a configuration setting.

Syntax

async webupload.config(configurationString : string): Promise<string>

Remarks

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

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

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

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

WebUpload.doEvents Method

Processes events from the internal message queue.

Syntax

async webupload.doEvents(): Promise<void>

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

WebUpload.interrupt Method

Interrupt the current method.

Syntax

async webupload.interrupt(): Promise<void>

Remarks

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

WebUpload.reset Method

Reset the class.

Syntax

async webupload.reset(): Promise<void>

Remarks

Calling Reset sets all HTTP headers to their default values and clears all form variables and file names.

WebUpload.upload Method

Posts data to the URL specified by URL .

Syntax

async webupload.upload(): Promise<void>

Remarks

Sends a post request to the URL with the variables and files provided in the FileVars properties. Please refer to FormVars and FileVars for more information on form and file variables and how they are managed.

Example (Submit Post)

WebUploadControl.Reset() WebUploadControl.AddFormVar("formvarname1", "formvarvalue1") WebUploadControl.AddFileVar("filename1", "c:\filename1.txt") WebUploadControl.Upload() Example (Submit Post using FormVar Arrays) WebUploadControl.Reset() WebUploadControl.FormVarCount = 1 WebUploadControl.FormVarName(0) = "formvarname1" WebUploadControl.FormVarValue(0) = "formvarvalue1" WebUploadControl.FileVarCount = 1 WebUploadControl.FileVarName(0) = "filename1" WebUploadControl.FileVarValue(0) = "C:\filename1.txt" WebUploadControl.UploadTo(url)

WebUpload.uploadTo Method

Posts data to the URL specified by the 'URL' parameter.

Syntax

async webupload.uploadTo(URL : string): Promise<void>

Remarks

Sends a post request to 'URL' with the variables and files provided in the FileVars properties.

Calling this method is equivalent to setting the URL property to URL and then calling Upload. Please refer to FormVars and FileVars for more information on form and file variables and how they are managed.

Example (Submit Post)

WebUploadControl.Reset() WebUploadControl.AddFormVar("formvarname1", "formvarvalue1") WebUploadControl.AddFileVar("filename1", "c:\filename1.txt") WebUploadControl.Upload() Example (Submit Post using FormVar Arrays) WebUploadControl.Reset() WebUploadControl.FormVarCount = 1 WebUploadControl.FormVarName(0) = "formvarname1" WebUploadControl.FormVarValue(0) = "formvarvalue1" WebUploadControl.FileVarCount = 1 WebUploadControl.FileVarName(0) = "filename1" WebUploadControl.FileVarValue(0) = "C:\filename1.txt" WebUploadControl.UploadTo(url)

WebUpload.Connected Event

This event is fired immediately after a connection completes (or fails).

Syntax

webupload.on('Connected', listener: (e: {readonly statusCode: number, readonly description: string}) => void )

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

WebUpload.ConnectionStatus Event

This event is fired to indicate changes in the connection state.

Syntax

webupload.on('ConnectionStatus', listener: (e: {readonly connectionEvent: string, readonly statusCode: number, readonly description: string}) => void )

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

WebUpload.Disconnected Event

This event is fired when a connection is closed.

Syntax

webupload.on('Disconnected', listener: (e: {readonly statusCode: number, readonly description: string}) => void )

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

WebUpload.EndTransfer Event

Fired when a document finishes transferring.

Syntax

webupload.on('EndTransfer', listener: (e: {readonly direction: number}) => void )

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.

WebUpload.Error Event

Fired when information is available about errors during data delivery.

Syntax

webupload.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

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

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.

WebUpload.Header Event

This event is fired every time a header line comes in.

Syntax

webupload.on('Header', listener: (e: {readonly field: string, readonly value: string}) => void )

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

WebUpload.Log Event

This event fires once for each log message.

Syntax

webupload.on('Log', listener: (e: {readonly logLevel: number, readonly message: string, readonly logType: string}) => void )

Remarks

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

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

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

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

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

Message is the log entry.

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

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

WebUpload.Redirect Event

This event is fired when a redirection is received from the server.

Syntax

webupload.on('Redirect', listener: (e: {readonly location: string, accept: boolean}) => void )

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the class . Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

WebUpload.SetCookie Event

This event is fired for every cookie set by the server.

Syntax

webupload.on('SetCookie', listener: (e: {readonly name: string, readonly value: string, readonly expires: string, readonly domain: string, readonly path: string, readonly secure: boolean}) => void )

Remarks

The SetCookie event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

WebUpload.SSLServerAuthentication Event

Fired after the server presents its certificate to the client.

Syntax

webupload.on('SSLServerAuthentication', listener: (e: {readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void )

Remarks

This event fires with information about the server certificate. The Status property shows why verification failed (otherwise, Status contains the string OK). To manually accept an untrusted certificate, the SSLAcceptAnyServerCert setting must be set to True before initiating the connection.

WebUpload.SSLStatus Event

Fired when secure connection progress messages are available.

Syntax

webupload.on('SSLStatus', listener: (e: {readonly message: string}) => void )

Remarks

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

WebUpload.StartTransfer Event

Fired when a document starts transferring (after the headers).

Syntax

webupload.on('StartTransfer', listener: (e: {readonly direction: number}) => void )

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.

WebUpload.Status Event

This event is fired when the HTTP status line is received from the server.

Syntax

webupload.on('Status', listener: (e: {readonly HTTPVersion: string, readonly statusCode: number, readonly description: string}) => void )

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").

StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").

WebUpload.Transfer Event

This event is fired while a document transfers (delivers document).

Syntax

webupload.on('Transfer', listener: (e: {readonly direction: number, readonly bytesTransferred: number, readonly percentDone: number, readonly text: string, readonly textB: Uint8Array}) => void )

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.

WebUpload.UploadProgress Event

Fired while the class is uploading files to the URL .

Syntax

webupload.on('UploadProgress', listener: (e: {readonly percentDone: number}) => void )

Remarks

The PercentDone parameter shows the progress of the upload. The event is fired at least once at the beginning of the transfer, and once at the end of the transfer. The respective values for PercentDone are 0 and 100.

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

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate(String certificateFile);

Opens CertificateFile and reads out the contents as an X.509 public key.

public Certificate(byte[] certificateData);

Parses CertificateData as an X.509 public key.

public Certificate(int certStoreType, String store, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

FileVar Type

This is the file variable for the current request.

Remarks

This type describes a file that is to be posted when an upload action is performed. The type contains fields that describe this variable's name and the filename of the file being uploaded.

Fields

Constructors

public FileVar();

public FileVar(String name, String file);

public FileVar(String name, byte[] inputData);

Firewall Type

The firewall the class will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .

Fields

Constructors

public Firewall();

FormVar Type

This is the form variable for the current request.

Remarks

This type describes a form variable that is to be posted to the URL when an upload action is performed. The type contains fields that describe this variable's name and value.

Fields

Constructors

public FormVar();

public FormVar(String name, String value);

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a , and its corresponding .

Fields

Constructors

public Header();

public Header(String field, String value);

HTTPCookie Type

An HTTP cookie can be either sent to or received from the server.

Remarks

An HTTP cookie can store the cookies that are to be sent to the server. It also may store the cookies sent by the server.

Cookies that are to be sent to the server must have the and fields supplied before submitting the URL. When the SetCookie event is fired, however, all of the fields of an HTTPCookie are filled out accordingly.

Fields

Constructors

public HTTPCookie();

public HTTPCookie(String name, String value);

Proxy Type

The proxy the class will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the .

Fields

Constructors

public Proxy();

public Proxy(String server, int port);

public Proxy(String server, int port, String user, String password);

Config Settings (class ipworks.webupload)

Webupload Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (class ipworks.webupload)

WebUpload Errors

MIME Errors

HTTP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors