RemoteAdmin:RemoteAdmin Standards
From OpenSimulator
(Difference between revisions)
| Line 35: | Line 35: | ||
* ''error'' - returns the error message when an error occures | * ''error'' - returns the error message when an error occures | ||
| − | [[RemoteAdmin]] | + | |
| + | [[[[RemoteAdmin]]] | ||
Revision as of 09:58, 10 December 2011
 |
Languages: |
|
POLICY PROPOSAL: This document is a proposal for naming standards and is not yet active.
Base Syntax: admin_Category_Function
Naming
Function and parameter names should use US English spelling.
Function should be clearly named & indicative of purpose
Parameters
Parameters should be clearly named & use a common syntax
Eg. use region_id and NOT region_uuid, region_ID or any other variation
common Parameters are
Note: The following paramenters are NOT standard in older commands!
- region_id - uuid of a region
- region_name - name of a region
- filename - name and location of a file eg. "c:/bin/my_backup.oar", "my_backup.oar", "http://www.foo.bar/my_backup.oar"
- agent_first_name, agent_last_name - name of avatar
- agent_id - uuid of an avatar
commonly returned Parameters are
Note: The following paramenters are NOT standard in older commands!
- success - returns true/false when a function is executed
- error - returns the error message when an error occures
[[RemoteAdmin]
