cancel_friendship

From SmartBots Developers Docs
HTTP APIBot Commands
Revision as of 23:15, 4 March 2019 by Scullyuk (Talk | contribs) (Created page with "{{DISPLAYTITLE: cancel_friendship}} <onlyinclude>Removes an avatar from the bots friend list.</onlyinclude> <syntaxhighlight lang="lsl"> // See "LSL Helper Functions" page fo...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Removes an avatar from the bots friend list.

// See "LSL Helper Functions" page for this function
smartbotsAPI("cancel_friendship", [
  "slkey", "d11fa786-c342-4785-8e1b-ac70a17a9aac"
]);

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 = cancel_friendship
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:
slkey yes avatar UUID to be removed from friend list
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

Removes an avatar from the friend list:

(the example uses smartbotsAPI() helper function. Set your "apikey", "botname" and "secret" in that function)

smartbotsAPI("cancel_friendship", [
  "slkey", "d11fa786-c342-4785-8e1b-ac70a17a9aac"
]);


<< return back to Bot commands

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