Parent topic: The HTTPResponse class
HTTP classes / The HTTPResponse class

com.HTTPResponse methods

Methods for the com.HTTPResponse class.

Table 1. Object methods
Name Description 
beginXmlResponse()
  RETURNING writer xml.StaxWriter
 Starts a streaming HTTP response. 
endXmlResponse(
   writer xml.StaxWriter )
 Performs the HTTP request. 
getDataResponse(
   data BYTE )
 Returns the entire HTTP response in a BYTE. 
getFileResponse( )
   RETURNING filename STRING
 Returns the entire HTTP response in a file on the disk. 
getHeader( name STRING )
  RETURNING result STRING
 Returns the value of an HTTP header. 
getHeaderCount()
  RETURNING result INTEGER
 Returns the number of headers. 
getHeaderName(
   index INTEGER )
  RETURNING result STRING
 Returns the name of a header by position. 
getHeaderValue(
   index INTEGER )
  RETURNING result STRING
 Returns the value of a header by position. 
getStatusCode()
  RETURNING result INTEGER
 Returns the HTTP status code. 
getStatusDescription()
  RETURNING result STRING
 Returns the HTTP status description. 
getTextResponse()
  RETURNING data STRING
 Returns the entire HTTP response in a string. 
getXmlResponse()
  RETURNING data xml.DomDocument
 Returns the entire HTTP response in a DOM document.
Table 2. Object methods: Multipart methods
Name Description 
getMultipartType()
  RETURNING result STRING
 Returns whether a response is multipart or not, and the kind of multipart if any. 
getPart(
   index INTEGER )
  RETURNING part-object com.HTTPPart
 Returns the HTTP part object at the specified index of the current HTTP response. 
getPartCount()
  RETURNING count INTEGER
 Returns the number of additional parts in the HTTP response. 
getPartFromContentID(
   id STRING )
  RETURNING part-object com.HTTPPart
 Returns the HTTP part object marked with the given Content-ID value as identifier, or NULL if none.
Parent topic: The HTTPResponse class