FetchRemote - Revision history

Fernando187: /* Optional Arguments */

2024-11-13T07:05:37Z

Optional Arguments

← Older revision		Revision as of 07:05, 13 November 2024
Line 40:		Line 40:
	**'''password:''' A string specifying the password 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="bob@example.com" }''		**'''formFields:''' A table containing form items to submit. (for POST method only) ''e.g.{ name="bob", email="bob@example.com" }''
	*'''~~arguments~~:''' A table containing arguments you may want to pass to the callback.		*'''callbackArguments:''' A table containing arguments you may want to pass to the callback.

	===Returns===		===Returns===

Fernando187 at 10:39, 12 November 2024

2024-11-12T10:39:24Z

← Older revision		Revision as of 10:39, 12 November 2024
Line 24:		Line 24:
	**'''''arguments...''''' - The arguments that were passed into fetchRemote		**'''''arguments...''''' - The arguments that were passed into fetchRemote

	==Callback '''statusCode''' error values==		===Callback '''statusCode''' error values===
	{{Error_codes_for_callRemote_and_fetchRemote}}		{{Error_codes_for_callRemote_and_fetchRemote}}

Fernando187 at 10:36, 12 November 2024

2024-11-12T10:36:30Z

← Older revision		Revision as of 10:36, 12 November 2024
Line 23:		Line 23:
	***'''''headers''''' - A table containing the HTTP response headers		***'''''headers''''' - A table containing the HTTP response headers
	**'''''arguments...''''' - The arguments that were passed into fetchRemote		**'''''arguments...''''' - The arguments that were passed into fetchRemote

			==Callback '''statusCode''' error values==
			{{Error_codes_for_callRemote_and_fetchRemote}}

	===Optional Arguments===		===Optional Arguments===

Fernando187: /* Required Arguments */

2024-11-12T10:35:10Z

Required Arguments

← Older revision		Revision as of 10:35, 12 November 2024
Line 20:		Line 20:
	**'''''responseInfo''''' - A table containing:		**'''''responseInfo''''' - A table containing:
	***'''''success''''' - A boolean indicating if the request was successful.		***'''''success''''' - A boolean indicating if the request was successful.
	***'''''statusCode''''' - An integer status/error code. A list of possible error values ~~are:~~		***'''''statusCode''''' - An integer status/error code. See the list of possible error values below.
	~~{{Error_codes_for_callRemote_and_fetchRemote}}~~
	***'''''headers''''' - A table containing the HTTP response headers		***'''''headers''''' - A table containing the HTTP response headers
	**'''''arguments...''''' - The arguments that were passed into fetchRemote		**'''''arguments...''''' - The arguments that were passed into fetchRemote

Fernando187: /* Required Arguments */

2024-11-12T10:32:09Z

Required Arguments

← Older revision		Revision as of 10:32, 12 November 2024
Line 20:		Line 20:
	**'''''responseInfo''''' - A table containing:		**'''''responseInfo''''' - A table containing:
	***'''''success''''' - A boolean indicating if the request was successful.		***'''''success''''' - A boolean indicating if the request was successful.
	***'''''statusCode''''' - An integer status/error code		***'''''statusCode''''' - An integer status/error code. A list of possible error values are:
			{{Error_codes_for_callRemote_and_fetchRemote}}
	***'''''headers''''' - A table containing the HTTP response headers		***'''''headers''''' - A table containing the HTTP response headers
	**'''''arguments...''''' - The arguments that were passed into fetchRemote		**'''''arguments...''''' - The arguments that were passed into fetchRemote

Fernando187 at 17:50, 7 November 2024

2024-11-07T17:50:48Z

← Older revision		Revision as of 17:50, 7 November 2024
Line 5:		Line 5:
	{{Note\|Client side function only works with the server the player is connected to unless the domain has been accepted with [[requestBrowserDomains]]}}		{{Note\|Client side function only works with the server the player is connected to unless the domain has been accepted with [[requestBrowserDomains]]}}
	{{ Warning\| function won't trigger inside another fetchRemote function }}		{{ Warning\| function won't trigger inside another fetchRemote function }}
	{{ Warning\| When using [[toJSON]] for submitting data, make sure to use '''string.sub(data, 2, -2)''' to remove the brackets as many APIs will not understand the request }}		{{ Warning\| 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 }}

	{{Legacy\|legacy/fetchRemote}}		{{Legacy\|legacy/fetchRemote}}

Fernando187: /* Example */

2024-11-07T17:49:02Z

Example

← Older revision		Revision as of 17:49, 7 November 2024
Line 43:		Line 43:

	==Example==		==Example==
	Example ~~sending~~ email via a web service (adopted from examples on https://documentation.mailgun.com/en/latest/user_manual.html)		<section name="Server - Example 1" class="server" show="true">
	~~<section name="Server" class="server" show="true">~~		Sending email via a web service (adopted from examples on https://documentation.mailgun.com/en/latest/user_manual.html)
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	sendOptions = {		sendOptions = {
Line 71:		Line 71:
	</section>		</section>

	~~Changing post content on IPS forum.~~		<section name="Server - Example 2" class="server" show="true">
	<section name="Server" class="server" show="true">		Changing post content of an IPS forum thread via its API.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local apiKey = "12345678123456781234567812345678" -- key from ips admin panel		local apiKey = "12345678123456781234567812345678" -- key from ips admin panel

Fernando187 at 17:46, 7 November 2024

2024-11-07T17:46:21Z

← Older revision		Revision as of 17:46, 7 November 2024
Line 2:		Line 2:
	{{Server client function}}		{{Server client function}}
	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.		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.

	~~If you are using fetchRemote to connect to a PHP script, you can use '''file_get_contents('php://input')''' to read the '''postData''' sent from this function.~~

	{{Note\|Client side function only works with the server the player is connected to unless the domain has been accepted with [[requestBrowserDomains]]}}		{{Note\|Client side function only works with the server the player is connected to unless the domain has been accepted with [[requestBrowserDomains]]}}
Line 11:		Line 9:
	{{Legacy\|legacy/fetchRemote}}		{{Legacy\|legacy/fetchRemote}}

	~~{{New items\|5.0154\|1.5.4-9.11342\|~~
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 39:		Line 36:
	**'''username:''' A string specifying the username for protected pages.		**'''username:''' A string specifying the username for protected pages.
	**'''password:''' A string specifying the password for protected pages.		**'''password:''' A string specifying the password for protected pages.
	~~{{New items\|5.0154\|1.5.4-9.11413\|~~
	**'''formFields:''' A table containing form items to submit. (for POST method only) ''e.g.{ name="bob", email="bob@example.com" }''		**'''formFields:''' A table containing form items to submit. (for POST method only) ''e.g.{ name="bob", email="bob@example.com" }''
	}}
	*'''arguments:''' A table containing arguments you may want to pass to the callback.		*'''arguments:''' A table containing arguments you may want to pass to the callback.
	}}

	===Returns===		===Returns===
	~~{{New items\|5.0154\|1.5.7-9.20307\|~~
	Returns a '''''request''''' value which can be used with [[GetRemoteRequestInfo\|getRemoteRequestInfo]] or [[AbortRemoteRequest\|abortRemoteRequest]]		Returns a '''''request''''' value which can be used with [[GetRemoteRequestInfo\|getRemoteRequestInfo]] or [[AbortRemoteRequest\|abortRemoteRequest]]
	}}

	==Example==		==Example==
	~~{{New items\|5.0154\|1.5.4-9.11413\|~~
	Example sending email via a web service (adopted from examples on https://documentation.mailgun.com/en/latest/user_manual.html)		Example sending email via a web service (adopted from examples on https://documentation.mailgun.com/en/latest/user_manual.html)
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
Line 100:		Line 91:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>
	}}

	~~==Changelog==~~
	~~{{ChangelogHeader}}~~
	~~{{ChangelogItem\|1.3.1-9.04605\|Added connectionAttempts argument}}~~
	~~{{ChangelogItem\|1.3.2\|Added client side}}~~
	~~{{ChangelogItem\|1.5.3-9.11270\|Added queueName argument}}~~
	~~{{ChangelogItem\|1.5.4-9.11342\|Added alternative syntax}}~~
	~~{{ChangelogItem\|1.5.4-9.11413\|Added formFields}}~~

	==See Also==		==See Also==
	{{Resource_functions}}		{{Resource_functions}}

Fernando187 at 17:45, 7 November 2024

2024-11-07T17:45:09Z

@@ Line 3: / Line 3: @@
 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.
-In the case when the call fails, a string containing "ERROR" followed by an integer containing the error reason will be passed to the callback function. The reason for failure will be similar to errors found with websites - file not found, server not found and timeouts.
+If you are using fetchRemote to connect to a PHP script, you can use '''file_get_contents('php://input')''' to read the '''postData''' sent from this function.
 {{Note|Client side function only works with the server the player is connected to unless the domain has been accepted with [[requestBrowserDomains]]}}
 {{ Warning| function won't trigger inside another fetchRemote function }}
@@ Line 11: / Line 10: @@
 {{Legacy|legacy/fetchRemote}}
 {{New items|5.0154|1.5.4-9.11342|
@@ Line 42: / Line 15: @@
 <syntaxhighlight lang="lua">
 bool fetchRemote ( string URL[, table options ], callback callbackFunction[, table callbackArguments ] )
 </syntaxhighlight>
 ===Required Arguments===
@@ Line 78: / Line 51: @@
 ==Example==
 {{New items|5.0154|1.5.4-9.11413|
 Example sending email via a web service (adopted from examples on https://documentation.mailgun.com/en/latest/user_manual.html)

Fernando187: add legacy

2024-11-07T17:40:18Z

add legacy

← Older revision		Revision as of 17:40, 7 November 2024
Line 9:		Line 9:
	{{ Warning\| function won't trigger inside another fetchRemote function }}		{{ Warning\| function won't trigger inside another fetchRemote function }}
	{{ Warning\| When using [[toJSON]] for submitting data, make sure to use '''string.sub(data, 2, -2)''' to remove the brackets as many APIs will not understand the request }}		{{ Warning\| When using [[toJSON]] for submitting data, make sure to use '''string.sub(data, 2, -2)''' to remove the brackets as many APIs will not understand the request }}

			{{Legacy\|legacy/fetchRemote}}

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">