HTTPRequest

type Advanced ¶

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any ¶

type Any interface {
	gd.IsClass
	AsHTTPRequest() Instance
}

type Expanded ¶

type Expanded [1]gdclass.HTTPRequest

func (self Expanded) Request(url string, custom_headers []string, method HTTPClient.Method, request_data string) error

func (self Expanded) RequestRaw(url string, custom_headers []string, method HTTPClient.Method, request_data_raw []byte) error

type Extension ¶

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension

func (self *Extension[T]) AsHTTPRequest() Instance

func (self *Extension[T]) AsNode() Node.Instance

func (self *Extension[T]) AsObject() [1]gd.Object

type ID ¶

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (id ID) Instance() (Instance, bool)

type Instance ¶

type Instance [1]gdclass.HTTPRequest

A node with the ability to send HTTP requests. Uses [HTTPClient] internally. Can be used to make HTTP requests, i.e. download or upload files or web content via HTTP. [b]Warning:[/b] See the notes and warnings on [HTTPClient] for limitations, especially regarding TLS security. [b]Note:[/b] When exporting to Android, make sure to enable the [code]INTERNET[/code] permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android. [b]Example:[/b] Contact a REST API and print one of its returned fields: [codeblocks] [gdscript] func _ready():

# Create an HTTP request node and connect its completion signal.
var http_request = HTTPRequest.new()
add_child(http_request)
http_request.request_completed.connect(self._http_request_completed)

# Perform a GET request. The URL below returns JSON as of writing.
var error = http_request.request("https://httpbin.org/get")
if error != OK:
    push_error("An error occurred in the HTTP request.")

# Perform a POST request. The URL below returns JSON as of writing.
# Note: Don't make simultaneous requests using a single HTTPRequest node.
# The snippet below is provided for reference only.
var body = JSON.new().stringify({"name": "Godette"})
error = http_request.request("https://httpbin.org/post", [], HTTPClient.METHOD_POST, body)
if error != OK:
    push_error("An error occurred in the HTTP request.")

# Called when the HTTP request is completed. func _http_request_completed(result, response_code, headers, body):

var json = JSON.new()
json.parse(body.get_string_from_utf8())
var response = json.get_data()

# Will print the user agent string used by the HTTPRequest node (as recognized by httpbin.org).
print(response.headers["User-Agent"])

[/gdscript] [csharp] public override void _Ready()

{
    // Create an HTTP request node and connect its completion signal.
    var httpRequest = new HttpRequest();
    AddChild(httpRequest);
    httpRequest.RequestCompleted += HttpRequestCompleted;

    // Perform a GET request. The URL below returns JSON as of writing.
    Error error = httpRequest.Request("https://httpbin.org/get");
    if (error != Error.Ok)
    {
        GD.PushError("An error occurred in the HTTP request.");
    }

    // Perform a POST request. The URL below returns JSON as of writing.
    // Note: Don't make simultaneous requests using a single HTTPRequest node.
    // The snippet below is provided for reference only.
    string body = new Json().Stringify(new Godot.Collections.Dictionary
    {
        { "name", "Godette" }
    });
    error = httpRequest.Request("https://httpbin.org/post", null, HttpClient.Method.Post, body);
    if (error != Error.Ok)
    {
        GD.PushError("An error occurred in the HTTP request.");
    }
}

// Called when the HTTP request is completed. private void HttpRequestCompleted(long result, long responseCode, string[] headers, byte[] body)

{
    var json = new Json();
    json.Parse(body.GetStringFromUtf8());
    var response = json.GetData().AsGodotDictionary();

    // Will print the user agent string used by the HTTPRequest node (as recognized by httpbin.org).
    GD.Print((response["headers"].AsGodotDictionary())["User-Agent"]);
}

[/csharp] [/codeblocks] [b]Example:[/b] Load an image using [HTTPRequest] and display it: [codeblocks] [gdscript] func _ready():

# Create an HTTP request node and connect its completion signal.
var http_request = HTTPRequest.new()
add_child(http_request)
http_request.request_completed.connect(self._http_request_completed)

# Perform the HTTP request. The URL below returns a PNG image as of writing.
var error = http_request.request("https://placehold.co/512")
if error != OK:
    push_error("An error occurred in the HTTP request.")

# Called when the HTTP request is completed. func _http_request_completed(result, response_code, headers, body):

if result != HTTPRequest.RESULT_SUCCESS:
    push_error("Image couldn't be downloaded. Try a different image.")

var image = Image.new()
var error = image.load_png_from_buffer(body)
if error != OK:
    push_error("Couldn't load the image.")

var texture = ImageTexture.create_from_image(image)

# Display the image in a TextureRect node.
var texture_rect = TextureRect.new()
add_child(texture_rect)
texture_rect.texture = texture

[/gdscript] [csharp] public override void _Ready()

{
    // Create an HTTP request node and connect its completion signal.
    var httpRequest = new HttpRequest();
    AddChild(httpRequest);
    httpRequest.RequestCompleted += HttpRequestCompleted;

    // Perform the HTTP request. The URL below returns a PNG image as of writing.
    Error error = httpRequest.Request("https://placehold.co/512");
    if (error != Error.Ok)
    {
        GD.PushError("An error occurred in the HTTP request.");
    }
}

// Called when the HTTP request is completed. private void HttpRequestCompleted(long result, long responseCode, string[] headers, byte[] body)

{
    if (result != (long)HttpRequest.Result.Success)
    {
        GD.PushError("Image couldn't be downloaded. Try a different image.");
    }
    var image = new Image();
    Error error = image.LoadPngFromBuffer(body);
    if (error != Error.Ok)
    {
        GD.PushError("Couldn't load the image.");
    }

    var texture = ImageTexture.CreateFromImage(image);

    // Display the image in a TextureRect node.
    var textureRect = new TextureRect();
    AddChild(textureRect);
    textureRect.Texture = texture;
}

[/csharp] [/codeblocks] [b]Note:[/b] [HTTPRequest] nodes will automatically handle decompression of response bodies. A [code]Accept-Encoding[/code] header will be automatically added to each of your requests, unless one is already specified. Any response with a [code]Content-Encoding: gzip[/code] header will automatically be decompressed and delivered to you as uncompressed bytes.

var Nil Instance

func New() Instance

func (self Instance) AcceptGzip() bool

func (self Instance) AsHTTPRequest() Instance

func (self Instance) AsNode() Node.Instance

func (self Instance) AsObject() [1]gd.Object

func (self Instance) BodySizeLimit() int

func (self Instance) CancelRequest()

func (self Instance) DownloadChunkSize() int

func (self Instance) DownloadFile() string

func (self Instance) GetBodySize() int

func (self Instance) GetDownloadedBytes() int

func (self Instance) GetHttpClientStatus() HTTPClient.Status

func (self Instance) ID() ID

func (self Instance) MaxRedirects() int

func (self Instance) OnRequestCompleted(cb func(result int, response_code int, headers []string, body []byte), flags ...Signal.Flags)

func (self Instance) Request(url string) error

func (self Instance) RequestRaw(url string) error

func (self Instance) SetAcceptGzip(value bool)

func (self Instance) SetBodySizeLimit(value int)

func (self Instance) SetDownloadChunkSize(value int)

func (self Instance) SetDownloadFile(value string)

func (self Instance) SetHttpProxy(host string, port int)

func (self Instance) SetHttpsProxy(host string, port int)

func (self Instance) SetMaxRedirects(value int)

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (self Instance) SetTimeout(value Float.X)

func (self Instance) SetTlsOptions(client_options TLSOptions.Instance)

func (self Instance) SetUseThreads(value bool)

func (self Instance) Timeout() Float.X

func (self Instance) UseThreads() bool

func (self Instance) Virtual(name string) reflect.Value

type Result ¶

type Result int //gd:HTTPRequest.Result

const (
	/*Request successful.*/
	ResultSuccess Result = 0
	/*Request failed due to a mismatch between the expected and actual chunked body size during transfer. Possible causes include network errors, server misconfiguration, or issues with chunked encoding.*/
	ResultChunkedBodySizeMismatch Result = 1
	/*Request failed while connecting.*/
	ResultCantConnect Result = 2
	/*Request failed while resolving.*/
	ResultCantResolve Result = 3
	/*Request failed due to connection (read/write) error.*/
	ResultConnectionError Result = 4
	/*Request failed on TLS handshake.*/
	ResultTlsHandshakeError Result = 5
	/*Request does not have a response (yet).*/
	ResultNoResponse Result = 6
	/*Request exceeded its maximum size limit, see [member body_size_limit].*/
	ResultBodySizeLimitExceeded Result = 7
	/*Request failed due to an error while decompressing the response body. Possible causes include unsupported or incorrect compression format, corrupted data, or incomplete transfer.*/
	ResultBodyDecompressFailed Result = 8
	/*Request failed (currently unused).*/
	ResultRequestFailed Result = 9
	/*HTTPRequest couldn't open the download file.*/
	ResultDownloadFileCantOpen Result = 10
	/*HTTPRequest couldn't write to the download file.*/
	ResultDownloadFileWriteError Result = 11
	/*Request reached its maximum redirect limit, see [member max_redirects].*/
	ResultRedirectLimitReached Result = 12
	/*Request failed due to a timeout. If you expect requests to take a long time, try increasing the value of [member timeout] or setting it to [code]0.0[/code] to remove the timeout completely.*/
	ResultTimeout Result = 13
)