Skip to content

Lua API Reference

Jump to bottom
DhruvCShepHertz edited this page Sep 13, 2013 · 16 revisions

Please go through the getting started page before going through this complete API reference.

WarpClient APIs

###initialize

   initialize(apiKey, secretKey)

Initializes the 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.

###connectWithUserName

connectWithUserName(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.

Parameters

username - Username of the player

The result of the operation is provided in the registered "onConnectDone" request listener defined as

onConnectDone(resultCode)

###disconnect

disconnect()

Disconnects the connection with the AppWarp server.

Parameters

The result of the operation is provided in the registered "onDisconnectDone" request listener defined as

onDisconnectDone(resultCode)

###joinLobby

joinLobby()

Sends a join lobby request to the server.

Parameters

Result of the request is provided in the "onJoinLobbyDone" callback of the registered RequestListener defined as

onJoinLobbyDone(resultCode)

###leaveLobby

leaveLobby()

Sends a leave lobby request to the server.

Parameters

Result of the request is provided in the "onLeaveLobbyDone" callback of the registered RequestListener defined as

onLeaveLobbyDone(resultCode)

###subscribeLobby

subscribeLobby()

Sends a subscribe lobby request to the server. 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 notificationlisteners.

Parameters

Result of the request is provided in the "onSubscribeLobbyDone" callback of the registered RequestListener defined as

onSubscribeLobbyDone(resultCode)

###unsubscribeLobby

unsubscribeLobby()

Sends a unsubscribe lobby request to the server.

Parameters

Result of the request is provided in the "onUnsubscribeLobbyDone" callback of the registered RequestListener defined as

onUnsubscribeLobbyDone(resultCode)

###joinRoom

joinRoom(roomId)

Sends a join room request to the server. 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

Result of the request is provided in the "onJoinRoomDone" callback of the registered RequestListener defined as

onJoinRoomDone(resultCode, roomid)

###joinRoomInRange

joinRoomInRange(minUesrs, maxUesrs, maxPreferred)

Sends a join room request to the server with the condition that the room must have at least minUsers and at Most maxUsers. 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

Result of the request is provided in the "onJoinRoomDone" callback of the registered RequestListener defined as

onJoinRoomDone(resultCode, roomid)

###joinRoomWithProperties

joinRoomWithProperties(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.

Parameters

tableProperties- properties of the room to be joined

Result of the request is provided in the "onJoinRoomDone" callback of the registered RequestListener defined as

onJoinRoomDone(resultCode, roomid)

###leaveRoom

leaveRoom(roomId)

Sends a leave room request to the server.

Parameters

roomId - Id of the room to be left

Result of the request is provided in the "onLeaveRoomDone" callback of the registered RequestListener defined as

onLeaveRoomDone(resultCode, roomid)

###createRoom

createRoom(name, owner, maxUsers, tableProperties)

Sends a create room request to the server with the given meta data. 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)

Result of the request is provided in the "onCreateRoomDone" callback of the registered RequestListener defined as

onCreateRoomDone(resultCode, roomid, name)

###deleteRoom

deleteRoom(roomId)

Sends a delete room request to the server. 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

Result of the request is provided in the "onDeleteRoomDone" callback of the registered RequestListener defined as

onDeleteRoomDone(resultCode, roomid, name)

###subscribeRoom

subscribeRoom(roomId)

Sends a subscribe room request to the server. 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 notificationlisteners objects.

Parameters

roomId - Id of the room to be subscribed

Result of the request is provided in the "onSubscribeRoomDone" callback of the registered RequestListener defined as

onSubscribeRoomDone(resultCode, roomid)

###unsubscribeRoom

unsubscribeRoom(roomId)

Sends a unsubscribe room request to the server.

Parameters

roomId - Id of the room to be subscribed

Result of the request is provided in the "onSubscribeRoomDone" callback of the registered RequestListener defined as

onSubscribeRoomDone(resultCode, roomid)

###sendChat

sendChat(message)

Sends a chat message to the room (or lobby) in which the user is currently joined. All users who are subscribed to the location in which the message is sent will get a "onChatReceived" event on their registered notificationlisteners objects.

Parameters

message - message to be send

Result of the request is provided in the "onSendChatDone" callback of the registered RequestListener defined as

onSendChatDone(resultCode)

###SendPrivateChat

Sends a private message to the given user if its online. 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 notificationlisteners objects.

    public void sendPrivateChat(username, message)

Parameters

username - recipient of the message

message - message to be send

Result of the request is provided in the "onSendPrivateChatDone" callback of the registered RequestListener defined as

onSendPrivateChatDone(resultCode)

###sendUpdatePeers

sendUpdatePeers(update)

Sends a byte array update message to room in which the user is currently joined. All users who are subscribed to the room in which the update is sent will get a "onUpdatePeersReceived" event on their registered notificationlisteners 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.

Parameters

update - binary data to be send

Result of the request is provided in the "onSendUpdatePeersDone" callback of the registered RequestListener defined as

onSendUpdatePeersDone(resultCode)

###getLiveRoomInfo

getLiveRoomInfo(roomId)

Retrieves the live information of the given room from the server. 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

Result of the request is provided in the "onGetLiveRoomInfoDone" callback of the registered RequestListener defined as

onGetLiveRoomInfoDone(resultCode, roomTable)

###getLiveUserInfo

getLiveUserInfo(username)

Retrieves the live information of the user from the server. 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

Result of the request is provided in the "onGetLiveUserInfoDone" callback of the registered RequestListener defined as

onGetLiveUserInfoDone(resultCode, name, customData, locid, isLobby)

###getLiveLobbyInfo

getLiveLobbyInfo()

Retrieves live information of the lobby from the server. The information returned includes the names of the users who are currently joined in the lobby.

Parameters

Result of the request is provided in the "onGetLiveLobbyInfoDone" callback of the registered RequestListener defined as

onGetLiveLobbyInfoDone(resultCode, lobbyTable)

###setCustomUserData

setCustomUserData(userName, customData)

Updates the custom data associated with the given user on the server (if the given user is online). 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

Result of the request is provided in the "onSetCustomUserDataDone" callback of the registered RequestListener defined as

onSetCustomUserDataDone(resultCode, name, custom, locid, isLobby)

###setCustomRoomData

Updates the custom data associated with the given room on the server. 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.

SetCustomRoomData(roomId, customRoomData)

Parameters

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

Result of the request is provided in the "onSetCustomRoomDataDone" callback of the registered RequestListener defined as

 onSetCustomRoomDataDone(resultCode, roomTable)

###updateRoomProperties

updateRoomProperties(roomID, tableProperties, removeArray)

Updates the properties associated with the given room on the server. 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 "onUserChangedRoomProperty" notification on the registered notificationlisteners 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

Result of the request is provided in the "onUpdateRoomProperties" callback of the registered RequestListener defined as

 onUpdateRoomProperties(resultCode, roomTable)

###lockProperties

lockProperties(tableProperties)

Lock the properties associated with the joined room on the server for requested user. 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 "onUserChangedRoomProperty" notification on the registered notificationlisteners objects to be triggered for all subscribed users of the room.

Parameters

lockProperties - properties to be lock for the room

Result of the request is provided in the "onLockPropertiesDone" callback of the registered RequestListener defined as

 onLockPropertiesDone(resultCode)

###unlockProperties

lockProperties(unlockPropertiesArray)

Unlock the properties associated with the joined room on the server for requested user. 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 "onUserChangedRoomProperty" notification on the registered notificationlisteners objects to be triggered for all subscribed users of the room.

Parameters

unlockProperties - properties to be unlock for the room

Result of the request is provided in the "onUnlockPropertiesDone" callback of the registered RequestListener defined as

 onUnlockPropertiesDone(resultCode)

###getOnlineUsers

    public void getOnlineUsers()

Retrieves usernames of all the users connected (online) to the server.

Parameters

Result of the request is provided in the "onGetOnlineUsersDone" callback of the registered RequestListener defined as

onGetOnlineUsersDone(resultCode, usersTable)

###getAllRooms

    public void getAllRooms()

Retrieves the room ids of all the rooms on the server. To get a filtered list of rooms, use the getRoomsInRange or getRoomsWithProperties APIs.

Parameters

Result of the request is provided in the "onGetAllRoomsDone" callback of the registered RequestListener defined as

onGetAllRoomsDone(resultCode, roomsTable)

###getRoomsInRange

getRoomsInRange(minUsers, maxUsers)

Retrieves information of the rooms that contain at least minUsers and at most maxUsers in them. 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

Result of the request is provided in the "onGetMatchedRoomsDone" callback of the registered RequestListener defined as

onGetMatchedRoomsDone(resultCode, roomsTable)

###getRoomsWithProperties

getRoomsWithProperties(properties)

Retrieves information of the room that contain properties which match with the given properties. This is useful in building a filtered list of rooms.

Parameters

properties- properties of the room to be joined

Result of the request is provided in the "onGetMatchedRoomsDone" callback of the registered RequestListener defined as

onGetMatchedRoomsDone(resultCode, roomsTable)

NotificationListeners

Following are the notification listeners that can be registered with AppWarp instance. These are invoked if an event is received from the server for a subscribed resource.

  • onChatReceived

-- Invoked when a joined user sends a chat.

function onChatReceived(sender, message, roomid, isLobby)
  • onUpdatePeersReceieved

-- Invoked when a updatePeers request is sent in one of the subscribed rooms.

 function onUpdatePeersReceieved(message)
  • onRoomCreated

-- Invoked when a room is created. Lobby subscribers will receive this.

 function onRoomCreated(roomid, name, maxUsers)
  • onRoomDeleted

-- Invoked when a room is deleted. Lobby subscribers will receive this.

 function onRoomDeleted(roomid, name)
  • onUserJoinedRoom

-- Invoked when a user joins a room. Lobby and the concerned room subscribers will receive this.

 function onUserJoinedRoom(username, roomid)
  • onUserLeftRoom

-- Invoked when a user leaves a room. Lobby and the concerned room subscribers will receive this.

 function onUserLeftRoom(username, roomid)
  • onUserLeftLobby

-- Invoked when a user leaves the lobby. Lobby subscribers will receive this.

 function onUserLeftLobby(username)
  • onUserJoinedLobby

-- Invoked when a user joins the lobby. Lobby subscribers will receive this.

 function onUserJoinedLobby(username)
  • onPrivateChatReceived

-- Invoked when a private chat is received from the given sender.

 function onPrivateChatReceived(sender, message)
  • onUserChangedRoomProperty

-- Invoked when a user changes the properties of a subscribed room property.

 function onUserChangedRoomProperty(username, roomid, propertyTable, lockTable)

WarpClient Event Result Codes

SUCCESS = 0;    
AUTH_ERROR = 1;    
RESOURCE_NOT_FOUND = 2;    
RESOURCE_MOVED = 3;     
BAD_REQUEST = 4;
CONNECTION_ERROR = 5;
UNKNOWN_ERROR = 6;
RESULT_SIZE_ERROR = 7;
SUCCESS_RECOVERED = 8;
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.

Clone this wiki locally