RemoteAdmin:RemoteAdmin Standards
From OpenSimulator
(Difference between revisions)
(→common Parameters are) |
m (Robot: Cosmetic changes) |
||
| Line 9: | Line 9: | ||
Base Syntax: admin_Category_Function | Base Syntax: admin_Category_Function | ||
| − | =Naming= | + | = Naming = |
Function and parameter names should use US English spelling. <!-- Why? What's the rationale behind this? Please explain. --> | Function and parameter names should use US English spelling. <!-- Why? What's the rationale behind this? Please explain. --> | ||
Function should be clearly named & indicative of purpose | Function should be clearly named & indicative of purpose | ||
| − | ==Parameters== | + | == Parameters == |
Parameters should be clearly named & use a common syntax | Parameters should be clearly named & use a common syntax | ||
| Line 20: | Line 20: | ||
use ''region_id'' and NOT region_uuid, region_ID or any other variation | use ''region_id'' and NOT region_uuid, region_ID or any other variation | ||
| − | ===common Parameters are === | + | === common Parameters are === |
Note: The following paramenters are NOT standard in older commands! | Note: The following paramenters are NOT standard in older commands! | ||
| Line 31: | Line 31: | ||
* ''object_name'' - name of an object | * ''object_name'' - name of an object | ||
| − | ===commonly returned Parameters are === | + | === commonly returned Parameters are === |
Note: The following paramenters are NOT standard in older commands! | Note: The following paramenters are NOT standard in older commands! | ||
Revision as of 20:05, 3 March 2012
 |
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
- object_id - uuid of an object
- object_name - name of an object
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
