2021-01-19 09:20:52 +00:00
|
|
|
---
|
|
|
|
module: [kind=event] http_success
|
|
|
|
see: http.request To make an HTTP request.
|
|
|
|
---
|
|
|
|
|
2023-03-15 21:52:13 +00:00
|
|
|
<!--
|
|
|
|
SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
|
|
|
|
|
2023-03-28 09:23:28 +00:00
|
|
|
SPDX-License-Identifier: MPL-2.0
|
2023-03-15 21:52:13 +00:00
|
|
|
-->
|
|
|
|
|
2021-01-19 09:20:52 +00:00
|
|
|
The @{http_success} event is fired when an HTTP request returns successfully.
|
|
|
|
|
|
|
|
This event is normally handled inside @{http.get} and @{http.post}, but it can still be seen when using @{http.request}.
|
|
|
|
|
|
|
|
## Return Values
|
|
|
|
1. @{string}: The event name.
|
|
|
|
2. @{string}: The URL of the site requested.
|
2023-01-16 22:53:58 +00:00
|
|
|
3. @{http.Response}: The successful HTTP response.
|
2021-01-19 09:20:52 +00:00
|
|
|
|
|
|
|
## Example
|
|
|
|
Prints the content of a website (this may fail if the request fails):
|
|
|
|
```lua
|
|
|
|
local myURL = "https://tweaked.cc/"
|
|
|
|
http.request(myURL)
|
|
|
|
local event, url, handle
|
|
|
|
repeat
|
|
|
|
event, url, handle = os.pullEvent("http_success")
|
|
|
|
until url == myURL
|
|
|
|
print("Contents of " .. url .. ":")
|
|
|
|
print(handle.readAll())
|
|
|
|
handle.close()
|
|
|
|
```
|