82a439e6 31aa 747f 2acc afda372a05ef

HTTPBased.TryHttp Method (HTTPBased.HTTPMethods, String, String, String, String, String, HTTPBased.ItemList, Boolean)

[This is preliminary documentation and is subject to change.]

Sends an HTTP Request with the given request method and parameters

Namespace: TeamControlium.NonGUI
Assembly: TeamControlium.NonGUI (in TeamControlium.NonGUI.dll) Version: 2.0.0

Syntax

C#

public bool TryHttp(
	HTTPBased.HTTPMethods method,
	string domain,
	string resourcePath,
	string query,
	string header,
	string body,
	out HTTPBased.ItemList response,
	bool setContentLength = true
)

Parameters

 

method

Type: TeamControlium.NonGUI.HTTPBased.HTTPMethods
Required method. See HTTPBased.HTTPMethods

domain

Type: System.String
Domain to send required to

resourcePath

Type: System.String
Resource path

query

Type: System.String
Query-string to use

header

Type: System.String
HTTP Header part of request

body

Type: System.String
HTTP Body part of request

response

Type: TeamControlium.NonGUI.HTTPBased.ItemList
If successful, Response returned from request otherwise null.

setContentLength (Optional)

Type: System.Boolean
Optional parameter (default true) - Indicates if HTTP Content-Length header item should automatically be added/updated or not

Return Value

Type: Boolean
True if successful, otherwise false. If false, TryException contains exception thrown

Remarks

If there is a timeout an Exception will be logged and false returned.
If the header Connection: keep-alive is used this WILL currently result in a timeout.
The Header item 'Content-Length' will automatically be added (or updated with actual Body length if set already)

See Also

Reference

HTTPBased Class
TryHttp Overload
TeamControlium.NonGUI Namespace