BrightSign Object Reference Manual (FW 5.1) - Manual (Page 256)

248
header is sent based on the current size of the file, which is written in place rather than
using a temporary file.
response_body_object String Uses the response body to create an object of the specified type. See the entry
for
AsyncGetToObject() for supported object types.
response_pipe roArray Use a pipeline of handlers to process the response body as it is received. See below
for more details.
The roArray response for
response_pipe consists of one or more roAssociativeArray instances containing a filter
description (see below). The last associative array is usually an output filter.
Name Type Description
hash String Calculate a hash (digest) of the data using the specified algorithm as it passes through
the pipeline. Supported hashes include the following:
" CRC32 " , " MD5 " , " SHA1 " ,
" SHA256 " , " SHA384 " , " SHA512 " . The resulting hash can be retrieved as a
hexadecimal string using the roUrlEvent.GetHash() method.
decompress String Decompress the response body using the specified algorithm. Currently, the only
supported algorithm is
“gzip”. It is often easier to use an HTTP Content-Encoding
rather than explicitly decompressing the body.
prefix_capture Integer Capture the specified number of bytes (between 1 and 16384) from the start of the
stream and store them separately. The bytes can be retrieved using the
roUrlEvent.GetPrefix() method, but they cannot be passed on to subsequent filters.
output file String Output the pipeline to the specified file. The output is written to a temporary file and
then renamed to the specified filename if successful.
output_string Boolean If specified and set to True, the response will be stored in a string and provided via the
roUrlEvent.GetString() method.
Example: The following code specifies an array of handlers to filter the response body of an HTTP request.