AbortRemoteRequest: Difference between revisions
Jump to navigation
Jump to search
(Fix syntax) |
Fernando187 (talk | contribs) (Remove obsolete Requirements section) |
||
| (8 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Server client function}} | {{Server client function}} | ||
__NOTOC__ | __NOTOC__ | ||
{{New feature/item|3.0158|1.5.7|20307| | |||
Aborts a [[FetchRemote|fetchRemote]] or [[CallRemote|callRemote]] request. | Aborts a [[FetchRemote|fetchRemote]] or [[CallRemote|callRemote]] request. | ||
}} | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool abortRemoteRequest( request theRequest ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
* '''theRequest''': | * '''theRequest''': returned from [[FetchRemote|fetchRemote]], [[CallRemote|callRemote]] or [[GetRemoteRequests|getRemoteRequests]] | ||
==Returns== | ==Returns== | ||
| Line 15: | Line 16: | ||
==Example== | ==Example== | ||
This example aborts all requests. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function CMD_abortRequests() | function CMD_abortRequests() | ||
| Line 21: | Line 22: | ||
for _, request in ipairs(requests) do | for _, request in ipairs(requests) do | ||
abortRemoteRequest() | abortRemoteRequest(request) | ||
end | end | ||
end | end | ||
| Line 27: | Line 28: | ||
addCommandHandler("abortrequests", CMD_abortRequests) | addCommandHandler("abortrequests", CMD_abortRequests) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Resource functions}} | {{Resource functions}} | ||
Latest revision as of 17:17, 7 November 2024
Aborts a fetchRemote or callRemote request.
Syntax
bool abortRemoteRequest( request theRequest )
Required Arguments
- theRequest: returned from fetchRemote, callRemote or getRemoteRequests
Returns
Returns true on success, false when invalid request was provided
Example
This example aborts all requests.
function CMD_abortRequests()
local requests = getRemoteRequests()
for _, request in ipairs(requests) do
abortRemoteRequest(request)
end
end
addCommandHandler("abortrequests", CMD_abortRequests)
See Also
- abortRemoteRequest
- call
- fetchRemote
- getResourceConfig
- getResourceDynamicElementRoot
- getResourceExportedFunctions
- getResourceFromName
- getResourceName
- getResourceRootElement
- getResourceState
- getThisResource
- getRemoteRequests
- getRemoteRequestInfo