Difference between revisions of "HTTP API/Bot Commands/notecard create"

From SmartBots Developers Docs
Jump to: navigation, search
(Created page with "{{DISPLAYTITLE: notecard_create}} <onlyinclude>Create a notecard in the bot's inventory.</onlyinclude> <syntaxhighlight lang="lsl"> // See "LSL Helper Functions" page for thi...")
 
Line 13: Line 13:
  
 
{{API Variables Table}}
 
{{API Variables Table}}
−
{{API HTTP Required Vars|inventory_delete}}
+
{{API HTTP Required Vars|notecard_create}}
  
 
{{API Variable Group|Input}}
 
{{API Variable Group|Input}}

Revision as of 11:40, 6 March 2019

Create a notecard in the bot's inventory. 

// See "LSL Helper Functions" page for this function
smartbotsAPI("notecard_create", [
  "folder", "b572d860-c5cf-e023-a6b2-408f30266acc",
  "name", "My new notecard".
  "description", "This is a test notecard description",
  "text", "Hello!\nThis is a new line but also the contents of my new notecard!"
]);

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_create
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:
folder yes UUID of an inventory folder where the notecard will be created
name yes name of the notecard
description optional an option description for the notecard
text yes the contents of the notecard
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.

Example

Create a notecard in the given folder 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_create", [
  "folder", "b572d860-c5cf-e023-a6b2-408f30266acc",
  "name", "My new notecard".
  "description", "This is a test notecard description",
  "text", "Hello!\nThis is a new line but also the contents of my new notecard!"
]);


<< return back to Bot commands

(Miss an API call or parameter? Submit your request in forum)


Retrieved from "https://www.mysmartbots.com/dev/docs/index.php?title=HTTP_API/Bot_Commands/notecard_create&oldid=1693"