com.tootsville.server
Class NightmareAMFServer

java.lang.Object
  org.red5.server.adapter.ApplicationAdapter
      com.tootsville.server.NightmareAMFServer

public class NightmareAMFServer
extends org.red5.server.adapter.ApplicationAdapter

The AMFServer class is designed to provide a portal from Red5 (acting as our "application server" or dispatcher in this context). The client Flash program calls these methods to make non-Smartfox changes to Tootsville-specific data. This is a temporary bridge for Project Nightmare, until Project Osiris can be put into production.

Author:

brpocock

Constructor Summary

NightmareAMFServer()

Method Summary

boolean	appConnect(IConnection conn, Object[] param) This is an overriding method.
Map<String,Object>	Auth_$_logout() This method closes the client's connection to Smartfox, forcibly.
Map<String,Object>	Avatar_$_getAvatar() TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Avatar_$_getAvatarParts(int itemTypeID, String name, String filename) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Avatar_$_getNoseColors(String userName, int pageSize, int pageNumber) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Avatar_$_getPatternColors(String userName, int pageSize, int pageNumber) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Avatar_$_getPatterns(String userName, int pageSize, int pageNumber) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Avatar_$_getPivotFilename(String userID) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Avatar_$_getSkin(String value) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Avatar_$_getSkinColors(String userName, int pageSize, int pageNumber) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Avatar_$_listAvatars() TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Avatar_$_removeActiveClothing() TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Avatar_$_setSkin(String userName, Colour skinColor, Colour hilightColor, Colour patternColor, String patternType) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Avatar_$_validateSkinData(Colour skinColor, Colour hilightColor, Colour patternColor, String patternType) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Buddies_$_addBuddy(String buddyName) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Buddies_$_addToBlockedUsers(String userName, String otherUser) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Buddies_$_deleteBuddy(String userName, String buddyName) TODO: document this method (brpocock, Jun 22, 2009)
String[]	Buddies_$_getBlockedUsers() TODO: document this method (brpocock, Jun 22, 2009)
String[]	Buddies_$_getBuddies() TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Buddies_$_removeFromBlockedUsers(String otherUser) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Common_$_getItemIDFromFileName(String filename) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Common_$_getItemIDFromName(String itemname) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Common_$_getSiteWideMessage() TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Common_$_getUserDetails() TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Common_$_getuserName(String value) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Common_$_staticuserID(String value) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	CustomerService_$_SendDebugNotice(String email, String subject, String message) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	CustomerService_$_SendNotice(String email, String subject, String message) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Events_$_eventCount(String today) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Events_$_fountainCount(String eventName, String today) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Events_$_getAllMedals() TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Events_$_getAllMedalsUpTo(String date) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Events_$_getHighScores(String eventTypeID, String timeRange, int nFields) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Events_$_getPassport() TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Events_$_getPeanuts() TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Events_$_registerAndUpdateEvent(String userName, String eventName, String points) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Events_$_registerAndUpdateFountain(String creatorName, String eventName, int points) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Events_$_registerEvent(String gameName) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Events_$_setMedals(String medalType, int eventID) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Events_$_setPassport(String room) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Games_$_getGameID(String name) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Games_$_getGameInfo(int gameID) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	getBotsForRoom(String roomName) Get the initialization data for the bots in this room.
private User	getUser() TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Home_$_addRoom(int roomID) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Home_$_addToRoomContents(String userName, int roomID, int itemID, double x, double y, String direction) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Home_$_getRoomContents(int roomID) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Home_$_getRoomDetails(int roomID) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Home_$_getRoomList() TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Home_$_getUserRoomItems(int userID) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Home_$_removeFromRoomContents(String userName, int roomID, int itemID, double x, double y, String direction) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Home_$_setUserRoomItems(int userID, String[] items) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Home_$_updateRoomContents(String userName, int roomID, ActionscriptObject allRoomObjects) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Inventory_$_getActiveItems() TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Inventory_$_getClothesList(String userName, int pageSize, int pageNumber) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Inventory_$_getClothesListCount(String userName, int pageSize) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Inventory_$_getInventoryList(String userName, int pageSize, int pageNumber, String itemTypeName) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Inventory_$_makeItemActive(String userName, int itemID) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Inventory_$_makeItemActiveViaFilename(String itemFileName) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Inventory_$_removeActiveItem(String userID, int itemTypeID) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Inventory_$_totalItemCount(String userName, String itemTypeName) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	isModerator() Was: Auth.isModerator TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	log_in_with_door_key(String doorKey) Was: Auth.loginModerator
Map<String,Object>	log_in(String userName, String password) Was: Auth.login TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Messaging_$_getMessage(int messageID) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Messaging_$_getUserBoxes() TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Messaging_$_listAllMessagesInBox(int boxID) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Messaging_$_markMessageAsRead(int messageID) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Messaging_$_sendMessage(String fromUserName, String toUserName, String subject, String body) TODO: document this method (brpocock, Jun 22, 2009)
boolean	start(IScope myScope) Start up the application
void	stop(IScope myScope) Shut down the application
Map<String,Object>	Store_$_getStoreInventory(int storeID, int pageNumber, int pageSize) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Store_$_listStores() TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	Store_$_purchase(String itemName) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	TootServer_$_GetZoneInfo(String zoneName) TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	TootServer_$_GetZoneTable() TODO: document this method (brpocock, Jun 22, 2009)
Map<String,Object>	updateParentMail(String parentMail) Was: Account.updateParentEMail Change the parental eMail associated with a kid's account
Map<String,Object>	UserAdmin_$_ReportUser(String badUser, String reportingUser, String zone, String room) TODO: document this method (brpocock, Jun 22, 2009)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NightmareAMFServer

public NightmareAMFServer()

Method Detail

appConnect

public boolean appConnect(IConnection conn,
                          Object[] param)

This is an overriding method.

See Also:

org.red5.server.adapter.MultiThreadedApplicationAdapter#appConnect(org.red5.server.api.IConnection, java.lang.Object[])

Auth_$_logout

public Map<String,Object> Auth_$_logout()

This method closes the client's connection to Smartfox, forcibly. This will cause the Smartfox connection to be closed by a server extension? I think?

Returns:

returnStatus=true, msg=user-visible message

Avatar_$_getAvatar

public Map<String,Object> Avatar_$_getAvatar()

TODO: document this method (brpocock, Jun 22, 2009)

Returns:

Avatar_$_getAvatarParts

public Map<String,Object> Avatar_$_getAvatarParts(int itemTypeID,
                                                  String name,
                                                  String filename)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

itemTypeID -

name -

filename -

Returns:

Avatar_$_getNoseColors

public Map<String,Object> Avatar_$_getNoseColors(String userName,
                                                 int pageSize,
                                                 int pageNumber)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userName -

pageSize -

pageNumber -

Returns:

Avatar_$_getPatternColors

public Map<String,Object> Avatar_$_getPatternColors(String userName,
                                                    int pageSize,
                                                    int pageNumber)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userName -

pageSize -

pageNumber -

Returns:

Avatar_$_getPatterns

public Map<String,Object> Avatar_$_getPatterns(String userName,
                                               int pageSize,
                                               int pageNumber)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userName -

pageSize -

pageNumber -

Returns:

Avatar_$_getPivotFilename

public Map<String,Object> Avatar_$_getPivotFilename(String userID)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userID -

Returns:

Avatar_$_getSkin

public Map<String,Object> Avatar_$_getSkin(String value)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

value -

Returns:

Avatar_$_getSkinColors

public Map<String,Object> Avatar_$_getSkinColors(String userName,
                                                 int pageSize,
                                                 int pageNumber)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userName -

pageSize -

pageNumber -

Returns:

Avatar_$_listAvatars

public Map<String,Object> Avatar_$_listAvatars()

TODO: document this method (brpocock, Jun 22, 2009)

Returns:

Avatar_$_removeActiveClothing

public Map<String,Object> Avatar_$_removeActiveClothing()

TODO: document this method (brpocock, Jun 22, 2009)

Returns:

Avatar_$_setSkin

public Map<String,Object> Avatar_$_setSkin(String userName,
                                           Colour skinColor,
                                           Colour hilightColor,
                                           Colour patternColor,
                                           String patternType)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userName -

skinColor -

hilightColor -

patternColor -

patternType -

Returns:

Avatar_$_validateSkinData

public Map<String,Object> Avatar_$_validateSkinData(Colour skinColor,
                                                    Colour hilightColor,
                                                    Colour patternColor,
                                                    String patternType)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

skinColor -

hilightColor -

patternColor -

patternType -

Returns:

Buddies_$_addBuddy

public Map<String,Object> Buddies_$_addBuddy(String buddyName)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

buddyName -

Returns:

Buddies_$_addToBlockedUsers

public Map<String,Object> Buddies_$_addToBlockedUsers(String userName,
                                                      String otherUser)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userName -

otherUser -

Returns:

Buddies_$_deleteBuddy

public Map<String,Object> Buddies_$_deleteBuddy(String userName,
                                                String buddyName)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userName -

buddyName -

Returns:

Buddies_$_getBlockedUsers

public String[] Buddies_$_getBlockedUsers()

TODO: document this method (brpocock, Jun 22, 2009)

Returns:

Buddies_$_getBuddies

public String[] Buddies_$_getBuddies()

TODO: document this method (brpocock, Jun 22, 2009)

Returns:

Buddies_$_removeFromBlockedUsers

public Map<String,Object> Buddies_$_removeFromBlockedUsers(String otherUser)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

otherUser -

Returns:

Common_$_getItemIDFromFileName

public Map<String,Object> Common_$_getItemIDFromFileName(String filename)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

filename -

Returns:

Common_$_getItemIDFromName

public Map<String,Object> Common_$_getItemIDFromName(String itemname)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

itemname -

Returns:

Common_$_getSiteWideMessage

public Map<String,Object> Common_$_getSiteWideMessage()

TODO: document this method (brpocock, Jun 22, 2009)

Returns:

Common_$_getUserDetails

public Map<String,Object> Common_$_getUserDetails()

TODO: document this method (brpocock, Jun 22, 2009)

Returns:

Common_$_getuserName

public Map<String,Object> Common_$_getuserName(String value)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

value -

Returns:

Common_$_staticuserID

public Map<String,Object> Common_$_staticuserID(String value)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

value -

Returns:

CustomerService_$_SendDebugNotice

public Map<String,Object> CustomerService_$_SendDebugNotice(String email,
                                                            String subject,
                                                            String message)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

email -

subject -

message -

Returns:

CustomerService_$_SendNotice

public Map<String,Object> CustomerService_$_SendNotice(String email,
                                                       String subject,
                                                       String message)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

email -

subject -

message -

Returns:

Events_$_eventCount

public Map<String,Object> Events_$_eventCount(String today)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

today -

Returns:

Events_$_fountainCount

public Map<String,Object> Events_$_fountainCount(String eventName,
                                                 String today)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

eventName -

today -

Returns:

Events_$_getAllMedals

public Map<String,Object> Events_$_getAllMedals()

TODO: document this method (brpocock, Jun 22, 2009)

Returns:

Events_$_getAllMedalsUpTo

public Map<String,Object> Events_$_getAllMedalsUpTo(String date)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

date -

Returns:

Events_$_getHighScores

public Map<String,Object> Events_$_getHighScores(String eventTypeID,
                                                 String timeRange,
                                                 int nFields)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

eventTypeID -

timeRange -

nFields -

Returns:

Events_$_getPassport

public Map<String,Object> Events_$_getPassport()

TODO: document this method (brpocock, Jun 22, 2009)

Returns:

Events_$_getPeanuts

public Map<String,Object> Events_$_getPeanuts()

TODO: document this method (brpocock, Jun 22, 2009)

Returns:

Events_$_registerAndUpdateEvent

public Map<String,Object> Events_$_registerAndUpdateEvent(String userName,
                                                          String eventName,
                                                          String points)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userName -

eventName -

points -

Returns:

Events_$_registerAndUpdateFountain

public Map<String,Object> Events_$_registerAndUpdateFountain(String creatorName,
                                                             String eventName,
                                                             int points)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

creatorName -

eventName -

points -

Returns:

Events_$_registerEvent

public Map<String,Object> Events_$_registerEvent(String gameName)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

gameName -

Returns:

Events_$_setMedals

public Map<String,Object> Events_$_setMedals(String medalType,
                                             int eventID)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

medalType -

eventID -

Returns:

Events_$_setPassport

public Map<String,Object> Events_$_setPassport(String room)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

room -

Returns:

Games_$_getGameID

public Map<String,Object> Games_$_getGameID(String name)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

name -

Returns:

Games_$_getGameInfo

public Map<String,Object> Games_$_getGameInfo(int gameID)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

gameID -

Returns:

getBotsForRoom

public Map<String,Object> getBotsForRoom(String roomName)

Get the initialization data for the bots in this room. The returned data contains:

• returnStatus: true on success, false on failure or no bots
• msg: user-visible message on failure, "OK" on success
• bots: an array of entries of Toot Bot initializers.

Each initializer contains the following attributes:

• botName
• pattern
• patternColor,noseColor,bodyColor = RGB precomposed colors for m_vShades[1,5,6]
• back, pants, shirt, pivitz = each .swf URI part based on "items/..."
• speech = array [n] of text to speak
• pos = either null (= random) or an object with x, y coord properties
• moveFreq = a frequency of movement, from 0 (never) to ???
• talkFreq = a frequency of talking, from 0 (never) to ???

Parameters:

roomName - The canonical name (Smartfox room name) for the room being queried

Returns:

Initializer data; see above

getUser

private User getUser()

TODO: document this method (brpocock, Jun 22, 2009)

Returns:

Home_$_addRoom

public Map<String,Object> Home_$_addRoom(int roomID)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

roomID -

Returns:

Home_$_addToRoomContents

public Map<String,Object> Home_$_addToRoomContents(String userName,
                                                   int roomID,
                                                   int itemID,
                                                   double x,
                                                   double y,
                                                   String direction)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userName -

roomID -

itemID -

x -

y -

direction -

Returns:

Home_$_getRoomContents

public Map<String,Object> Home_$_getRoomContents(int roomID)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

roomID -

Returns:

Home_$_getRoomDetails

public Map<String,Object> Home_$_getRoomDetails(int roomID)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

roomID -

Returns:

Home_$_getRoomList

public Map<String,Object> Home_$_getRoomList()

TODO: document this method (brpocock, Jun 22, 2009)

Returns:

Home_$_getUserRoomItems

public Map<String,Object> Home_$_getUserRoomItems(int userID)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userID -

Returns:

Home_$_removeFromRoomContents

public Map<String,Object> Home_$_removeFromRoomContents(String userName,
                                                        int roomID,
                                                        int itemID,
                                                        double x,
                                                        double y,
                                                        String direction)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userName -

roomID -

itemID -

x -

y -

direction -

Returns:

Home_$_setUserRoomItems

public Map<String,Object> Home_$_setUserRoomItems(int userID,
                                                  String[] items)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userID -

items -

Returns:

Home_$_updateRoomContents

public Map<String,Object> Home_$_updateRoomContents(String userName,
                                                    int roomID,
                                                    ActionscriptObject allRoomObjects)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userName -

roomID -

allRoomObjects -

Returns:

Inventory_$_getActiveItems

public Map<String,Object> Inventory_$_getActiveItems()

TODO: document this method (brpocock, Jun 22, 2009)

Returns:

Inventory_$_getClothesList

public Map<String,Object> Inventory_$_getClothesList(String userName,
                                                     int pageSize,
                                                     int pageNumber)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userName -

pageSize -

pageNumber -

Returns:

Inventory_$_getClothesListCount

public Map<String,Object> Inventory_$_getClothesListCount(String userName,
                                                          int pageSize)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userName -

pageSize -

Returns:

Inventory_$_getInventoryList

public Map<String,Object> Inventory_$_getInventoryList(String userName,
                                                       int pageSize,
                                                       int pageNumber,
                                                       String itemTypeName)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userName -

pageSize -

pageNumber -

itemTypeName -

Returns:

Inventory_$_makeItemActive

public Map<String,Object> Inventory_$_makeItemActive(String userName,
                                                     int itemID)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userName -

itemID -

Returns:

Inventory_$_makeItemActiveViaFilename

public Map<String,Object> Inventory_$_makeItemActiveViaFilename(String itemFileName)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

itemFileName -

Returns:

Inventory_$_removeActiveItem

public Map<String,Object> Inventory_$_removeActiveItem(String userID,
                                                       int itemTypeID)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userID -

itemTypeID -

Returns:

Inventory_$_totalItemCount

public Map<String,Object> Inventory_$_totalItemCount(String userName,
                                                     String itemTypeName)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userName -

itemTypeName -

Returns:

isModerator

public Map<String,Object> isModerator()

Was: Auth.isModerator TODO: document this method (brpocock, Jun 22, 2009)

Returns:

log_in

public Map<String,Object> log_in(String userName,
                                 String password)

Was: Auth.login TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

userName - The login/user name (string)

password - The user's password (string)

Returns:

Hash with "returnStatus" of true if successful; "msg" as the user-visible status.

log_in_with_door_key

public Map<String,Object> log_in_with_door_key(String doorKey)

Was: Auth.loginModerator

Parameters:

doorKey - The one-time door key code for the login

Returns:

a table with returnStatus = true on success, = false on failure, with msg = the user-visible message explaining the status

Messaging_$_getMessage

public Map<String,Object> Messaging_$_getMessage(int messageID)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

messageID -

Returns:

Messaging_$_getUserBoxes

public Map<String,Object> Messaging_$_getUserBoxes()

TODO: document this method (brpocock, Jun 22, 2009)

Returns:

Messaging_$_listAllMessagesInBox

public Map<String,Object> Messaging_$_listAllMessagesInBox(int boxID)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

boxID -

Returns:

Messaging_$_markMessageAsRead

public Map<String,Object> Messaging_$_markMessageAsRead(int messageID)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

messageID -

Returns:

Messaging_$_sendMessage

public Map<String,Object> Messaging_$_sendMessage(String fromUserName,
                                                  String toUserName,
                                                  String subject,
                                                  String body)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

fromUserName -

toUserName -

subject -

body -

Returns:

start

public boolean start(IScope myScope)

Start up the application

Parameters:

myScope - application container scope

stop

public void stop(IScope myScope)

Shut down the application

Parameters:

myScope - application container scope

Store_$_getStoreInventory

public Map<String,Object> Store_$_getStoreInventory(int storeID,
                                                    int pageNumber,
                                                    int pageSize)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

storeID -

pageNumber -

pageSize -

Returns:

Store_$_listStores

public Map<String,Object> Store_$_listStores()

TODO: document this method (brpocock, Jun 22, 2009)

Returns:

Store_$_purchase

public Map<String,Object> Store_$_purchase(String itemName)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

itemName -

Returns:

TootServer_$_GetZoneInfo

public Map<String,Object> TootServer_$_GetZoneInfo(String zoneName)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

zoneName -

Returns:

TootServer_$_GetZoneTable

public Map<String,Object> TootServer_$_GetZoneTable()

TODO: document this method (brpocock, Jun 22, 2009)

Returns:

updateParentMail

public Map<String,Object> updateParentMail(String parentMail)

Was: Account.updateParentEMail Change the parental eMail associated with a kid's account

Parameters:

parentMail - the new eMail address of the kid's parent[s]

Returns:

result object for ActionScript as a map

UserAdmin_$_ReportUser

public Map<String,Object> UserAdmin_$_ReportUser(String badUser,
                                                 String reportingUser,
                                                 String zone,
                                                 String room)

TODO: document this method (brpocock, Jun 22, 2009)

Parameters:

badUser -

reportingUser -

zone -

room -

Returns: