Livecode Wiki
Advertisement

Sets the headers to be sent with each request to an HTTP server.

Syntax:

libURLSetCustomHTTPHeaders headersList

Examples:

libURLSetCustomHTTPHeaders "GET /catsdata/coldat.dat HTTP/1.1"
libURLSetCustomHTTPHeaders field "Headers"


Use the libURLSetCustomHTTPHeaders command to implement an HTTP method other than GET, POST, DELETE, or PUT.

The headersList is a string, or an expression that evaluates to a string.

Whenever LiveCode contacts a web server (with the load command, the post command, or by using an HTTP URL in an expression), the headersList is sent to the web server.

Usually, the headersList will include multiple lines. A typical headersList might look like the following example:

GET /catsdata/coldat.dat HTTP/1.1
Connection: Close
User-Agent: My Fancy Browser
Host: www.cats-training.com
Accept: image/gif, image/x-xbitmap, image/jpeg, image/png, */*
Accept-Encoding: gzip
Accept-Charset: iso-8859-1,*,utf-8

The libURLSetCustomHTTPHeaders setting takes effect for the next HTTP transaction. After the transaction, the headers are set back to the default. This means that if you want to do multiple HTTP transactions using the same set of custom headers, you must use the libURLSetCustomHTTPHeaders command before each transaction.

The libURLSetCustomHTTPHeaders setting replaces the Internet library's default headers. To add to the default headers instead of replacing them, use the httpHeaders property instead.

If you specify a set of headers using the libURLSetCustomHTTPHeaders command, the Internet library's default headers and the setting of the httpHeaders property are ignored, and the headers set by libURLSetCustomHTTPHeaders are used instead.

The libURLSetCustomHTTPHeaders command is part of the Internet library. To ensure that the command works in a standalone application, you must include this custom library when you create your standalone. In the Inclusions section of the Standalone Application Settings window, make sure "Internet Library" is selected in the list of script libraries.

When included in a standalone application, the Internet library is implemented as a hidden group and made available when the group receives its first openBackground message. During the first part of the application's startup process, before this message is sent, the http keyword is not yet available. This may affect attempts to use this keyword in startup, preOpenStack, openStack, or preOpenCard handlers in the main stack. Once the application has finished starting up, the library is available and the http keyword can be used in any handler.

For technical information about the standard headers recognized in the HTTP 1.1 protocol, see RFC 2616 at http://www.ietf.org/rfc/rfc2616.txt

See Also: libURLLastHTTPHeaders Function, post Command, httpHeaders Property

Advertisement