CkHttpRequest Ruby Reference Documentation

CkHttpRequest

Represents a complete HTTP request.

Object Creation

obj = Chilkat::CkHttpRequest.new()

Properties

# strVal is a string
# ckStr is a CkString
httpRequest.get_Charset(ckStr)
strVal = httpRequest.charset()
httpRequest.put_Charset(strVal)

Controls the character encoding used for HTTP request parameters for POST requests. The default value is the ANSI charset of the computer. The charset should match the charset expected by the form target.

The "charset" attribute is only included in the Content-Type header of the request if the SendCharset property is set to true.

# strVal is a string
# ckStr is a CkString
httpRequest.get_ContentType(ckStr)
strVal = httpRequest.contentType()
httpRequest.put_ContentType(strVal)

The ContentType property sets the "Content-Type" header field, and identifies the content-type of the HTTP request body. Common values are:

application/x-www-form-urlencoded
multipart/form-data
text/xml
application/jsonrequest
If ContentType is set equal to the empty string, then no Content-Type header is included in the HTTP request.

# strVal is a string
# ckStr is a CkString
httpRequest.get_DebugLogFilePath(ckStr)
strVal = httpRequest.debugLogFilePath()
httpRequest.put_DebugLogFilePath(strVal)

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

# strVal is a string
# ckStr is a CkString
httpRequest.get_EntireHeader(ckStr)
strVal = httpRequest.entireHeader()
httpRequest.put_EntireHeader(strVal)

Composes and returns the entire MIME header of the HTTP request.

# strVal is a string
# ckStr is a CkString
httpRequest.get_HttpVerb(ckStr)
strVal = httpRequest.httpVerb()
httpRequest.put_HttpVerb(strVal)

The HttpVerb property should be set to the name of the HTTP method that appears on the "start line" of an HTTP request, such as GET, POST, PUT, DELETE, etc. It is also possible to use the various WebDav verbs such as PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK, etc. In general, the HttpVerb may be set to anything, even custom verbs recognized by a custom server-side app.

# strVal is a string
# ckStr is a CkString
httpRequest.get_HttpVersion(ckStr)
strVal = httpRequest.httpVersion()
httpRequest.put_HttpVersion(strVal)

The HTTP version in the request header. Defaults to "1.1".

# strVal is a string
# ckStr is a CkString
httpRequest.get_LastErrorHtml(ckStr)
strVal = httpRequest.lastErrorHtml()

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

# strVal is a string
# ckStr is a CkString
httpRequest.get_LastErrorText(ckStr)
strVal = httpRequest.lastErrorText()

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

# strVal is a string
# ckStr is a CkString
httpRequest.get_LastErrorXml(ckStr)
strVal = httpRequest.lastErrorXml()

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

# intVal is an integer
intVal = httpRequest.get_NumHeaderFields()

Returns the number of request header fields.

# intVal is an integer
intVal = httpRequest.get_NumParams()

Returns the number of query parameters.

# strVal is a string
# ckStr is a CkString
httpRequest.get_Path(ckStr)
strVal = httpRequest.path()
httpRequest.put_Path(strVal)

The path of the resource requested. A path of "/" indicates the default document for a domain.

# boolVal is an boolean
boolVal = httpRequest.get_SendCharset()
httpRequest.put_SendCharset(boolVal)

Controls whether the charset is explicitly included in the content-type header field of the HTTP POST request. The default value of this property is false.

# boolVal is an boolean
boolVal = httpRequest.get_VerboseLogging()
httpRequest.put_VerboseLogging(boolVal)

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

# strVal is a string
# ckStr is a CkString
httpRequest.get_Version(ckStr)
strVal = httpRequest.version()

Version of the component/library, such as "9.4.1.42"

Methods

# name is a string
# remoteFileName is a string
# byteData is a CkByteData
success = httpRequest.AddBytesForUpload(name, remoteFileName, byteData)

Adds a file to an upload request where the contents of the file come from an in-memory byte array. To create a file upload request, call UseUpload and then call AddBytesForUpload, AddStringForUpload, or AddFileForUpload for each file to be uploaded.

name is an arbitrary name. (In HTML, it is the form field name of the input tag.)
remoteFileName is the name of the file to be created on the HTTP server.
byteData contains the contents (bytes) to be uploaded.

Returns true for success, false for failure.

# name is a string
# remoteFileName is a string
# byteData is a CkByteData
# contentType is a string
success = httpRequest.AddBytesForUpload2(name, remoteFileName, byteData, contentType)

Same as AddBytesForUpload, but allows the Content-Type header field to be directly specified. (Otherwise, the Content-Type header is automatically determined based on the remoteFileName's file extension.)

Returns true for success, false for failure.

# name is a string
# filePath is a string
success = httpRequest.AddFileForUpload(name, filePath)

Adds a file to an upload request. To create a file upload request, call UseUpload and then call AddFileForUpload, AddBytesForUpload, or AddStringForUpload for each file to be uploaded. This method does not read the file into memory. When the upload occurs, the data is streamed directly from the file, thus allowing for very large files to be uploaded without consuming large amounts of memory.

name is an arbitrary name. (In HTML, it is the form field name of the input tag.)
filePath is the path to an existing file in the local filesystem.

Returns true for success, false for failure.

# name is a string
# filePath is a string
# contentType is a string
success = httpRequest.AddFileForUpload2(name, filePath, contentType)

Same as AddFileForUpload, but allows the Content-Type header field to be directly specified. (Otherwise, the Content-Type header is automatically determined based on the file extension.)

name is an arbitrary name. (In HTML, it is the form field name of the input tag.)
filePath is the path to an existing file in the local filesystem.

Returns true for success, false for failure.

# name is a string
# value is a string
httpRequest.AddHeader(name, value)

Adds a request header to the HTTP request. If a header having the same field name is already present, this method replaces it.

Note: Never explicitly set the Content-Length header field. Chilkat will automatically compute the correct length and add the Content-Length header to all POST, PUT, or any other request where the Content-Length needs to be specified. (GET requests always have a 0 length body, and therefore never need a Content-Length header field.)

Adding Cookies to an HTTP Request

# name is a string
# value is a string
httpRequest.AddParam(name, value)

Adds a request query parameter (name/value pair) to the HTTP request. The name and value strings passed to this method should not be URL encoded.

# name is a string
# filename is a string
# strData is a string
# charset is a string
success = httpRequest.AddStringForUpload(name, filename, strData, charset)

Same as AddFileForUpload, but the upload data comes from an in-memory string instead of a file.

Returns true for success, false for failure.

# name is a string
# filename is a string
# strData is a string
# charset is a string
# contentType is a string
success = httpRequest.AddStringForUpload2(name, filename, strData, charset, contentType)

Same as AddStringForUpload, but allows the Content-Type header field to be directly specified. (Otherwise, the Content-Type header is automatically determined based on the filename's file extension.)

Returns true for success, false for failure.

# outStr is a CkString (output)
success = httpRequest.GenerateRequestText(outStr)
retStr = httpRequest.generateRequestText()

Returns the request text that would be sent if Http.SynchronousRequest was called.

Returns true for success, false for failure.

# name is a string
# outStr is a CkString (output)
success = httpRequest.GetHeaderField(name, outStr)
retStr = httpRequest.getHeaderField(name)

Returns the value of a request header field.

Returns true for success, false for failure.

# index is an integer
# outStr is a CkString (output)
success = httpRequest.GetHeaderName(index, outStr)
retStr = httpRequest.getHeaderName(index)

Returns the Nth request header field name. Indexing begins at 0, and the number of request header fields is specified by the NumHeaderFields property.

Returns true for success, false for failure.

# index is an integer
# outStr is a CkString (output)
success = httpRequest.GetHeaderValue(index, outStr)
retStr = httpRequest.getHeaderValue(index)

Returns the Nth request header field value. Indexing begins at 0, and the number of request header fields is specified by the NumHeaderFields property.

Returns true for success, false for failure.

# name is a string
# outStr is a CkString (output)
success = httpRequest.GetParam(name, outStr)
retStr = httpRequest.getParam(name)

Returns a request query parameter value by name.

Returns true for success, false for failure.

# index is an integer
# outStr is a CkString (output)
success = httpRequest.GetParamName(index, outStr)
retStr = httpRequest.getParamName(index)

Returns the Nth request query parameter field name. Indexing begins at 0, and the number of request query parameter fields is specified by the NumParams property.

Returns true for success, false for failure.

# index is an integer
# outStr is a CkString (output)
success = httpRequest.GetParamValue(index, outStr)
retStr = httpRequest.getParamValue(index)

Returns the Nth request query parameter field value. Indexing begins at 0, and the number of request query parameter fields is specified by the NumParams property.

Returns true for success, false for failure.

# outStr is a CkString (output)
success = httpRequest.GetUrlEncodedParams(outStr)
retStr = httpRequest.getUrlEncodedParams()

Returns the request parameters in URL encoded form (i.e. in the exact form that would be sent if the ContentType property was application/x-www-form-urlencoded). For example, if a request has two params: param1="abc 123" and param2="abc-123", then GetUrlEncodedParams would return "abc+123<param2=abc%2D123"

Returns true for success, false for failure.

# byteData is a CkByteData
success = httpRequest.LoadBodyFromBytes(byteData)

The HTTP protocol is such that all HTTP requests are MIME. For non-multipart requests, this method may be called to set the MIME body of the HTTP request to the exact contents of the byteData.
Note: A non-multipart HTTP request consists of (1) the HTTP start line, (2) MIME header fields, and (3) the MIME body. This method sets the MIME body.

Returns true for success, false for failure.

# filePath is a string
success = httpRequest.LoadBodyFromFile(filePath)

The HTTP protocol is such that all HTTP requests are MIME. For non-multipart requests, this method may be called to set the MIME body of the HTTP request to the exact contents of filePath.
Note: A non-multipart HTTP request consists of (1) the HTTP start line, (2) MIME header fields, and (3) the MIME body. This method sets the MIME body.

Returns true for success, false for failure.

# bodyStr is a string
# charset is a string
success = httpRequest.LoadBodyFromString(bodyStr, charset)

The HTTP protocol is such that all HTTP requests are MIME. For non-multipart requests, this method may be called to set the MIME body of the HTTP request to the exact contents of bodyStr.
Note: A non-multipart HTTP request consists of (1) the HTTP start line, (2) MIME header fields, and (3) the MIME body. This method sets the MIME body.

charset indicates the charset, such as "utf-8" or "iso-8859-1", to be used. The HTTP body will contain the bodyStr converted to this character encoding.

Returns true for success, false for failure.

httpRequest.RemoveAllParams()

Removes all request parameters.

# name is a string
success = httpRequest.RemoveHeader(name)

Removes all occurances of a HTTP request header field. Always returns true.

Returns true for success, false for failure.

# name is a string
httpRequest.RemoveParam(name)

Removes a single HTTP request parameter by name.

# path is a string
success = httpRequest.SaveLastError(path)

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

# url is a string
httpRequest.SetFromUrl(url)

Parses a URL and sets the Path and query parameters (NumParams, GetParam, GetParamName, GetParamValue).

# filePath is a string
success = httpRequest.StreamBodyFromFile(filePath)

Useful for sending HTTP requests where the body is a very large file. For example, to send an XML HttpRequest containing a very large XML document, one would set the HttpVerb = "POST", the ContentType = "text/xml", and then call StreamBodyFromFile to indicate that the XML body of the request is to be streamed directly from a file. When the HTTP request is actually sent, the body is streamed directly from the file, and thus the file never needs to be loaded in its entirety in memory.

Returns true for success, false for failure.

httpRequest.UseGet()

Makes the HttpRequest a GET request.

Important: This method is deprecated. An application should instead set the HttpVerb property equal to "GET", and the ContentType equal to an empty string (because GET requests have no request body).

httpRequest.UseHead()

Makes the HttpRequest a HEAD request.

Important: This method is deprecated. An application should instead set the HttpVerb property equal to "HEAD", and the ContentType equal to an empty string (because HEAD requests have no body).

httpRequest.UsePost()

Makes the HttpRequest a POST request that uses the "application/x-www-form-urlencoded" content type.

Important: This method is deprecated. An application should instead set the HttpVerb property equal to "POST", and the ContentType equal to "application/x-www-form-urlencoded".

httpRequest.UsePostMultipartForm()

Makes the HttpRequest a POST request that uses the "multipart/form-data" content type.

Important: This method is deprecated. An application should instead set the HttpVerb property equal to "POST", and the ContentType equal to "multipart/form-data".

httpRequest.UsePut()

Makes the HttpRequest a PUT request.

Important: This method is deprecated. An application should instead set the HttpVerb property equal to "PUT", and the ContentType equal to "application/x-www-form-urlencoded".

httpRequest.UseUpload()

Makes the HttpRequest a POST request that uses the "multipart/form-data" content type. To create a file upload request, call UseUpload and then call AddFileForUpload for each file to be uploaded.

Important: This method is deprecated. An application should instead set the HttpVerb property equal to "POST", and the ContentType equal to "multipart/form-data".

httpRequest.UseUploadPut()

Makes the HttpRequest a PUT request that uses the "multipart/form-data" content type. To create a file upload request (using the PUT verb), call UseUploadPut and then call AddFileForUpload for each file to be uploaded.

Important: This method is deprecated. An application should instead set the HttpVerb property equal to "PUT", and the ContentType equal to "multipart/form-data".

# xmlBody is a string
httpRequest.UseXmlHttp(xmlBody)

Makes the HttpRequest a POST request using the "application/xml" content type. The request body is set to the XML string passed to this method.

Important: This method is deprecated. An application should instead set the HttpVerb property equal to "POST", the ContentType equal to "text/xml", and the request body should contain the XML document text.