Latest revision as of 16:16, 24 October 2015

 

Home

 

Download

 

News

 

Support

 

Admin

 

Dev

 

Screen Shots

 

Grid List

 

Bugs

Languages:

English

POLICY PROPOSAL: This document is a proposal for naming standards and is not yet active.

Base Syntax: admin_Category_Function

[edit] Naming

Function and parameter names should use US English spelling.

Function should be clearly named & indicative of purpose

[edit] Parameters

Parameters should be clearly named & use a common syntax

Eg. use region_id and NOT region_uuid, region_ID or any other variation

[edit] 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
• user_firstname, user_lastname - name of user's account
• user_password - password of user's account
• object_id - uuid of an object
• object_name - name of an object

[edit] 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