llManageEstateAccess

From Second Life Wiki
Revision as of 11:22, 8 January 2012 by Strife Onizuka (talk | contribs) (signature)
Jump to navigation Jump to search
Emblem-important-red.png Pre-release Documentation Warning!

This function is not available yet. This documentation was written prior to its final release so it may not match the final implementation.

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 an integer 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.

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

Only works for objects owned by the Estate Owner or an Estate Manager.

action flag V Description
ESTATE_ACCESS_ALLOWED_AGENT_ADD Add the agent to this estate's Allowed Residents list.
ESTATE_ACCESS_ALLOWED_AGENT_REMOVE Remove the agent from this estate's Allowed Residents list.
ESTATE_ACCESS_ALLOWED_GROUP_ADD Add the group to this estate's Allowed groups list.
ESTATE_ACCESS_ALLOWED_GROUP_REMOVE Remove the group from this estate's Allowed groups list.
ESTATE_ACCESS_BANNED_AGENT_ADD Add the agent to this estate's Banned residents list.
ESTATE_ACCESS_BANNED_AGENT_REMOVE 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.
All Issues ~ Search JIRA for related Bugs

Examples

Deep Notes

Search JIRA for related Issues

Signature

function integer llManageEstateAccess( integer action, key avatar );
integer ESTATE_ACCESS_ALLOWED_AGENT_ADD;
integer ESTATE_ACCESS_ALLOWED_AGENT_REMOVE;
integer ESTATE_ACCESS_ALLOWED_GROUP_ADD;
integer ESTATE_ACCESS_ALLOWED_GROUP_REMOVE;
integer ESTATE_ACCESS_BANNED_AGENT_ADD;
integer ESTATE_ACCESS_BANNED_AGENT_REMOVE;