fetchRemote | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

fetchRemote

Client-side
Server-side
Shared
Needs checking

This function was partially migrated from the old wiki. Please review manually:

  • Missing section: CallbackstatusCodeerror values

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

This function allows you to post and receive data from HTTP servers. The calls are asynchronous so you do not get an immediate result from the call, instead a callback function you specify is called when the download completes.

Note

Client side function only works with the server the player is connected to unless the domain has been accepted with requestBrowserDomains

Caution

function won't trigger inside another fetchRemote function

Caution

When using toJSON for submitting data, make sure to use string.sub(data, 2, -2) to remove the initial and final brackets, as many APIs will not understand the request

Syntax

bool fetchRemote ( string URL, table options, callback callbackFunction, table callbackArguments )
Required Arguments
  • URL: A full URL in the format http://hostname/path/file.ext . A port can be specified with a colon followed by a port number appended to the hostname.
  • options: A table containing any request options: queueName: Name of the queue to use. Any name can be used. If not set, the queue name is "default". Requests in the same queue are processed in order, one at a time. connectionAttempts: Number of times to retry if the remote host does not respond. (Defaults to 10) connectTimeout: Number of milliseconds each connection attempt will take before timing out. (Defaults to 10000) postData: A string specifying any data you want to send to the remote HTTP server. postIsBinary : A boolean specifying if the data is text, or binary. (Defaults to false) method: A string specifying the request method. (Defaults to GET or POST) headers: A table containing HTTP request headers. e.g.{ Pragma="no-cache" } maxRedirects: An integer limiting the number of HTTP redirections to automatically follow. (Defaults to 8) username: A string specifying the username for protected pages. password: A string specifying the password for protected pages. formFields: A table containing form items to submit. (for POST method only) e.g.{ name="bob", email=" [email protected] " }
  • callbackFunction: This is the function that should receive the data returned from the remote server. The callback argument list should be: responseData - A string containing the remote response responseInfo - A table containing: success - A boolean indicating if the request was successful. statusCode - An integer status/error code. See the list of possible error values below. headers - A table containing the HTTP response headers arguments... - The arguments that were passed into fetchRemote
  • callbackArguments: A table containing arguments you may want to pass to the callback.

Returns

  • bool: value

Returns a request value which can be used with getRemoteRequestInfo or abortRemoteRequest

Code Examples

shared

Sending email via a web service (adopted from examples onhttps://documentation.mailgun.com/en/latest/user_manual.html)

sendOptions = {
    queueName = "My Mailgun queue",
    connectionAttempts = 3,
    connectTimeout = 5000,
    formFields = {
        from="Excited User <[email protected]>",
        to="[email protected]",
        subject="Hello",
        text="Testing some Mailgun awesomness!",
    },
    username="api",
    password="key-3ax6xnjp29jd6fds4gc373sgvjxteol0",
}
fetchRemote( "https://api.mailgun.net/v3/samples.mailgun.org/messages", sendOptions, mailgunCompleteCallback )


function mailgunCompleteCallback(data, info)
    outputDebugString( "mailgunComplete"
            .. " success:" .. tostring(info.success)
            .. " statusCode:" .. tostring(info.statusCode)
            .. " data:" .. tostring(data)
            )
end

See Also

Resource Functions
Resource Events
Resource Elements
Reference