RemoteAdmin:admin update user
From OpenSimulator
(Difference between revisions)
m (Robot: Cosmetic changes) |
(→PHP) |
||
Line 81: | Line 81: | ||
== Example == | == Example == | ||
=== PHP === | === PHP === | ||
+ | This example needs the RemoteAdmin PHP Class file available [http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass here]. | ||
+ | |||
<source lang="php"> | <source lang="php"> | ||
<?php | <?php |
Revision as of 15:59, 7 November 2013
admin_update_user remotely allows to update the password and start region of users
Contents |
Enabling admin_update_user
If not all functions are enabled, use admin_update_user to enable the function in the [RemoteAdmin] section
enabled_methods = admin_update_user,...
Parameters
Required Parameters
These parameters are required
parameter | Description | Values |
---|---|---|
user_firstname | first name of user | |
user_lastname | last name of user |
Optional Parameters
These parameters are optional and do not need to be set
parameter | Description | Values |
---|---|---|
user_password | password of user | |
start_region_x | start region x position in grid, start_region_y required | |
start_region_y | start region y position in grid, start_region_x required |
Returned Parameters
Returned Parameters
These parameters are returned by Remote Admin
parameter | Description | Values |
---|---|---|
success | true when successfull | true, false |
avatar_uuid | new avatar uuid, zero uuid when error occured |
Error messages
avatar_uuid returnes zero uuid when an error occures.
Notes
- This function is only available to Robust
Example
PHP
This example needs the RemoteAdmin PHP Class file available here.
<?php // Including the RemoteAdmin PHP class. include('RemoteAdmin.php'); // Instantiate the class with parameters identical to the Python example above $myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret'); // Invoke admin_update_user (multiple parameters) $parameters = array('user_firstname' => 'John', 'user_lastname' => 'Doe', 'user_password' => 'secret'); $myRemoteAdmin->SendCommand('admin_update_user', $parameters); ?>