Difference between revisions of "LlManageEstateAccess"

From Second Life Wiki
Jump to navigation Jump to search
m (added date of release)
(add caveat: llAddTo*List() returns True even when operation is truncated at max list length)
 
(2 intermediate revisions by 2 users not shown)
Line 18: Line 18:
|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]]. 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.
|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 28: Line 29:
* [[FALSE]] will be returned...
* [[FALSE]] will be returned...
** if throttled,
** if throttled,
** if {{LSLP|action}} is invalid,
** if object owner doesn't have power to perform {{LSLP|action}},
** if {{LSLP|avatar}} is invalid or null
** if {{LSLP|avatar}} is invalid or null
* If used on [[mainland]] the message "llManageEstateAccess does not work on mainland" is [[llShout|shouted]] on [[DEBUG_CHANNEL]].
* 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}}
* 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}}
* If a legit estate manager tries to exceed the max number of entries in the list the call will return [[TRUE]] but the operation be truncated at the limit.
|examples
|examples
|helpers
|helpers

Latest revision as of 12:58, 30 June 2023

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 object owner doesn't have power to perform action,
    • if avatar is invalid or null
  • If used on mainland the message "llManageEstateAccess does not work on mainland" is shouted on DEBUG_CHANNEL.
  • 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
  • If a legit estate manager tries to exceed the max number of entries in the list the call will return TRUE but the operation be truncated at the limit.

Examples

Deep Notes

History

Date of Release 18/10/2011

Signature

function integer llManageEstateAccess( integer action, key avatar );
Retrieved from "https://wiki.secondlife.com/w/index.php?title=LlManageEstateAccess&oldid=1214203"