group_visibility

From SmartBots Developers Docs
Jump to: navigation, search

Controls the group visibility in bot profile.

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

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 = group_visibility
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 the group UUID
profile yes set to 1 to show group in profile, 0 to hide
notices optional if set, controls wherever bot receives notices from the group. Use "accept" to receive notices, "reject" to deny receiving them.
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.

Details

Use this command to show/hide the group in bot's public profile. The result of the operation is applied immediately.

The notices delivery can be controlled here as well (for the historical reasons). If notices="reject" is set, bot will stop receiving notices from the specific group. Note that "profile" parameter has to be set in any case.



<< return back to Bot commands

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