CkHttpRequest Ruby Programming
Reference Documentation

CkHttpRequest

Represents a complete HTTP request.

Properties

# str is a CkString object (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.

# str is a CkString object (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 object (output)
LastErrorHtml( str )

Error information in HTML format for the last method called.

# str is a CkString object (output)
LastErrorText( str )

Error information in plain-text format for the last method called.

# str is a CkString object (output)
LastErrorXml( str )

Error information in XML format for the last method called.

# 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 object (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.

# Returns a boolean value
get_Utf8( )

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

When set to true, all "const char *" arguments are expected to be utf-8 strings. If set to false, the "const char *" arguments are expected to be ANSI strings.

Methods

# name is a string (input)
# filename is a string (input)
# Returns a boolean value
AddFileForUpload( name, filename )

Adds a file to an upload request. To create a file upload request, call UseUpload and then call AddFileForUpload for each file to be uploaded.

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

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

# str is a CkString object (output)
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 object (output)
# 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 object (output)
# 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 object (output)
# 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 object (output)
# 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 object (output)
# 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 object (output)
# 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.

# binaryData is a CkByteData object (output)
# Returns a boolean value
LoadBodyFromBytes( binaryData )

To be documented soon...

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

To be documented soon...

# bodyStr is a string (input)
# Returns a boolean value
LoadBodyFromString( bodyStr )

To be documented soon...

RemoveAllParams( )

Removes all request parameters.

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

UseGet( )

Makes the HttpRequest a GET request.

UseHead( )

Makes the HttpRequest a HEAD request.

UsePost( )

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

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.

# xmlBody is a string (input)
UseXmlHttp( xmlBody )

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

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

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

Returns the value of a request header field.

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

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

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

Returns a request query parameter value by name.

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

# 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 string
httpVersion( )

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

# Returns a string
lastErrorHtml( )

Error information in HTML format for the last method called.

# Returns a string
lastErrorText( )

Error information in plain-text format for the last method called.

# Returns a string
lastErrorXml( )

Error information in XML format for the last method called.

# Returns a string
path( )

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