CkHttpRequest Ruby Programming
Reference Documentation

CkHttpRequest

Represents a complete HTTP request.

Object Creation

obj = Chilkat::CkHttpRequest.new()

Properties

# str is a CkString (output)
get_Charset( str )

# charset is a string (input)
put_Charset( charset )

Controls the character encoding used for HTTP request parameters for POST requests. The default value is "utf-8". 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.

# str is a CkString (output)
get_ContentType( str )

# newVal is a string (input)
put_ContentType( newVal )

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.

# str is a CkString (output)
get_DebugLogFilePath( str )

# newVal is a string (input)
put_DebugLogFilePath( newVal )

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.

# str is a CkString (output)
get_EntireHeader( str )

# newVal is a string (input)
put_EntireHeader( newVal )

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

# str is a CkString (output)
get_HttpVerb( str )

# newVal is a string (input)
put_HttpVerb( newVal )

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.

# str is a CkString (output)
get_HttpVersion( str )

# version is a string (input)
put_HttpVersion( version )

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

# str is a CkString (input)
LastErrorHtml( str )

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.

# str is a CkString (input)
LastErrorText( str )

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

# str is a CkString (input)
LastErrorXml( str )

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.

# Returns an integer value
get_NumHeaderFields( )

Returns the number of request header fields.

# Returns an integer value
get_NumParams( )

Returns the number of query parameters.

# str is a CkString (output)
get_Path( str )

# path is a string (input)
put_Path( path )

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

# Returns a boolean value
get_SendCharset( )

# val is a boolean (input)
put_SendCharset( val )

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.

# Returns a boolean value
get_Utf8( )

# b is a boolean (input)
put_Utf8( b )

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

# Returns a boolean value
get_VerboseLogging( )

# newVal is a boolean (input)
put_VerboseLogging( newVal )

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.

Methods

# name is a string (input)
# remoteFileName is a string (input)
# byteData is a CkByteData (input)
# Returns a boolean value
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.

# name is a string (input)
# remoteFileName is a string (input)
# byteData is a CkByteData (input)
# contentType is a string (input)
# Returns a boolean value
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.)

# name is a string (input)
# filePath is a string (input)
# Returns a boolean value
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.

# name is a string (input)
# filePath is a string (input)
# contentType is a string (input)
# Returns a boolean value
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.

# name is a string (input)
# value is a string (input)
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.

Adding Cookies to an HTTP Request

# name is a string (input)
# value is a string (input)
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 (input)
# filename is a string (input)
# strData is a string (input)
# charset is a string (input)
# Returns a boolean value
AddStringForUpload( name, filename, strData, charset )

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

# name is a string (input)
# filename is a string (input)
# strData is a string (input)
# charset is a string (input)
# contentType is a string (input)
# Returns a boolean value
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 ARG2's file extension.)

# str is a CkString (input)
GenerateRequestText( str )

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

Returns true for success, false for failure.

# name is a string (input)
# str is a CkString (input)
# Returns a boolean value
GetHeaderField( name, str )

Returns the value of a request header field.

Returns true for success, false for failure.

# index is an integer (input)
# str is a CkString (input)
# Returns a boolean value
GetHeaderName( index, str )

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 (input)
# str is a CkString (input)
# Returns a boolean value
GetHeaderValue( index, str )

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 (input)
# str is a CkString (input)
# Returns a boolean value
GetParam( name, str )

Returns a request query parameter value by name.

Returns true for success, false for failure.

# index is an integer (input)
# str is a CkString (input)
# Returns a boolean value
GetParamName( index, str )

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 (input)
# str is a CkString (input)
# Returns a boolean value
GetParamValue( index, str )

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)
# Returns a boolean value
GetUrlEncodedParams( outStr )

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 (input)
# Returns a boolean value
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.

# filePath is a string (input)
# Returns a boolean value
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.

# bodyStr is a string (input)
# charset is a string (input)
# Returns a boolean value
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.

RemoveAllParams( )

Removes all request parameters.

# name is a string (input)
# Returns a boolean value
RemoveHeader( name )

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

# name is a string (input)
RemoveParam( name )

Removes a single HTTP request parameter by name.

# filename is a string (input)
# Returns a boolean value
SaveLastError( filename )

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

# url is a string (input)
SetFromUrl( url )

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

# filePath is a string (input)
# Returns a boolean value
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.

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

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

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

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

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

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

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

# Returns a string
charset( )

Controls the character encoding used for HTTP request parameters for POST requests. The default value is "utf-8". 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.

Returns a null on failure

# Returns a string
contentType( )

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.

Returns a null on failure

# Returns a string
debugLogFilePath( )

To be documented soon...

# Returns a string
entireHeader( )

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

Returns a null on failure

# Returns a string
generateRequestText( )

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

Returns a null on failure

# name is a string (input)
# Returns a string
getHeaderField( name )

Returns the value of a request header field.

Returns a null on failure

# index is an integer (input)
# Returns a string
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 a null on failure

# index is an integer (input)
# Returns a string
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 a null on failure

# name is a string (input)
# Returns a string
getParam( name )

Returns a request query parameter value by name.

Returns a null on failure

# index is an integer (input)
# Returns a string
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 a null on failure

# index is an integer (input)
# Returns a string
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 a null on failure

# Returns a string
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 a null on failure

# Returns a string
httpVerb( )

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.

Returns a null on failure

# Returns a string
httpVersion( )

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

Returns a null on failure

# Returns a string
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.

# Returns a string
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

# Returns a string
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.

# Returns a string
path( )

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

Returns a null on failure