HttpRequest methods syntax

From m204wiki
Jump to: navigation, search

The syntax for each of the HttpRequest class methods is shown below.

Square brackets indicate optional elements of the method invocation. See also the notation conventions for methods and the List of HttpRequest methods.

httpRequest:AddField( fieldName, fieldValue, [file], [translate])

httpRequest:AddHeader( header, value)

httpRequest:AddLongstring( string, [xlatFlag])

httpRequest:AddXml( doc, [options])

%currentBoolean = httpRequest:AutoSendXmlContentType httpRequest:AutoSendXmlContentType = newBoolean

%number = httpRequest:FieldCount

%httpResponse = httpRequest:Get[( [[Port=] string], [[Cancel=] number], - [CertificateCheck= certificateChecker], - [CheckKeepAliveCertificate= boolean])]

%number = httpRequest:HeaderCount

%currentString = httpRequest:Host httpRequest:Host = newString

%currentString = httpRequest:HttpVersion httpRequest:HttpVersion = newString

%currentLineEnd = httpRequest:LineEnd httpRequest:LineEnd = newLineEnd

%currentNumber = httpRequest:MaxRedirects httpRequest:MaxRedirects = newNumber

%currentBoolean = httpRequest:MultiPartFormEncoding httpRequest:MultiPartFormEncoding = newBoolean

%httpRequest = [%(HttpRequest):]New

%currentString = httpRequest:Page httpRequest:Page = newString

%currentNumber = httpRequest:Port httpRequest:Port = newNumber

%httpResponse = httpRequest:Post[( [[Port=] string], [[Cancel=] number], - [CertificateCheck= certificateChecker], - [CheckKeepAliveCertificate= boolean])]

httpRequest:Print

%currentString = httpRequest:Protocol httpRequest:Protocol = newString

%currentString = httpRequest:Proxy httpRequest:Proxy = newString

httpRequest:RemoveAuthentication

httpRequest:RemoveProxy

%httpResponse = httpRequest:Send( [[Port=] string], [[Cancel=] number], - [CertificateCheck= certificateChecker], - [CheckKeepAliveCertificate= boolean], - Method= name)

httpRequest:SetAuthentication( userID, password, realm)

%currentNumber = httpRequest:Timeout httpRequest:Timeout = newNumber

%currentString = httpRequest:TranslateTable httpRequest:TranslateTable = newString Throws InvalidTranslateTable

%currentString = httpRequest:URL httpRequest:URL = newString