getApps()

RTMP/E

 getApps([verbose:Boolean][, force:Boolean]):Object

HTTP

 http://www.example.com:1111/admin/getApps?auser=username&apswd=password[&verbose=true|false[&force=true|false]]

Returns an array of strings that contains the names of all the applications that are installed. Call addApp() or removeApp() to refresh the cached application list.

Note:

Applications that are added or removed using the file system are not reflected in the cached list.

Availability

Flash Communication Server 1.0. The verbose and force parameters are available in Flash Media Server 3.0

Parameters

verbose

Boolean; true displays all the applications under a virtual host; false displays the total number of applications. The default value is true.

force

Boolean; true forces a refresh of the cached list of applications and retrieves the list; false retrieves a cached list of applications. If you want to force a refresh, you must specify both the verbose and force parameters. The default value is false.

auser

A String indicating the user name of the administrator.

apswd

A String indicating the password of the administrator.

Returns

RTMP/E

If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an array of strings containing the names of all the applications that are installed.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP

If the call succeeds, it returns XML with the following structure:

 <result>   <level>status</level>   <code>NetConnection.Call.Success</code>   <timestamp>7/23/2007 9:10:37 AM</timestamp>   <data>   <total_apps>3</total_apps>   <_0>live</_0>   <_1>livetest</_1>   <_2>vod</_2>   </data>  </result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call. Some XML might also have a description element that contains a string describing the cause of the failure.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

See also

Get help faster and easier

New user?