• Initialize
• setRecoveryAllowance
• RecoverConnection
• RecoverConnectionWithSessionID
• Connect
• Disconnect
• GetConnectionState
• JoinLobby
• LeaveLobby
• SubscribeLobby
• UnSubscribeLobby
• JoinRoom
• JoinRoomInRange
• GetRoomsInRange
• JoinRoomWithProperties
• LeaveRoom
• CreateRoom
• CreateTurnBasedRoom
• SendMove
• DeleteRoom
• SubscribeRoom
• UnSubscribeRoom

• SendChat
• SendPrivateChat
• SendUpdatePeers
• SendPrivateUpdate
• GetLiveRoomInfo
• GetLiveUserInfo
• GetLiveLobbyInfo
• SetCustomUserData
• SetCustomRoomData
• UpdateRoomProperties
• LockProperties
• UnlockProperties
• GetOnlineUsers
• GetAllRooms
• GetRoomWithProperties
• AddConnectionRequestListener
• AddRoomRequestListener
• AddZoneRequestListener
• AddLobbyRequestListener
• AddNotificationListener
• AddUpdateRequestListener
• AddChatRequestListener

• AddTurnBasedRoomRequestListener
• startGame
• stopGame
• getMoveHistory
• SetGeo
• GetSessionID
• GetInstance
• GetApiKey
• GetPrivateKey
• RemoveConnectionRequestListener
• RemoveZoneRequestListener
• RemoveLobbyRequestListener
• RemoveRoomRequestListener
• RemoveChatRequestListener
• RemoveTurnRoomRequestListener
• RemoveUpdateRequestListener
• RemoveNotificationListener
• sendUDPPrivateUpdate
• SendUDPUpdatePeers
• initUDP
• SetNextTurn

Initializes the singleton instance of WarpClient with the developer credentials. This has to be called only once during the lifetime of the application. It is required before you can call any other API. Parameters Returns void Sets the time allowed for the client to recover from an intermittent connection loss. This must be set before the initial connect API is called as that associates the value on the server for the given connection. Parameters maxRecoveryTime - time - the time (in seconds) allowed to the client to recover from intermittent connection loss Returns void Attempts to recover from an intermittent connection error. If successful, the client will be placed in the same room as before the loss and all its subscriptions will be maintained. The other subscribed users of the room, will receive onUserResumed notification. This can only be called if an established session was lost due to a connectivity error and the client got onConnectDone with a recoverable connection error code. The connection must be restored within the recovery allowance period, after which the server considers the session to be over (non-recoverable). Parameters None Returns void Attempts to recover from an intermittent connection error.Since this API requires sessionId so it has to be saved by the game on the last successful connection.The other subscribed users of the room, will receive onUserResumed notification.The connection must be restored within the recovery allowance period, after which the server considers the session to be over (non-recoverable). Parameters sessionId - sessionId of the last successful session userName - name of the player Returns void 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 first one will win and the second one will get an error. The username string parameter length must be more than 0 and less than 48. Also it shouldn’t contain the following characters “, ; / \”. The result of the operation is provided in the onConnectDone callback of the Connection Request Listener. Parameters username - name of the player Returns void Disconnects the connection with the AppWarp server. The result for this request will be provided in the onDisConnectDone callback of the Connection Request Listener. Parameters None Returns void Queries the connection state of the client with the server. The values returned are according to the following : Parameters None Returns byte - WarpConnectionState Sends a join lobby request to the server. Result of the request is provided in the onJoinLobbyDone callback of the registered LobbyRequestListener objects. Parameters None Returns void Sends a leave lobby request to the server. Result of the request is provided in the onLeaveLobbyDone callback of the registered LobbyRequestListener objects. Parameters None Returns void Sends a subscribe lobby request to the server. Result of the request is provided in the onSubscribeLobbyDone callback of the registered LobbyRequestListener objects. Users who 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 from the lobby as well as 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 None Returns void Sends an unsubscribe lobby request to the server. Result of the request is provided in the onUnsubscribeLobbyDone callback of the LobbyRequestListener. Parameters None Returns void 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 to 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 Sends a join room request to the server with the given range of joined users. Result of the request is provided in the onJoinRoomDone callback of the registered RoomRequestListener objects. A user can only be joined to one location (room or lobby) at a time. If a user joins a room, it will automatically be removed from its current location. This enables developers to easily add quick-play scenarios. Parameters minUserCount - minimum users in the room maxUserCount - maximum users in the room maxPreferred - number of users preferred for joining a room Returns void Sends a request to the server to fetch a list of rooms with the given range of joined users. Result of the request is provided in the onGetMatchedRoomsDone callback of the registered ZoneRequestListener objects. Parameters minUserCount - minimum users in the room maxUserCount - maximum users in the room Returns void 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 objects. Parameters tableProperties- properties of the room to be joined Returns void Sends a leave room request to the server. Result of the request is provided in the onLeaveRoomDone callback of the registered RoomRequestListener objects. Parameters roomId - Id of the room to be left Returns void 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. This room’s lifetime is limited to the time the users are inside it. Read more about Rooms here. Parameters Returns void 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. This room’s lifetime is limited to the time the users are inside it. Read more about Rooms here. Parameters Returns void 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 Turn Based Room Listener objects. If the joined user is not in turn based room or if its not the user’s turn, this request will fail. If successful, this will result in onMoveCompleted notification for all the subscribed users on the registered NotifyListener objects. Parameters Returns void 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 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 changed 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 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 unsubscribed Returns void Sends a chat message to the room (or lobby) to which the user is currently joined. Result of the request is provided in the onSendChatDone callback of the registered ChatRequestListener objects. The length of the message string must not exceed 1000. All the users who are subscribed to the location in which the message is sent will get an onChatReceived event on their registered NotifyListener objects. Parameters message - message to be sent Returns void Sends a private message to the given user if it’s 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 an onPrivateChatReceived event on its registered NotifyListener objects. Parameters username - recipient of the message message - message to be sent Returns void Sends a byte array update message to the room to 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 to which the update is sent will get an 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 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 size of the byte array must not exceed 1000. 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 - byte array data to be sent Returns void Sends a byte array update message to the recipient user. Result of the request is provided in the onSendPrivateUpdateDone callback of the registered UpdateRequestListener objects. Remote user will get an onPrivateUpdateReceived event on their registered NotifyListener objects. This is useful if developers want to send private data between the users. The corresponding UDP flavor of this API is sendUDPPrivateUpdate, 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 toUsername - recipient username update - byte array data to be sent Returns void 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 room’s properties and any associated custom Data. This is useful in getting a snapshot of a room’s state. Parameters roomId - Id of the room Returns void 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 user’s friends are online and then join their room if found online. Parameters username - user whose information is requested Returns void 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 to the lobby. Parameters None Returns void 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 URLs etc for online users. Parameters Returns void 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 to use the room’s properties wherever possible. Use this when you need to associate data with a room which can not be represented as key-value pairs. Parameters Returns void 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 room. 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 Returns void Locks the given room properties associated with the currently joined room on the server. Result is provided in the onLockPropertiesDone callback of the registered RoomRequestListener objects. If any property is currently locked by another user, this request will fail. 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 Returns void Unlocks the given room properties associated with the currently joined room on the server. Result is provided in the onUnlockPropertiesDone callback of the registered RoomRequestListener objects. If any property is currently unlocked, this request will give BAD_REQUEST. 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 Returns void Retrieves usernames of all the users connected (online) to the server. Result is provided in the onGetOnlineUsersDone callback of the registered ZoneRequestListener objects. Parameters None Returns void 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 GetRoomWithProperties API. Parameters None Returns void Retrieves information of the room that contains 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 matched Returns void 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 - listener object Returns void 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 - listener object Returns void 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 - listener object Returns void 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 requests. The object must implement the Lobby Request Listener interface. Parameters listener - listener object Returns void 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 - listener object Returns void 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 or SendPrivateUpdate request. The object must implement the UpdateRequestListener interface. Parameters listener - listener object Returns void 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 SendChat or sendPrivateChat request. The object must implement the ChatRequestListener interface. Parameters listener - listener object Returns void 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 turn based game move request. The object must implement the Turn Based Room Listener interface. Parameters listener - listener object Returns void Sends a start game request to the server in TurnBasedRoom. Result of this request is provided in onStartGameDone callback of the registered TurnBasedRoomListener objects. If successful game will be started in TurnBasedRoom. Parameters isDefaultLogic - a true boolean value nextTurn - an empty string for next turn Returns void Sends a stop game request to the server in TurnBasedRoom. Result of this callback is provided in onStopGameDone callback of the registered TurnBasedRoomListener objects. If successful game will be stopped in TurnBasedRoom. Parameters None Returns void Sends get move history request to the server in TurnBasedRoom. Result of this callback is provided in onGetMoveHistoryDone callback of the registered TurnBasedRoomListener objects. Parameters None Returns void setGeo allows you to connect to our cloud servers in locations other than the default location. This offers developers the choice to connect to the closest server depending on the client’s device location. Parameters geo - server location. For e.g. us, eu, japan Returns void It gives sessionId of the current established connection,otherwise returns zero. Parameters None Returns int - sessionId It returns the singleton instance of WarpClient.This should be initialized with a key pair before it is used. Parameters None Returns WarpClient - singleton instance of WarpClient. It gives the Api Key of the current established connection,otherwise returns null. Parameters None Returns String - Api key It gives the Private/Secret Key of the current established connection,otherwise returns null. Parameters None Returns String - Private/Secret key Removes the given listener object from 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 - listener object Returns void Removes the given listener object from 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 - listener object Returns void Removes the given listener object from the list of objects on which callbacks will be invoked when a response from the server is received for lobby level requests. The object must implement the Lobby Request Listener interface. Parameters listener - listener object Returns void Removes the given listener object from 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 - listener object Returns void Removes the given listener object from the list of objects on which callbacks will be invoked when a response from the server is received for a SendChat or sendPrivateChat request. The object must implement the ChatRequestListener interface. Parameters listener - listener object Returns void Removes the given listener object from the list of objects on which callbacks will be invoked when a response from the server is received for a turn based game move request. The object must implement the Turn Based Room Listener interface. Parameters listener - listener object Returns void Removes the given listener object from the list of objects on which callbacks will be invoked when a response from the server is received for a SendUpdatePeers or SendPrivateUpdate request. The object must implement the UpdateRequestListener interface. Parameters listener - listener object Returns void Removes the given listener object from 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 - listener object Returns void Sends a byte array update message to the recipient user. This is useful if developers want to send private data between the users. It is unreliable and may not work over cellular data connections – hence no result callback should be expected from it. The corresponding flavor of this API is sendPrivateUpdate which shows a similar behavior. Parameters toUsername - recipient username update - byte array data to be sent Returns void Sends a byte array update message to the room to which the user is currently joined. 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 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 size of the byte array must not exceed 1000. It is unreliable and may not work over cellular data connections – hence no result callback should be expected from it.The corresponding UDP flavor of this API is sendUpdatePeers which shows a similar behavior. Parameters update - byte array data to be sent Returns void If the user is connected, it sends an associated UDP Port message to the room (or lobby) to which the user is currently joined. It is unreliable and may not work over cellular data connections – hence no result callback should be expected from it. Parameters None Returns void When the onNextTurnRequest is sent by the server, it sends the next turn to the server for the joined turn based room.Result of the request is provided in the onSetNextTurnDone callback of the registered Turn Based Room Listener objects. If the joined user is not in turn based room or if it’s not the user’s turn, this request will fail. If successful, this will result in onMoveCompleted notification for all the subscribed users on the registered NotifyListener objects. Parameters nextTurn - the string value for the next turn Returns void