activate_role

From SmartBots Developers Docs
Jump to: navigation, search

Changes the active group tag/title to the corresponding role UUID.

// See "LSL Helper Functions" page for this function
smartbotsAPI("activate_role", [
  "groupuuid", "0b65a122-8f77-64fe-5b2a-225d4c490d9c",
  "roleuuid", "00000000-0000-0000-0000-000000000000"
]);

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 = activate_role
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:
groupuuid yes UUID of the group
roleuuid yes UUID of the role to activate
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

Activates the "Everyone" role's group tag:

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

// See "LSL Helper Functions" page for this function
smartbotsAPI("activate_role", [
  "groupuuid", "0b65a122-8f77-64fe-5b2a-225d4c490d9c",
  "roleuuid", "00000000-0000-0000-0000-000000000000"
]);


<< return back to Bot commands

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