|
Options |
Name |
Purpose |
|
|
|
OpenEdge.Net.HTTP.RequestBuilder AcceptAll ()
|
/** Allows the request to accept all content types.
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder AcceptContentType (character)
|
/** Allows the request to accept the input content type.
@param character A content type. Must be non-empty, but otherwise not validated
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder AcceptFormData ()
|
/** Allows the request to accept form data content
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder AcceptHtml ()
|
/** Allows the request to accept HTML content types
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder AcceptJson ()
|
/** Allows the request to accept basic JSON content types.
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder AcceptXml ()
|
/** Allows the request to accept XML content types
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder AddCallback (Class, handle)
|
/** Adds a listener to events from the Request.
@param Progress.Lang.Class The type of events the EventProviders is capable of
listening to
@param handle The listening procedure. Must conform to the type */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder AddCallback (Class, Object)
|
/** Adds a listener to events from the Request.
@param Progress.Lang.Class The type of events the EventProviders is capable of
listening to
@param Progress.Lang.Object The listening object. Must conform to the type */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder AddCookie (Cookie)
|
/** Adds (or replaces) a cookie
@param Cookie The cookie
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder AddFormData (character, character)
|
/** Adds a form data as a body to the request
@param character The field name (key) for the data being added
@param character The value for the field
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder AddFormData (IStringStringMap)
|
/** Adds a form data as a body to the request
@param IStringStringMap The complete data being added to the request
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder AddHeader (character, character)
|
/** Adds (or replaces) a header
@param character The header name
@param character The value
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder AddHeader (HttpHeader)
|
/** Adds (or replaces) a header
@param HttpHeader The header
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder AddJsonData (JsonObject)
|
/** Adds a JSON body to the request
@param JsonObject The JSON data being added to the request
@return RequestBuilder The request builder being constructed. */
|
|
|
|
LOGICAL AppendArrayCharacterValue (character, character)
|
/** Appends a character value to an array (convenience)
@param character The option name
@param character the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder AuthCallback (handle)
|
/** Adds an authentication listener to events from the Request.
@param handle The listening procedure. Must conform to the type */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder AuthCallback (Object)
|
/** Adds an authentication listener to events from the Request.
@param Progress.Lang.Object The listening object. Must conform to the type */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Build (character, URI)
|
/** Builder director method.
@return RequestBuilder A builder for the requested type */
|
|
|
|
ClearOptions ()
|
/** Clears all options for this builder */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder ContentType (character)
|
/** Sets the content type for the request.
@param character The content type
@return RequestBuilder This builder object */
|
|
|
|
OpenEdge.Net.HTTP.IHttpRequest DecorateRequest (Class, IHttpRequest)
|
/** Decorate the request with additional behaviour
@param Class The type of decorator to use
@param IHttpRequest The request/instance we're decorating
@return IHttpRequest The new, decorating request */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Delete (character)
|
/** Returns a request builder for a default DELETE request
@param URI The target URI
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Delete (character, Object)
|
/** Returns a request builder for a default DELETE request
@param character The target URI
@param Object The message body/entity for the request
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Delete (URI)
|
/** Returns a request builder for a default DELETE request
@param URI The target URI
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Delete (URI, Object)
|
/** Returns a request builder for a default DELETE request
@param URI The target URI
@param Object The message body/entity for the request
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Delete (URI, Object, character)
|
/** Returns a request builder for a default DELETE request
@param URI The target URI
@param Object The message body/entity for the request
@param character The content type of the entity
@return RequestBuilder The request builder being constructed. */
|
|
|
|
Destroy ()
|
/** METHOD FACTORY METHODS END **/
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder ETag (character)
|
/** Adds an ETag value to the request.
@param character The tag value
@return RequestBuilder This builder object */
|
|
|
|
LOGICAL FindConfigRecord (buffer, character)
|
/** Internal helper method to perform the find. This method attempts to find a record using
the input buffer.
@param buffer The buffer of the ConfigOption table.
@param character The config name
@return logical True if a config record was found. */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Get (character)
|
/** Returns a request builder for a default GET request
@param character The target URI
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Get (character, Object)
|
/** Returns a request builder for a default GET request
@param character The target URI
@param Object The message body/entity for the request
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Get (URI)
|
/** Returns a request builder for a default GET request
@param URI The target URI
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Get (URI, Object)
|
/** Returns a request builder for a default GET request
@param URI The target URI
@param Object The message body/entity for the request
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Get (URI, Object, character)
|
/** Returns a request builder for a default GET request
@param URI The target URI
@param Object The message body/entity for the request
@param character The content type of the entity
@return RequestBuilder The request builder being constructed. */
|
|
|
|
DATETIME-TZ GetOptionDateTimeValue (character)
|
/** Returns an option's datetime value
@param character The option name
@return datetime-tz the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
LOGICAL GetOptionLogicalValue (character)
|
/** Returns an option's logical value
@param character The option name
@return logical the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
LONGCHAR GetOptionLongcharValue (character)
|
/** Returns an option's longchar value
@param character The option name
@return longchar the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
DECIMAL GetOptionNumericValue (character)
|
/** Returns an option's decimal value
@param character The option name
@return decimal the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
Progress.Lang.Object GetOptionObjectValue (character)
|
/** Returns an option's object value
@param character The option name
@return Object the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
CHARACTER GetOptionStringArrayValue (character)
|
/** Returns an option's character array value
@param character The option name
@return character[] the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
CHARACTER GetOptionStringValue (character)
|
/** Returns an option's character value
@param character The option name
@return character the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
LOGICAL HasOption (character)
|
/** Checks whether a config option already exists
@param character The option name
@return logical True if the named configuration option exists */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Head (character)
|
/** Returns a request builder for a default HEAD request
@param character The target URI
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Head (URI)
|
/** Returns a request builder for a default HEAD request
@param URI The target URI
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder HttpVersion (character)
|
/** Sets the HTTP version of the request.
@param character A version
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Id (character)
|
/** Sets the X-Request-Id header. True or false (no unknowns allowed).
@param logical True if the request id should be sent.
@return RequestBuilder The request builder being constructed. */
|
|
|
|
Initialize ()
|
/* default values */
|
|
|
|
InitializeRegistry (BuilderRegistry)
|
/** Adds initial values into the registry
@param BuilderRegistry The registry to populate */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Options (character)
|
/** Returns a request builder for a default OPTIONS request
@param character The target URI
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Options (character, Object)
|
/** Returns a request builder for a default OPTIONS request
@param character The target URI
@param Object The message body/entity for the request
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Options (URI)
|
/** Returns a request builder for a default OPTIONS request
@param URI The target URI
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Options (URI, Object)
|
/** Returns a request builder for a default OPTIONS request
@param URI The target URI
@param Object The message body/entity for the request
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Options (URI, Object, character)
|
/** Returns a request builder for a default OPTIONS request
@param URI The target URI
@param Object The message body/entity for the request
@param character The content type of the entity
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Patch (character, Object)
|
/** Returns a request builder for a default Patch request
@param character The target URI
@param Object The message body/entity for the request
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Patch (URI, Object)
|
/** Returns a request builder for a default Patch request
@param URI The target URI
@param Object The message body/entity for the request
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Patch (URI, Object, character)
|
/** Returns a request builder for a default Patch request
@param URI The target URI
@param Object The message body/entity for the request
@param character The content type of the entity
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Post (character)
|
/** Returns a request builder for an empty POST request
@param character The target URI
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Post (character, Object)
|
/** Returns a request builder for a default POST request
@param character The target URI
@param Object The message body/entity for the request
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Post (URI)
|
/** Returns a request builder for an empty POST request
@param URI The target URI
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Post (URI, Object)
|
/** Returns a request builder for a default POST request
@param URI The target URI
@param Object The message body/entity for the request
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Post (URI, Object, character)
|
/** Returns a request builder for a default POST request
@param URI The target URI
@param Object The message body/entity for the request
@param character The content type of the entity
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Put (character, Object)
|
/** Returns a request builder for a default PUT request
@param character The target URI
@param Object The message body/entity for the request
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Put (URI, Object)
|
/** Returns a request builder for a default PUT request
@param URI The target URI
@param Object The message body/entity for the request
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Put (URI, Object, character)
|
/** Returns a request builder for a default PUT request
@param URI The target URI
@param Object The message body/entity for the request
@param character The content type of the entity
@return RequestBuilder The request builder being constructed. */
|
|
|
|
LOGICAL RemoveOption (character)
|
/** Removes an option
@param character The option name */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder SendRequestId ()
|
/** Flags the setting of the X-Request-Id header
@return RequestBuilder The request builder being constructed. */
|
|
|
|
LOGICAL SetHeaderOption (HttpHeader)
|
/** Stores a header value as an option
@param HttpHeader The header */
|
|
|
|
LOGICAL SetOption (character, character)
|
/** Stores an value as an option
@param character The option name
@param character the value
@return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
LOGICAL SetOption (character, character[])
|
/** Stores an value as an option
@param character The option name
@param character the value
@return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
LOGICAL SetOption (character, datetime-tz)
|
/** Stores a datetime-tzvalue as an option
@param character The option name
@param datetime-tz the value
@return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
LOGICAL SetOption (character, decimal)
|
/** Stores an numeric value as an option
@param character The option name
@param Object the value
@return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
LOGICAL SetOption (character, logical)
|
/** Stores a logical value as an option
@param character The option name
@param logical the value
@return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
LOGICAL SetOption (character, Object)
|
/** Stores an object value as an option
@param character The option name
@param Object the value
@return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
LOGICAL SetOption (Class, Object)
|
/** Stores an object value as an option
@param Progress.Lang>Class The option name (as a type)
@param Object the value
@return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder SupportsAuthentication ()
|
/** Indicates that this request is can handle authentication
This allows credentials etc to be supplied later.
@return RequestBuilder This builder object */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder SupportsProxy ()
|
/** Indicates that this request is capable of being proxied.
This allows the proxy to be supplied later.
@return RequestBuilder This builder object */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Trace (character)
|
/** Returns a request builder for a default TRACE request
@param character The target URI
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder Trace (URI)
|
/** Returns a request builder for a default TRACE request
@param URI The target URI
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder UsingBasicAuthentication (Credentials)
|
/** Add credentials for HTTP Basic authentication is required for the request.
@param Credentials The credentials for the basic auth
@return RequestBuilder This builder object */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder UsingCredentials (Credentials)
|
/** Add credentials to the HTTP Request
@param Credentials The credentials for the basic auth
@return RequestBuilder This builder object */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder UsingCredentials (Credentials, character, character)
|
/** Add credentials to the HTTP Request
@param Credentials The credentials for the basic auth
@param AuthenticationMethodEnum The authentication method these credentials apply to
@param character The authentication challenge text
@return RequestBuilder This builder object */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder UsingDigestAuthentication (Credentials)
|
/** Add credentials for HTTP Digest authentication is required for the request.
@param Credentials The credentials for the basic auth
@return RequestBuilder This builder object */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder ViaProxy (character)
|
/** Sets the URI to use as a proxy server for all requests
@param character The proxy server URI
@return RequestBuilder This builder object. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder ViaProxy (URI)
|
/** Sets the URI to use as a proxy server for all requests
@param URI The proxy server URI
@return RequestBuilder This builder object. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder WithData (Object)
|
/** Adds data to the request.
@param Object The object to use as the request payload/entity
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder WithData (Object, character)
|
/** Adds data to the request.
@param Object The object to use as the request payload/entity
@param character The content type for this entity/payload
@return RequestBuilder The request builder being constructed. */
|
|
|
|
OpenEdge.Net.HTTP.RequestBuilder WithTransferEncoding (TransferEncodingEnum)
|
/** Sets the transfer encoding for the request
@param TransferEncodingEnum The encoding to use
@return RequestBuilder The request builder being constructed. */
|