Difference between revisions of "LlManageEstateAccess"

From Second Life Wiki
Jump to: navigation, search
(According to Maestro Linden, a script error if the object owner is not allowed to manage the estate, is expected behavior)
m
 
(6 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
|inject-2=
 
|inject-2=
 
{{LSL_Function/avatar|avatar|group=*}}
 
{{LSL_Function/avatar|avatar|group=*}}
<!-- Grab caveats etc from them -->
+
<!-- Grab caveats etc from them
 
{{:ESTATE_ACCESS_ALLOWED_AGENT_ADD|set}}
 
{{:ESTATE_ACCESS_ALLOWED_AGENT_ADD|set}}
 
{{:ESTATE_ACCESS_ALLOWED_AGENT_REMOVE|set}}
 
{{:ESTATE_ACCESS_ALLOWED_AGENT_REMOVE|set}}
Line 9: Line 9:
 
{{:ESTATE_ACCESS_BANNED_AGENT_ADD|set}}
 
{{:ESTATE_ACCESS_BANNED_AGENT_ADD|set}}
 
{{:ESTATE_ACCESS_BANNED_AGENT_REMOVE|set}}
 
{{:ESTATE_ACCESS_BANNED_AGENT_REMOVE|set}}
 +
-->
 +
{{Issues/SCR-293}}
 
|func=llManageEstateAccess
 
|func=llManageEstateAccess
 
|sort=ManageEstateAccess
 
|sort=ManageEstateAccess
Line 15: Line 17:
 
|p2_type=key|p2_name=avatar
 
|p2_type=key|p2_name=avatar
 
|func_desc=Use to add or remove agents from the estate's agent access or ban lists or groups from the estate's group access list.
 
|func_desc=Use to add or remove agents from the estate's agent access or ban lists or groups from the estate's group access list.
|func_footnote=Only works for objects owned by the Estate Owner or an [[Estate Manager]].
+
|func_footnote=Only works for objects owned by the Estate Owner or an [[Estate Manager]]. By default, the object owner is notified of every change made using this function.  But if the owner grants [[PERMISSION_SILENT_ESTATE_MANAGEMENT]] to the script, the owner will not be notified.
|return_text= representing a boolean, [[TRUE]] if the call was successful; [[FALSE]] if throttled, invalid action, invalid or null id or object owner is not allowed to manage the estate.  
+
|return_text=[[TRUE]] if the call was successful; [[FALSE]] if throttled, invalid action, invalid or null id or object owner is not allowed to manage the estate.  
 
|return_type=integer
 
|return_type=integer
 +
|return_subtype=boolean
 
|constants=
 
|constants=
 
{{LSL Constants/llManageEstateAccess}}
 
{{LSL Constants/llManageEstateAccess}}
Line 26: Line 29:
 
* [[FALSE]] will be returned...
 
* [[FALSE]] will be returned...
 
** if throttled,
 
** if throttled,
** if '''{{LSL Param|action}}''' is invalid,
+
** if {{LSLP|action}} is invalid,
** if '''{{LSL Param|avatar}}''' is invalid or null
+
** if {{LSLP|avatar}} is invalid or null
** <del>if the object owner is not allowed to manage the estate.</del>
+
* If the object owner is not allowed to manage the estate the message "llManageEstateAccess object owner must manage estate." is [[llShout|shouted]] on [[DEBUG_CHANNEL]]. -- {{Jira|SRC-233}}
A call to llManageEstateAccess will produce a script error if the object owner is not allowed to manage the estate [https://jira.secondlife.com/browse/SCR-233 SRC-233]
+
 
|examples
 
|examples
 
|helpers
 
|helpers
Line 47: Line 49:
 
|cat2=Region
 
|cat2=Region
 
|cat3=Estate
 
|cat3=Estate
|cat4}}
+
|cat4
 +
|history = Date of Release  [[ Release_Notes/Second_Life_Server/11#11.10.18.243270 | 18/10/2011 ]]
 +
}}

Latest revision as of 03:11, 4 January 2014

Summary

Function: integer llManageEstateAccess( integer action, key avatar );

Use to add or remove agents from the estate's agent access or ban lists or groups from the estate's group access list.
Returns a boolean (an integer) TRUE if the call was successful; FALSE if throttled, invalid action, invalid or null id or object owner is not allowed to manage the estate.

• integer action ESTATE_ACCESS_* flag
• key avatar avatar or group UUID

Only works for objects owned by the Estate Owner or an Estate Manager. By default, the object owner is notified of every change made using this function. But if the owner grants PERMISSION_SILENT_ESTATE_MANAGEMENT to the script, the owner will not be notified.

action flag V Description
ESTATE_ACCESS_ALLOWED_AGENT_ADD 0x4 Add the agent to this estate's Allowed Residents list.
ESTATE_ACCESS_ALLOWED_AGENT_REMOVE 0x8 Remove the agent from this estate's Allowed Residents list.
ESTATE_ACCESS_ALLOWED_GROUP_ADD 0x10 Add the group to this estate's Allowed groups list.
ESTATE_ACCESS_ALLOWED_GROUP_REMOVE 0x20 Remove the group from this estate's Allowed groups list.
ESTATE_ACCESS_BANNED_AGENT_ADD 0x40 Add the agent to this estate's Banned residents list.
ESTATE_ACCESS_BANNED_AGENT_REMOVE 0x80 Remove the agent from this estate's Banned residents list.

Caveats

  • Calls are throttled at a rate of 30 calls per 30 seconds.
  • FALSE will be returned...
    • if throttled,
    • if action is invalid,
    • if avatar is invalid or null
  • If the object owner is not allowed to manage the estate the message "llManageEstateAccess object owner must manage estate." is shouted on DEBUG_CHANNEL. -- SRC-233

Important Issues

~ All Issues ~ Search JIRA for related Bugs
   ESTATE_ACCESS_BANNED_AGENT_ADD can ban estate owner!

Examples

Deep Notes

History

Date of Release 18/10/2011

All Issues

~ Search JIRA for related Issues
   ESTATE_ACCESS_BANNED_AGENT_ADD can ban estate owner!

Signature

function integer llManageEstateAccess( integer action, key avatar );