ComputerCraft Wiki - User contributions [en]

HTTP (API)

2014-04-14T04:05:56Z

Graypup: It's not mod_ComputerCraft.cfg, it's ComputerCraft.cfg!

:{|class="wikitable"
| '''The HTTP API must be enabled in ComputerCraft.cfg before being used. To enable it see [http://www.computercraft.info/forums2/index.php?/topic/17533-how-to-enable-the-http-api/ this tutorial].'''
|}

The HTTP API allows interfacing with websites and downloading from them.

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="3" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
HTTP (API)
</td></tr>

<tr><td style="width: 100px; background: #E0E0E0; padding: .4em; font-weight:bold;">Return</td><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[nil]]</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[http.request]]({{type|string}} url, <nowiki>[</nowiki>{{type|string}} postData])</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sends a HTTP request to a website, asynchronously.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{type|table}} handle</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[http.get]]({{type|string}} url)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sends a HTTP GET request to a website, synchronously.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{type|table}} handle</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[http.post]]({{type|string}} url, {{type|string}} postData)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sends a HTTP POST request to a website, synchronously.</td></tr>
</table>

[[http.request]] is used to send a HTTP request that completes asynchronously and generates an event (one of [[Http success (event)|http_success]] or [[Http failure (event)|http_failure]]). [[http.get]] and [[http.post]] execute [[http.request]] and block until the operation completes.

== Handles ==
All three operations make use of ''handles'', tables that contain functions to read data returned from the HTTP server. These handles act the same as the I/O handles returned by [[fs.open]] in read-only text mode, implementing the [[fs.open#Closing_a_file_handle|close]], [[fs.open#Files_opened_in_text_read_mode|readLine]], and [[fs.open#Files_opened_in_text_read_mode|readAll]] methods. These handles also implement the following function:

{{Function
|name=<var>h</var>.getResponseCode
|returns={{type|number}} HTTP response code
|api=HTTP
|desc=Returns the numerical [https://en.wikipedia.org/wiki/List_of_HTTP_status_codes HTTP response code] sent by the server
}}

[[Category:APIs]]

Talk:Redstone.getInput

2013-07-03T16:23:21Z

Graypup:

It doesn't show what a string is!!!
:Sign your comments. It doesn't need to tell you what a string is, because that's very basic coding for ''any'' language. See [[Variables]]. [[User:My hat stinks|my_hat_stinks]]

It doesn't throw an error when the side isn't specified. << FEATURE REQUEST :P
[[User:Graypup|Graypup]] 20:23, 3 July 2013 (MSK)

User:Graypup

2012-07-27T23:12:52Z

Graypup: initial commit

The creator of gOS

Peripheral (API)

2012-07-10T03:15:26Z

Graypup: fixed accidental error on my part, added content

The peripheral API is for interacting with external [http://en.wikipedia.org/wiki/Peripheral peripherals], such as the disk drive and monitor.<br />
[[Console|Consoles]] and [[Turtle|Turtles]] are also considered peripherals and you can interface two adjacent computers, although in a more limited fashion compared to [[Rednet (API)|rednet]]. Both Computers and Turtles provide the same methods: ''turnOn'', ''shutdown'', ''reboot'', ''getID''.

==Methods==
{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="210px"|Method name
!style="background:#EEE" width="*"|Description
|-
|[[peripheral.isPresent]]( side )
|Returns '''true''' if a peripheral is present on ''side''.
|-
|[[peripheral.getType]]( side )
|Returns the type or peripheral present on ''side'', nothing returned if ''side'' is empty.
|-
|[[peripheral.getMethods]]( side )
|Returns a table containing all methods for peripheral on ''side''.
|-
|[[peripheral.call]]( side, methodName, param1, param2, ... )
|Sends a function call to peripheral located on ''side''. Return values match those of called method.<br />
'''Note:''' ''methodName'' is a string.
|-
|[[peripheral.wrap]]( side )
|Returns a handle to the peripheral located on ''side''. If assigned to a variable, it can be used to call all methods available from that peripheral, as if calling '''peripheral.call()''', e.g.:<br />
fdd = peripheral.wrap("left")<br />
fdd.someMethod()<br />
''- is the same as -''<br />
peripheral.call("left","someMethod")
|}

==Events==
{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="210px"|Event name
!style="background:#EEE" width="*"|Description
!style="background:#EEE" width="*"|Parameters
|-
|peripheral
|Fired when peripheral is attached
|side
|-
|peripheral_detach
|Fired when peripheral is removed
|side
|}
==Monitor==
List of methods:
write()
scroll()
setCursorPos(x, y)
setCursorBlink(speed)
getCursorPos()
getSize()
clear()
clearLine(line)
setTextScale(scale)

[[Category:APIs]]

Talk:IO (API)

2012-06-21T01:57:08Z

Graypup:

== What features are trimmed down? ==

it's kinda useless to say that features are trimmed down, if there's no list.
[[User:Graypup|Graypup]] 01:57, 21 June 2012 (UTC)

Talk:IO (API)

2012-06-21T01:56:54Z

Graypup: What features are trimmed down?

== What features are trimmed down? ==

it's kinda useless to say that features are trimmed down, if there's no list.