RemoteAdmin:admin broadcast

From OpenSimulator

Revision as of 11:19, 9 December 2011 by Michelle Argus (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

admin_broadcast remotely allows to broadcast a general alert to all agents in a region


Contents

Enabling admin_broadcast

If not all functions are enabled, use admin_dbroadcast to enable the function in the [RemoteAdmin] section

enabled_methods = admin_broadcast,...

Parameters

Required Parameters

These parameters are required

parameter Description Values
message Message to be broadcasted


Optional Parameters

There are no optional parameters


Returned Parameters

Returned Parameters

These parameters are returned by Remote Admin

parameter Description Values
success true when successfull true, false
error error message when not successfull


Error messages

No error Messages

Notes

  • accepted is an optional returned parameter, probably used prior to success


Example

PHP

<?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_create_user (multiple parameters)
$parameters = array('message' => 'Welcome in my region');
$myRemoteAdmin->SendCommand('admin_broadcast', $parameters);
?>
Personal tools
General
About This Wiki