Difference between revisions of "HTTP API/Bot Commands/notecard read"
From SmartBots Developers Docs
(Created page with "{{DISPLAYTITLE: notecard_read}} <onlyinclude>Edit a notecard in the bot's inventory.</onlyinclude> <syntaxhighlight lang="lsl"> // See "LSL Helper Functions" page for this fu...") |
|||
Line 17: | Line 17: | ||
{{API Variable Group|Output}} | {{API Variable Group|Output}} | ||
{{API HTTP Standard Output}} | {{API HTTP Standard Output}} | ||
− | + | {{API Variable|text|}} The contents of the notecard | |
{{API Variables Table End}} | {{API Variables Table End}} | ||
Latest revision as of 13:36, 6 March 2019
Edit a notecard in the bot's inventory.
// See "LSL Helper Functions" page for this function
smartbotsAPI("notecard_read", [
"uuid", "b572d860-c5cf-e023-a6b2-408f30266acc",
]);
Variables
The following table shows input values (you send them with the API call) and returned output values.
Variable | Required | Description | ||
---|---|---|---|---|
Input basic parameters: | ||||
action | yes | = notecard_read | ||
apikey | yes | Your personal developer's API key. | ||
botname | yes | Your bot's SL login. | ||
secret | yes | Bot access code of your bot. | ||
dataType | optional | Set to "json" to get JSON reply instead of URL-encoded string | ||
custom | optional | The custom data (string) to be passed back to caller script. This value will be returned back to the caller in HTTP response. | ||
Input: | ||||
uuid | yes | UUID of an notecard in the bots inventory | ||
Output: | ||||
(to be received in http_response LSL event, see docs for details) | ||||
result | OK - command completed successfully FAIL - command failed | |||
resulttext | Detailed reason for the failure. | |||
custom | The value from input "custom" parameter. See above. | |||
text | The contents of the notecard |
Example
Read a notecard contents for the given UUID.
(the example uses smartbotsAPI() helper function. Set your "apikey", "botname" and "secret" in that function)
// See "LSL Helper Functions" page for this function
smartbotsAPI("notecard_read", [
"uuid", "b572d860-c5cf-e023-a6b2-408f30266acc",
]);
<< return back to Bot commands
(Miss an API call or parameter? Submit your request in forum)