Namespace: OpenEdge.Net.HTTP
Interface
IHttpResponse
Parent classes:
Inherits: OpenEdge.Net.HTTP.IHttpMessage

Copyright (c) 2015 by Progress Software Corporation. All rights reserved.
File:IHttpResponse
Author(s):pjudge
Created:Thu Jan 22 15:47:26 EST 2015
Purpose: The status of the HTTP response. Section 6.1




Method Summary
Options Name Purpose
ClearCookies () /** Removes all cookies from this message */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
ClearHeaders () /** Removes all headers from this message */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
Cookie GetCookie (character) /** Returns a cookie by name from this message. Typically returns the first cookie it finds by name, oif more than one exist @param character The cookie's name to check @return Cookie The (first) cookie found by name */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
INTEGER GetCookies (Cookie[]) /** Returns all the cookies for this message @param Cookie[] An array of cookies @return integer The number of cookies returned */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
HttpHeader GetHeader (character) /** Returns a named header @param character The name of the header to retrieve @return HttpHeader The header object. Null if not exists. */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
INTEGER GetHeaders (HttpHeader[]) /** Returns all the headers @param HttpHeader[] An array of headers @return integer The number of headers returned */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
LOGICAL HasCookie (character) /** Indicates whether a cookie exists for this message @param character The cookie's name to check @return logical TRUE if this message contains the cookie */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
LOGICAL HasCookie (Cookie) /** Indicates whether a cookie exists for this message @param Cookie The cookie to check @return logical True if this message contains the cookie */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
LOGICAL HasHeader (character) /** Indicates whether a header exists for this message or not. @param character The name of a header to check @return logical True if this message contains the header */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
RemoveCookie (character) /** Removes coolies from this message for a given name @param character The name of the cookie(s) to remove. */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
RemoveCookie (Cookie) /** Removes a cookie from this message @param Cookie The cookie to remove. */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
RemoveHeader (character) /** Removes all headers with a given name from the set of message headers. No-op if none exists. @param character The name of the header to remove */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
SetCookie (Cookie) /** Adds a cookie to this message @param Cookie The cookie to add. */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
SetCookies (Cookie[]) /** Adds cookies to this message @param Cookie[] An array of cookies to add. */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
SetHeader (HttpHeader) /** Adds header info to this message's collection of headers. @param HttpHeader The header */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
SetHeaders (HttpHeader[]) /** Adds a set of header info to this message's collection of headers. @param HttpHeader[] An array of headers */
Inherited from OpenEdge.Net.HTTP.IHttpMessage

Property Summary
Options Name Purpose
CHARACTER CharacterEncoding
Inherited from OpenEdge.Net.HTTP.IHttpMessage
INTEGER ContentLength
Inherited from OpenEdge.Net.HTTP.IHttpMessage
RAW ContentMD5
Inherited from OpenEdge.Net.HTTP.IHttpMessage
CHARACTER ContentType
Inherited from OpenEdge.Net.HTTP.IHttpMessage
Object Entity
Inherited from OpenEdge.Net.HTTP.IHttpMessage
INTEGER StatusCode
CHARACTER StatusReason
CHARACTER TransferEncoding
Inherited from OpenEdge.Net.HTTP.IHttpMessage
CHARACTER Version
Inherited from OpenEdge.Net.HTTP.IHttpMessage


Method Detail
Top

PUBLIC ClearCookies ()

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Removes all cookies from this message
Top

PUBLIC ClearHeaders ()

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Removes all headers from this message
Top

PUBLIC Cookie GetCookie (character)

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Returns a cookie by name from this message. Typically
returns the first cookie it finds by name, oif more than
one exist
Parameters:
pcName CHARACTER
Returns Cookie
Cookie The (first) cookie found by name
Top

PUBLIC INTEGER GetCookies (Cookie[])

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Returns all the cookies for this message
Parameters:
poCookies Cookie
Returns INTEGER
integer The number of cookies returned
Top

PUBLIC HttpHeader GetHeader (character)

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Returns a named header
Parameters:
pcName CHARACTER
Returns HttpHeader
HttpHeader The header object. Null if not exists.
Top

PUBLIC INTEGER GetHeaders (HttpHeader[])

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Returns all the headers
Parameters:
poHeaders HttpHeader
Returns INTEGER
integer The number of headers returned
Top

PUBLIC LOGICAL HasCookie (character)

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Indicates whether a cookie exists for this message
Parameters:
pcName CHARACTER
Returns LOGICAL
logical TRUE if this message contains the cookie
Top

PUBLIC LOGICAL HasCookie (Cookie)

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Indicates whether a cookie exists for this message
Parameters:
poCookie Cookie
Returns LOGICAL
logical True if this message contains the cookie
Top

PUBLIC LOGICAL HasHeader (character)

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Indicates whether a header exists for this message or not.
Parameters:
pcName CHARACTER
Returns LOGICAL
logical True if this message contains the header
Top

PUBLIC RemoveCookie (character)

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Removes coolies from this message for a given name
Parameters:
pcName CHARACTER
Top

PUBLIC RemoveCookie (Cookie)

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Removes a cookie from this message
Parameters:
poCookie Cookie
Top

PUBLIC RemoveHeader (character)

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Removes all headers with a given name from the set of message headers.
No-op if none exists.
Parameters:
pcName CHARACTER
Top

PUBLIC SetCookie (Cookie)

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Adds a cookie to this message
Parameters:
poCookie Cookie
Top

PUBLIC SetCookies (Cookie[])

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Adds cookies to this message
Parameters:
poCookies Cookie
Top

PUBLIC SetHeader (HttpHeader)

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Adds header info to this message's collection of headers.
Parameters:
poHeader HttpHeader
Top

PUBLIC SetHeaders (HttpHeader[])

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Adds a set of header info to this message's collection of headers.
Parameters:
poHeader HttpHeader


Property Detail
Top

PUBLIC CHARACTER CharacterEncoding

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Returns CHARACTER
Top

PUBLIC INTEGER ContentLength

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Returns INTEGER
Top

PUBLIC RAW ContentMD5

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Returns RAW
Top

PUBLIC CHARACTER ContentType

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Returns CHARACTER
Top

PUBLIC Object Entity

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Returns Object
Top

PUBLIC INTEGER StatusCode

Returns INTEGER
Top

PUBLIC CHARACTER StatusReason

Returns CHARACTER
Top

PUBLIC CHARACTER TransferEncoding

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Returns CHARACTER
Top

PUBLIC CHARACTER Version

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Returns CHARACTER


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0