User Guide

Method summary 9
Information objects
All Server Management ActionScript API methods return data in an information object with
the following properties:
level, code, timestamp, data, description, and details. All
information objects have
level, code, and timestamp properties. Some methods have the
data property, which contains return data (often in an object or array), and the description
and
details properties, which typically provide information about errors.
In addition to the information objects that are documented in the Client-Side ActionScript
Language Reference for Flash Media Server 2, the NetConnection class has information objects
that are specific to the Server Management ActionScript API. The following table lists the
code and level properties, as well as the meaning of commonly returned information
objects.
Method summary
The Server Management ActionScript API contains the following three types of methods:
■ Queries let you monitor Flash Media Server, its applications, and specific instances of its
applications.
■ Administrative commands let you perform administrative tasks for Flash Media Server,
such as adding administrative users and starting and stopping the server, virtual hosts, and
applications.
■ Configuration commands: the getConfig2() command lets you view server
configuration keys, and the
setConfig2() command lets you set values for the keys.
Code Level Meaning
NetConnection.Call.Success Status
The call is successful.
This information object includes a
data
property, which returns detailed information
in an object or array.
NetConnection.Admin.CommandFailed Error
The method called is nonexistent.*
NetConnection.Call.Failed Error
A general failure has occurred.*
NetConnection.Call.BadValue Error
The value of a parameter is invalid.*
* This information object contains description and detail properties, which are strings that
provide a more specific reason for the failure.