WebForm Class
Properties Methods Events Configuration Settings Errors
The WebForm Class is used to POST data to interactive web pages or scripts (CGI, ASP, etc.), similar to what HTML forms do.
Syntax
IPWorksWebForm
IPWorksWebFormSwift
Remarks
The WebForm 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.
The inputs to the script are provided through the FormVars properties. Once the inputs are defined, set the URL property to the address of the script and call the Submit method. Alternatively, you may call the SubmitTo method with URL as the parameter.
The output of the page or script is provided via the Transfer event.
The Encoding property allows you to specify the proper encoding for the form input (this is normally 'urlencoding').
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| - accept | A list of acceptable MIME types for the request. |
| - authorization | The Authorization string to be sent to the server. |
| - authScheme | The authentication scheme to use when server authorization is required. |
| - connected | Shows whether the class is connected. |
| - contentType | Content type for posts and puts. |
| - cookieCount | The number of records in the Cookie arrays. |
| - cookieDomain:(int)cookieIndex | The domain of a received cookie. |
| - cookieExpiration:(int)cookieIndex | This property contains an expiration time for the cookie (if provided by the server). |
| - cookieName:(int)cookieIndex | The name of the cookie. |
| - cookiePath:(int)cookieIndex | This property contains a path name to limit the cookie to (if provided by the server). |
| - cookieSecure:(int)cookieIndex | This property contains the security flag of the received cookie. |
| - cookieValue:(int)cookieIndex | This property contains the value of the cookie. |
| - encoding | The encoding type for the form data. |
| - firewallAutoDetect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
| - firewallType | This property determines the type of firewall to connect through. |
| - firewallHost | This property contains the name or IP address of firewall (optional). |
| - firewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
| - firewallPort | This property contains the TCP port for the firewall Host . |
| - firewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
| - followRedirects | Determines what happens when the server issues a redirect. |
| - formVarCount | The number of records in the FormVar arrays. |
| - formVarContentType:(int)varIndex | This property specifies the Content-Type header for a Form Variable. |
| - formVarName:(int)varIndex | This property contains the form variable name for the current request. |
| - formVarValue:(int)varIndex | This property contains the form variable value for the current request. |
| - from | The email address of the HTTP agent (optional). |
| - idle | The current status of the class. |
| - localFile | The path to a local file for downloading. If the file exists, it is overwritten. |
| - localHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| - otherHeaders | Other headers as determined by the user (optional). |
| - parsedHeaderCount | The number of records in the ParsedHeader arrays. |
| - parsedHeaderField:(int)parsedHeaderIndex | This property contains the name of the HTTP header (same case as it is delivered). |
| - parsedHeaderValue:(int)parsedHeaderIndex | This property contains the header contents. |
| - password | A password if authentication is to be used. |
| - proxyAuthScheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
| - proxyAutoDetect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
| - proxyPassword | This property contains a password if authentication is to be used for the proxy. |
| - proxyPort | This property contains the TCP port for the proxy Server (default 80). |
| - proxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| - proxySSL | This property determines when to use SSL for the connection to the proxy. |
| - proxyUser | This property contains a user name, if authentication is to be used for the proxy. |
| - referer | Referer URL/document (optional). |
| - SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
| - SSLCertEncoded | The certificate (PEM/base64 encoded). |
| - SSLCertStore | The name of the certificate store for the client certificate. |
| - SSLCertStorePassword | If 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. |
| - SSLCertStoreType | The type of certificate store for this certificate. |
| - SSLCertSubject | The subject of the certificate used for client authentication. |
| - SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
| - statusLine | The first line of the last server response. |
| - timeout | A timeout for the class. |
| - transferredData | The contents of the last response from the server. |
| - transferredDataLimit | The maximum of data to be transferred. |
| - transferredHeaders | The full set of headers as received from the server. |
| - URL | The URL to post information to. |
| - user | A user name if authentication is to be used. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| - addCookie | Adds a cookie and the corresponding value to the outgoing request headers. |
| - addFormVar | Adds a form variable and the corresponding value. |
| - config | Sets or retrieves a configuration setting. |
| - doEvents | Processes events from the internal message queue. |
| - interrupt | Interrupt the current method. |
| - reset | Reset the class. |
| - submit | Post current data to the URL specified by the URL property. |
| - submitTo | Post current data to the URL specified by the 'URL' parameter. |
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.
| - onConnected | Fired immediately after a connection completes (or fails). |
| - onConnectionStatus | Fired to indicate changes in connection state. |
| - onDisconnected | Fired when a connection is closed. |
| - onEndTransfer | Fired when a document finishes transferring. |
| - onError | Information about errors during data delivery. |
| - onHeader | Fired every time a header line comes in. |
| - onLog | Fires once for each log message. |
| - onRedirect | Fired when a redirection is received from the server. |
| - onSetCookie | Fired for every cookie set by the server. |
| - onSSLServerAuthentication | Fired after the server presents its certificate to the client. |
| - onSSLStatus | Shows the progress of the secure connection. |
| - onStartTransfer | Fired when a document starts transferring (after the headers). |
| - onStatus | Fired when the HTTP status line is received from the server. |
| - onTransfer | Fired while a document transfers (delivers document). |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
| EncodeURL | If set to true the URL will be encoded by the class. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the class will perform a GET on the new location. |
| HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| HTTPVersion | The version of HTTP used by the class. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| LogLevel | The level of detail that is logged. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| NegotiatedHTTPVersion | The negotiated HTTP version. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| SentHeaders | The full set of headers as sent by the client. |
| StatusLine | The first line of the last response from the server. |
| TransferredData | The contents of the last response from the server. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
| TransferredHeaders | The full set of headers as received from the server. |
| TransferredRequest | The full request as sent by the client. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| UseIDNs | Whether to encode hostnames to internationalized domain names. |
| UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
| UserAgent | Information about the user agent (browser). |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the class binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
| SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
| SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
| SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
| SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
| SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
| SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
| SSLNegotiatedVersion | Returns the negotiated protocol version. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |