Java API Reference

AppWarp Request/Response/Notify SDK model

Before going through the below API reference, it is recommended to take a quick look at SDK model link above.

WarpClient APIs

###initialize

   public static void initialize(String apiKey, String privateKey)

Initializes the singleton instance of WarpClient with the developer credentials

Parameters

apiKey - The Application key given when the application was created.
secretKey - The secret key corresponding to the application key given when the application was created.

Returns

void

###setRecoveryAllowance

public static void setRecoveryAllowance(int maxRecoveryTime)

Sets the connection recovery time (seconds) allowed that will be negotiated with the server. By default it is 0 so there is no connection recovery. During this time, the state of the user on the server will be paused and if the connection is not recovered in this period, it will be considered disconnected and will be removed from the room. It is important you invoke this right after you initialize the WarpClient and before you make your first call to connect. Recommended values are between 60 to 120 i.e. 1 minute to 2 minutes.

Parameters

maxRecoveryTime- time in seconds allowed for the client to recover

Returns

void

###connectWithUserName

  public void connectWithUserName(String username)

Sets up your connection with the AppWarp cloud server. The username passed in this method must be unique across all other concurrently connected users. If two users with the same name try to connect at the same time, then the last one will win and the older one will get disconnected. The result of the operation is provided in the onConnectDone callback of the ConnectionRequestListener.

Parameters

username - Username of the player

Returns

void

###RecoverConnection

public void RecoverConnection()

Attempts to recover the previous connection if it was broken with a recoverable connection error event was raised. If connectivity is not there at the time of calling, it will again raise a recoverable connection error event ( guaranteed within 6 seconds ) and the application can choose to recover again immediately or after a while (back off period). The server may reject the recover request if received after the recovery allowance time negotiated. The result of the operation is provided in the onConnectDone callback of the ConnectionRequestListener. If successful, the result code is SUCCESS_RECOVERED.

Parameters

Returns

void

###disconnect

    public void disconnect()

Disconnects the connection with the AppWarp server. The result for this request will be provided in the onDisConnectDone callback of the ConnectionRequestListener.

Parameters

Returns

void

###joinLobby

   public void joinLobby()

Sends a join lobby request to the server. Result of the request is provided in the onJoinLobbyDone callback of the registered LobbyRequestListener objects.

Parameters

Returns

void

###leaveLobby

    public void leaveLobby()

Sends a leave lobby request to the server. Result of the request is provided in the onLeaveLobbyDone callback of the registered LobbyRequestListener objects.

Parameters

Returns

void

###subscribeLobby

    public void subscribeLobby()

Sends a subscribe lobby request to the server. Result of the request is provided in the onSubscribeLobbyDone callback of the registered LobbyRequestListener objects. Users which have subscribed to the lobby receive chat events from other users in the lobby as well as join/leave notifications about all players to and fro the lobby and all the rooms. In addition, lobby subscribers get notifications when a new room is created or deleted. All these notification events are given in the registered NotifyListener objects.

Parameters

Returns

void

###unsubscribeLobby

    public void unsubscribeLobby()

Sends a unsubscribe lobby request to the server. Result of the request is provided in the onUnsubscribeLobbyDone callback of the LobbyRequestListener.

Parameters

Returns

void

###joinRoom

    public void joinRoom(String roomId)

Sends a join room request to the server. Result of the request is provided in the onJoinRoomDone callback of the registered RoomRequestListener objects. A user can only be joined in one location (room or lobby) at a time. If a user joins a room, it will automatically be removed from its current location.

Parameters

roomId - Id of the room to be joined

Returns

void

###joinRoomWithNUser

    public void joinRoomWithNUser(int userCount)

Sends a join room request to the server with the condition that the room must have at least the given number of users. Result of the request is provided in the onJoinRoomDone callback of the registered RoomRequestListener. This is useful is supporting quick play modes.

Parameters

userCount- number of users in room to be joined

Returns

void

###joinRoomInRange

    public void joinRoomInRange(int minUesrs, int maxUesrs, boolean maxPreferred)

Sends a join room request to the server with the condition that the room must have at least minUsers and at Most maxUsers. Result of the request is provided in the onJoinRoomDone callback of the registered RoomRequestListener. This is useful is supporting quick play modes.

Parameters

minUsers- number of minimum users in room to be joined

maxUsers- number of maximum users in room to be joined

maxPreferred- flag to specify search priority for room to be joined

Returns

void

###joinRoomWithProperties

    public void joinRoomWithProperties(Hashtable<String,Object> tableProperties)

Sends a join room request to the server with the condition that the room must have a matching set of property value pairs associated with it. This is useful in match making. Result of the request is provided in the onJoinRoomDone callback of the registered RoomRequestListener.

Parameters

tableProperties- properties of the room to be joined

Returns

void

###leaveRoom

    public void leaveRoom(String roomId)

Sends a leave room request to the server. Result of the request is provided in the onLeaveRoomDone callback of the registered RoomRequestListener.

Parameters

roomId - Id of the room to be left

Returns

void

###createRoom

    public void createRoom(String name, String owner, int maxUsers,Hashtable<String,Object> tableProperties)

Sends a create room request to the server with the given meta data. Result of the request is provided in the onCreateRoomDone callback of the registered ZoneRequestListener objects. If successful, this will create a dynamic room at the server. These rooms lifetime is limited till the time users are inside it. Read more about Rooms here.

Parameters

name - name of the room
owner - administrator of the room
maxUsers - number of maximum users allowed in the room
tableProperties - properties of room for matchmaking (pass null if not required)

Returns

void

###createTurnRoom

Sends a create turn based room request to the server with the given meta data. Result of the request is provided in the onCreateRoomDone callback of the registered ZoneRequestListener objects. If successful, this will create a dynamic turn based room at the server. These rooms lifetime is limited till the time users are inside it. Read more about Rooms here.

    public void createTurnRoom(String name, String owner, int maxUsers, Hashtable<String, Object> tableProperties, int turnTime)

Parameters

name - name of the room
owner - owner of the room (behavior and usage of this meta property is up to the developer)
maxUsers - number of maximum users allowed in the room
tableProperties - properties of room (can be null)
turnTime - the time (in seconds) allowed for a user to complete its turn and send a move.

Returns

void

###sendMove

Sends a move to the server for the joined turn based room.Result of the request is provided in the onSendMoveDone callback of the registered TurnBasedRoomListener objects. If the joined user is not a turn based room or if its not the users turn, this request will fail. If successful, this will result in onMoveCompleted notification for all the subscribed users on the registered NotifyListener objects.

    public void sendMove(String moveData)

Parameters

moveData - any meta data associated with the move

Returns

void

###deleteRoom

    public void deleteRoom(String roomId)

Sends a delete room request to the server. Result of the request is provided in the onDeleteRoomDone callback of the registered ZoneRequestListener objects. Only dynamic rooms can be deleted through this API. Static rooms (created from AppHQ) can not be deleted through this. Read more about Rooms here.

Parameters

roomId - Id of the room to be deleted

Returns

void

###subscribeRoom

    public void subscribeRoom(String roomId)

Sends a subscribe room request to the server. Result of the request is provided in the onSubscribeRoomDone callback of the registered RoomRequestListener objects. Once subscribed, the client will receive all notifications from the room such as chat, update and property change events. In addition the client will also receive notifications when a user joins or leaves the subscribed room. These notifications are given in the registered NotifyListener objects.

Parameters

roomId - Id of the room to be subscribed

Returns

'void'

###unsubscribeRoom

    public void unsubscribeRoom(String roomId)

Sends a unsubscribe room request to the server. Result of the request is provided in the onUnSubscribeRoomDone callback of the registered RoomRequestListener objects.

Parameters

roomId - Id of the room to be subscribed

Returns

void

###sendChat

    public void sendChat(String message)

Sends a chat message to the room (or lobby) in which the user is currently joined. Result of the request is provided in the onSendChatDone callback of the registered ChatRequestListener objects. All users who are subscribed to the location in which the message is sent will get a onChatReceived event on their registered NotifyListener objects.

Parameters

message - message to be send

Returns

void

###SendPrivateChat

Sends a private message to the given user if its online. Result of the request is provided in the onSendPrivateChatDone callback of the registered ChatRequestListener objects. The sender and receiver don't need to be in the same room or lobby for the private message to be delivered. This is useful in building invite/challenge friend like scenarios. If successful, the receiver will get a onPrivateChatReceived event on its registered NotifyListener objects.

    public void sendPrivateChat(String username, String message)

Parameters

username - recipient of the message

message - message to be send

Returns

void

###sendUpdatePeers

    public void sendUpdatePeers(byte[] update)

Sends a byte array update message to room in which the user is currently joined. Result of the request is provided in the onSendUpdateDone callback of the registered UpdateRequestListener objects. All users who are subscribed to the room in which the update is sent will get a onUpdatePeersReceived event on their registered NotifyListener objects. This is useful if developers want to send their own binary encoded data across and is useful in minimizing the payload exchanged between the clients and AppWarp cloud server. The size of each message should be limited to 1000 bytes. The frequency at which these messages can be processed is not restricted by the server. However, the latency involved is largely determined by the client's bandwidth. The corresponding UDP flavor of this API is sendUdpUpdatePeers, which is unreliable and may not work over cellular data connections - hence no result callback should be expected from it. The behavior is otherwise similar.

Parameters

update - binary data to be send

Returns

void

###getLiveRoomInfo

    public void getLiveRoomInfo(String roomId)

Retrieves the live information of the given room from the server. Result is provided in the onGetLiveRoomInfoDone callback of the registered RoomRequestListener objects. The information includes the names of the currently joined users, the rooms properties and any associated customData. This is useful in getting a snapshot of a rooms state.

Parameters

roomId - Id of the room

Returns

void

###getLiveUserInfo

    public void getLiveUserInfo(String username)

Retrieves the live information of the user from the server. Result is provided in the onGetLiveUserInfo callback of the registered ZoneRequestListener objects. The information (if user is online) includes the current location of the user and any associated custom data. It is useful in building scenarios where you want to find if a users friends are online or not and then join their room if found online.

Parameters

username - user who's information is requested

Returns

void

###getLiveLobbyInfo

    public void getLiveLobbyInfo()

Retrieves live information of the lobby from the server. Result is provided in the onGetLiveLobbyInfo callback of the registered LobbyRequestListener objects. The information returned includes the names of the users who are currently joined in the lobby.

Parameters

Returns

void

###setCustomUserData

    public void setCustomUserData(String userName, String customData)

Updates the custom data associated with the given user on the server (if the given user is online). Result is provided in the onSetCustomUserDataDone callback of the registered ZoneRequestListener objects. It can be useful in setting status messages or avatar url's etc for online users.

Parameters

userName - user for whom custom data has to be update
customData - custom data that will be set for the user

Returns

void

###setCustomRoomData

Updates the custom data associated with the given room on the server. The result is provided in the onSetCustomRoomDataDone callback of the registered RoomRequestListener objects. It is recommended you use the room's properties where ever possible. Use this when you need to associate data with a room which can not be represented as key value pairs.

    public void SetCustomRoomData(String roomId, String customRoomData)

Parameters

roomId - Id of the room
customRoomData - custom data that will be set for the room

Returns

void

###updateRoomProperties

   public void updateRoomProperties(String roomID, Hashtable<String,Object> tableProperties, String[] removeArray)

Updates the properties associated with the given room on the server. Result is provided in the onUpdatePropertyDone callback of the registered RoomRequestListener objects. Properties which are not found on the server, will be added while properties which are already present will simply be updated with the new values. You can also specify the list of properties that you want to remove from the remove. Update property will fail if any other user has lock on same property that you are going to update or remove. This request (if successful) will also result in an onUserChangeRoomProperty notification on the registered NotifyListener objects to be triggered for all subscribed users of the room.

Parameters

roomId - Id of the room
tableProperties - properties that will be set for the room
removeArray - properties that will be removed for the room

Returns

void

###lockProperties

   public void lockProperties(Hashtable<String,Object> tableProperties)

Lock the properties associated with the joined room on the server for requested user. Result is provided in the onLockPropertyDone callback of the registered RoomRequestListener objects. Lock properties will fail if any other user has lock on same property, otherwise property will be added in lockTable with owner name. This request (if successful) will also result in an onUserChangeRoomProperty notification on the registered NotifyListener objects to be triggered for all subscribed users of the room.

Parameters

lockProperties - properties to be lock for the room

Returns

void

###unlockProperties

   public void lockProperties(String[] unlockProperties)

Unlock the properties associated with the joined room on the server for requested user. Result is provided in the onUnlockPropertyDone callback of the registered RoomRequestListener objects. Unlock properties will fail if any other user has lock on same property, otherwise property will be removed from lock table. This request (if successful) will also result in an onUserChangeRoomProperty notification on the registered NotifyListener objects to be triggered for all subscribed users of the room.

Parameters

unlockProperties - properties to be unlock for the room

Returns

void

###getOnlineUsers

    public void getOnlineUsers()

Retrieves usernames of all the users connected (online) to the server. Result is provided in the onGetOnlineUsers callback of the registered ZoneRequestListener objects.

Parameters

Returns

void

###getAllRooms

    public void getAllRooms()

Retrieves the room ids of all the rooms on the server. Result is provided in the onGetAllRoomsDone callback of the registered ZoneRequestListener objects. To get a filtered list of rooms, use the GetRoomWithNUser or GetRoomWithProperties APIs.

Parameters

Returns

void

###getRoomWithNUser

    public void getRoomWithNUser(int userCount)

Retrieves information of the rooms that contain at least n users in them. Result is provided in the onGetMatchedRoomsDone callback of the registered ZoneRequestListener objects. This is useful in building a filtered list of rooms.

Parameters

userCount- number of users in room to be joined

Returns

void

###getRoomInRange

    public void getRoomInRange(int minUsers, int maxUsers)

Retrieves information of the rooms that contain at least minUsers and at most maxUsers in them. Result is provided in the onGetMatchedRoomsDone callback of the registered ZoneRequestListener objects. This is useful in building a filtered list of rooms.

Parameters

minUsers- number of minimun users in room to be joined

maxUsers- number of maximum users in room to be joined

Returns

void

###getRoomWithProperties

    public void getRoomWithProperties(Hashtable<String,Object> properties)

Retrieves information of the room that contain properties which match with the given properties. Result is provided in the onGetMatchedRoomsDone callback of the registered ZoneRequestListener objects. This is useful in building a filtered list of rooms.

Parameters

properties- properties of the room to be joined

Returns

void

###addConnectionRequestListener

   public void addConnectionRequestListener(ConnectionRequestListener listener)

Adds (registers) the given listener object to the list of objects on which callbacks will be invoked when a response from the server is received for Connect and Disconnect APIs. The object must implement the ConnectionRequestListener interface.

Parameters

listener - method for listening to the request

Returns

void

###addZoneRequestListener

  public void addZoneRequestListener(ZoneRequestListener listener)

Adds (registers) the given listener object to the list of objects on which callbacks will be invoked when a response from the server is received for zone level requests such as create/delete room or live user info requests. The object must implement the ZoneRequestListener interface.

Parameters

listener - method for listening to the request

Returns

void

###addRoomRequestListener

   public void addRoomRequestListener(RoomRequestListener listener)

Adds (registers) the given listener object to the list of objects on which callbacks will be invoked when a response from the server is received for requests pertaining to a room. The object must implement the RoomRequestListener interface.

Parameters

listener - method for listening to the request

Returns

void

###addLobbyRequestListener

public void addLobbyRequestListener(LobbyRequestListener listener)

Adds (registers) the given listener object to the list of objects on which callbacks will be invoked when a response from the server is received for lobby level request. The object must implement the LobbyRequestListener interface.

Parameters

listener - method for listening to the request

Returns

void

###addNotificationListener

  public void addNotificationListener(NotifyListener listener)

Adds (registers) the given listener object to the list of objects on which callbacks will be invoked when a notification is received from the server from any subscribed location (room or lobby). The object must implement the NotifyListener interface.

Parameters

listener - method for listening to the request

Returns

void

###addUpdateRequestListener

Adds (registers) the given listener object to the list of objects on which callbacks will be invoked when a response from the server is received for a SendUpdatePeers request. The object must implement the UpdateRequestListener interface.

    public void addUpdateRequestListener(UpdateRequestListener listener)

Parameters

listener - method for listening to the request

Returns

void

###getConnectionState

Returns the current connection state of the WarpClient instance. The values returned are according to the following.

int CONNECTED = 0;
int CONNECTING = 1;
int DISCONNECTED = 2;
int DISCONNECTING = 3;
int RECOVERING = 4;

    public int getConnectionState()

Parameters

void

Returns

int

###AddTurnBasedRoomRequestListener

Adds (registers) the given listener object to the list of objects on which callbacks will be invoked when a response from the server is received for a SendMove request. The object must implement the TurnBasedRoomListener interface.

    public void AddTurnBasedRoomRequestListener(TurnBasedRoomListener listener)

Parameters

listener - listener object

Returns

void

WarpClient Events

###AllRoomsEvent

This event is raised in response to the getAllRooms request. It is passed in the registered ZoneRequestListener's onGetAllRoomsDone request. It exposes the following properties

byte result - Result status of the request.
String[] roomIds - room id array of all the rooms.

public byte getResult();

public String[] getRoomIds();

###AllUsersEvent

This event is raised in response to the getOnlineUsers request. It is passed in the registered ZoneRequestListener's onGetOnlineUsersDone method. It exposes the following properties

byte result - Result status of the request.
String[] usernames - array of usernames for all the online users.

public byte getResult();

public String[] getUserNames();

Represents an array of usernames for all the online users if the request is successful.

###ChatEvent

This event is raised when a chat notification is received from a subscribed location such as room or lobby. It is passed in registered NotifyListener's onChatReceived method. It exposes the following properties

String message - The string message sent by the sender.
String sender - The sender of the message.
String locationId - The id of the location in which the message was sent (eg: room id)
boolean isLocationLobby - Is the location a room or lobby.

public String getSender();

public String getMessage();

public String getLocationId();

public bool isLocationLobby();

###ConnectEvent

This event is raised in response to a connectWithUsername request. It is passed in the registered ConnectionRequestListener's onConnectDone method. It exposes the following properties

byte result - Result status of the request.

public byte getResult();

###LiveRoomInfoEvent

This event is raised in response to the getLiveRoomInfo or getLiveLobbyInfo request. It is passed in the registered RoomRequestListener's onGetLiveRoomInfoDone method and in the LobbyRequestListener's onGetLiveLobbyInfoDone method. It exposes the following properties

String[] joinedUsers - Array of usernames who are joined in the room
String customData - Custom data associated with the room
Hashtable<String,Object> properties - Properties associated with the room (empty for lobby).
RoomData data - The static information structure of the room (or lobby).
byte result - Result status of the request.

public RoomData getData();

public byte getResult();

public String[] getJoinedUsers();

public String getCustomData();

public Dictionary<String, Object> getProperties();

###LiveUserInfoEvent

This event is raised in response to the getLiveUserInfo request. It is passed in the registered ZoneRequestListener's onGetLiverUserInfo request method. It exposes the following properties

byte result - Result status of the request.
String locationId - The id of the location in which the user is present.
String name - The username of the user
String customData - The custom data associated with the user
boolean isLocationLobby - Is the users location a room or a lobby.

public byte getResult();

public bool isLocationLobby();

public String getLocationId();

public String getName();

public String getCustomData();

###LobbyData

This represents a construct for holding lobby information. It exposes the following properties

String Id - The id of the lobby. This is always 0 and is reserved for future if multi-lobby support is added.
String owner - The owner of the lobby.
int maxUsers - The max concurrent users allowed in the lobby.
String name - The name of the lobby.
boolean isPrimary - Is the lobby the primary one. This is always true and is reserved for future if multi-lobby support is added.

public String getId();

public String getRoomOwner();

public String getName();

public int getMaxUsers();

public Boolean isPrimary();

###LobbyEvent

This event is raised in response to requests for join/leave/subscribe/unsubscribe lobby. It is passed in the corresponding methods of the registered LobbyRequestListener. It exposes the following properties.

byte result - Result status of the request.
LobbyData data - The static information structure of the lobby.

public LobbyData getInfo();

public byte getResult();

###RoomData

This represents a construct for holding room information. It exposes the following properties

String roomId - Unique id of a room. It is unique across all the rooms.
String owner - owner of the room (behavior and usage of this meta property is up to the developer)
int maxUsers - number of maximum users allowed in the room
String name - name of the room

public String getId();

public String getRoomOwner();

public String getName();

public int getMaxUsers();

###RoomEvent

This event is raised in response to requests for join/leave/subscribe/unsubscribe room. It is passed in the corresponding methods of the registered RoomRequestListener. It exposes the following properties.

RoomData data - The static information structure of the room.
byte result - Result status of the request.

public RoomData getData();

public byte getResult();

###UpdateEvent

This event is raised when a updatePeers notification is received from a subscribed location such as room or lobby. It is passed in registered NotifyListener's onUpdatePeersReceived method. It exposes the following properties.

byte[] update - The byte array sent in the room.
boolean isUDP - Flag to indicate whether the byte array was sent using UDP or TCP.

public byte[] getUpdate();

public bool getIsUdp();

###MatchedRoomEvent

This event is raised in response to requests for matchmaking request(getRoomwithNUsers/getRoomWithProperties). It is passed in the corresponding methods of the registered ZoneRequestListener. It exposes the following properties.

byte[] result - Result status of the request.
RoomData[] roomData - Array RoomData objects representing each of the matched rooms.

public byte getResult();

public RoomData[] getRoomsData();

###MoveEvent

This event is raised when a move completed notification is received from a subscribed turn based room. It is passed in registered NotifyListener's onMoveCompleted method. It exposes the following properties

String moveData - The associated move data.
String sender - The sender of the move.
String RoomId - The id of the room in which the move was sent
String nextTurn - The username of the user whose turn it is now

public String getSender();

public String getMoveData();

public String getRoomId();

public bool getNextTurn();

WarpClient Listeners

###ConnectionRequestListener

    /**
     * Invoked in response to a connect request.
     * @param event
     */
    public void onConnectDone(ConnectEvent event);

    /**
     * Invoked in response to a disconnect request.
     * @param event
     */
    public void onDisconnectDone(ConnectEvent event);

###RoomRequestListener

    /**
     * Invoked in response to a subscribeRoom request.
     * @param event
     */
    public void onSubscribeRoomDone(RoomEvent event);
    /**
     * Invoked in response to a UnSubscribeRoom request.
     * @param event
     */
    public void onUnSubscribeRoomDone(RoomEvent event);
    /**
     * Invoked in response to a joinRoom request.
     * @param event
     */
    public void onJoinRoomDone(RoomEvent event);
    /**
     * Invoked in response to a leaveRoom request.
     * @param event
     */
    public void onLeaveRoomDone(RoomEvent event);
    /**
     * Invoked in response to a getLiveRoomInfo request.
     * @param event
     */
    public void onGetLiveRoomInfoDone(LiveRoomInfoEvent event);
    /**
     * Invoked in response to a setCustomRoomData request.
     * @param event
     */
    public void onSetCustomRoomDataDone(LiveRoomInfoEvent event);
    /* 
     * Invoked in response to add property to any room
     */
    public void onUpdatePropertyDone(LiveRoomInfoEvent event);
    /* 
     * Invoked in response to lock property to any room
     */
    public void onLockPropertiesDone(byte result);
    /* 
     * Invoked in response to unlock property to any room
     */
    public void onUnlockPropertiesDone(byte result);

###ZoneRequestListener

    /**
     * Invoked in response to a deleteRoom request.
     * @param event
     */
    public void onDeleteRoomDone(RoomEvent event);
    /**
     * Invoked in response to a getAllRooms request.
     * @param event
     */
    public void onGetAllRoomsDone(AllRoomsEvent event);
    /**
     * Invoked in response to a createRoom request.
     * @param event
     */
    public void onCreateRoomDone(RoomEvent event);
    /**
     * Invoked in response to a getOnlineUsers request.
     * @param event
     */
    public void onGetOnlineUsersDone(AllUsersEvent event);
    /**
     * Invoked in response to a getLiveUserInfo request.
     * @param event
     */
    public void onGetLiveUserInfoDone(LiveUserInfoEvent event);
    /**
     * Invoked in response to a setCustomRoomData request.
     * @param event
     */
    public void onSetCustomUserDataDone(LiveUserInfoEvent event);
    
     /**
     * Invoked in response to a getMatchMaking Rooms request.
     * @param event
     */
    public void onGetMatchedRoomsDone(MatchedRoomsEvent event);

###LobbyRequestListener

    /**
     * Invoked in response to a joinLobby request.
     * @param event
     */
    public void onJoinLobbyDone(LobbyEvent event);
    /**
     * Invoked in response to a leaveLobby request.
     * @param event
     */
    public void onLeaveLobbyDone(LobbyEvent event);
    /**
     * Invoked in response to a subscribeLobby request.
     * @param event
     */
    public void onSubscribeLobbyDone(LobbyEvent event);
    /**
     * Invoked in response to a UnSubscribeLobby request.
     * @param event
     */
    public void onUnSubscribeLobbyDone(LobbyEvent event);
    /**
     * Invoked in response to a getLiveLobbyInfo request.
     * @param event
     */
    public void onGetLiveLobbyInfoDone(LiveRoomInfoEvent event);

###UpdateRequestListener

    /**
     * Result of SendUpdatePeers request. The result value maps to a WarpResponseResultCode
     * @param result
     */
    public void onSendUpdateDone(byte result);

###ChatRequestListener

    /**
     * Result of sendChat request. The result value maps to a WarpResponseResultCode
     * @param result
     */
    public void onSendChatDone(byte result);
    /**
     * Invoked when a response for sendPrivateChat is received. Result of the 
     * operation is passed as an argument of value WarpResponseResultCode.
     * @param result
     */
    public void onSendPrivateChatDone(byte result);

###NotifyListener

    /**
     * Invoked when a room is created. Lobby subscribers will receive this.
     * @param event
     */
    public void onRoomCreated(RoomData event);
    /**
     * Invoked when a room is deleted. Lobby subscribers will receive this.
     * @param event
     */
    public void onRoomDestroyed(RoomData event);
    /**
     * Invoked when a user leaves a room. Lobby and the concerned room subscribers 
     * will receive this.
     * @param event
     * @param username
     */
    public void onUserLeftRoom(RoomData event, String username);
    /**
     * Invoked when a user joins a room. Lobby and the concerned room subscribers 
     * will receive this.
     * @param event
     * @param username
     */
    public void onUserJoinedRoom(RoomData event, String username);

    /**
     * Invoked when a user leaves a lobby. Lobby subscribers will receive this.
     * @param event
     * @param username
     */
    public void onUserLeftLobby(LobbyData event, String username);
    /**
     * Invoked when a user joins a lobby. Lobby subscribers will receive this.
     * @param event
     * @param username
     */
    public void onUserJoinedLobby(LobbyData event, String username);    
    /**
     * Invoked when a joined user sends a chat. Rooms subscribers will receive this.
     * @param event
     */
    public void onChatReceived(ChatEvent event);
    /**
     * Invoked when a private chat is received from the given sender.
     * @param sender
     * @param message
     */
    public void onPrivateChatReceived(String sender, String message);
    /**
     * Invoked when a updatePeers request is sent in one of the subscribed rooms.
     * @param event
     */ 
    public void onUpdatePeersReceived(UpdateEvent event);
    /**
     * Invoked when a user changes the properties of a subscribed room property. 
     * @param event
     * @param username
     * @param properties
     * @param lockProperties
     */
    public void onUserChangeRoomProperty(RoomData event, String username, Hashtable<String, Object> properties, Hashtable<String, String> lockProperties);
    /**
     * Invoked when a user's move is completed in a turn based room
     * @param moveEvent
     */
    public void onMoveCompleted(MoveEvent moveEvent);

    /**
     * Invoked to indicate that a user has lost connectivity. Subscribers of the users location 
     * will receive this.
     * @param locid
     * @param isLobby
     * @param username
     */
    public void onUserPaused(String locid, boolean isLobby, String username);
    /**
     * Invoked when a user's connectivity is restored. Subscribers of the users location 
     * will receive this.
     * @param locid
     * @param isLobby 
     * @param username
     */
    public void onUserResumed(String locid, boolean isLobby, String username);

###TurnBasedRoomListener

	/**
	* Invoked when a response for a sendMove request is received.
	*/ @param result
	void onSendMoveDone(byte result);

WarpClient Event Result Codes

    public static final byte SUCCESS = 0;    
    public static final byte AUTH_ERROR = 1;    
    public static final byte RESOURCE_NOT_FOUND = 2;    
    public static final byte RESOURCE_MOVED = 3;     
    public static final byte BAD_REQUEST = 4;
    public static final byte CONNECTION_ERROR = 5;
    public static final byte UNKNOWN_ERROR = 6;
    public static final byte RESULT_SIZE_ERROR = 7;
    public static final byte SUCCESS_RECOVERED = 8;
    public static final byte CONNECTION_ERROR_RECOVERABLE = 9;

SUCCESS

The request was successfully received and processed by the server.

AUTH_ERROR

The session id sent in the request was incorrect. This can happen if the client connects without initializing with the correct keys.

RESOURCE_NOT_FOUND

The resource for which the request was intended is not known to the server. For example a bad room id is given to a joinRoom request.

RESOURCE_MOVED

The resource for which the request was intended to has moved to a state where it can't process the request. For example, if a client sends a chat or updatePeers message and the connected user is not present in any room.

UNKNOWN_ERROR

This is an unexpected error. Retrying the request is recommended if this happens.

BAD_REQUEST

This occurs if the parameters passed to the request are invalid. For example if null or empty string is passed in the roomId parameter of a joinRoom request.

CONNECTION_ERR

This occurs if the underlying TCP connection with AppWarp cloud service got broken. The client will need to reconnect to the service and retry the operation.

SUCCESS_RECOVERED

This indicates that the user connection has been successfully restored.

CONNECTION_ERROR_RECOVERABLE

This occurs if the underlying TCP connection with AppWarp cloud service got broken. But also indicates that it is possible to recover the connection if the application requires by calling the RecoverConnection API.

Java API Reference

WarpClient APIs

WarpClient Events

WarpClient Listeners

WarpClient Event Result Codes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Clone this wiki locally