Study the APE now, consult our documentation

You are a developer? Here, you will find everything you need to create your own realtime application with APE!

On your left, you will find the complete documentation about the ServerSide JavaScript API, and for Client JavaScript Framework. Please consult our wiki for further more info.

APE Server Manual

• Raws
• sendResponse » Send a response to a command.

• Commands
• registerHookCmd » Register a hook on an user command.
• registerCmd » Register a new server command.
• registerHookBadCmd » Catch all commands that are not registered

• Mysql
• MySQL » A mysql connection class
• MySQL.onConnect » Mysql connection established callback
• MySQL.onError » Error occurred callback
• MySQL.errorString » Get mysql error message
• MySQL.query » Execute a mysql query
• MySQL.getInsertId » Get the last id insert with auto-increment
• Ape.MySQL.escape » Escape a string for mysql

• Events
• adduser » Fired when an user is added to APE
• deluser » Fired when an user is deleted from APE
• beforeJoin » Fired just before an user joins a channel.
• afterJoin » Alias of join event.
• join » This event is called just after an user joins a channel
• left » Fired when an user leaves a channel
• mkchan » Fired when a new channel is created
• rmchan » Fired when a user is removed
• init » Fired when server is ready
• addEvent » Listen an APE event

• Users
• user » An user object
• user.setProperty » Set a public property
• user.getProperty » Get a public property
• getUserByPubid » Get an user object giving his pubid
• user.pipe » The user's pipe
• subuser » A sub user object
• subuser.sendRaw » Send a raw to a subuser.
• subuser.getUser » Get the parent user
• user.join » Make a user join a channel
• left » Forces the user to leave a channel.

• Channels
• getChannelByName » Get the channel from its name
• getChannelByPubid » Get a channel by its pubid
• channel » A channel object
• mkChan » Instantiate a channel object
• channel.setProperty » Set a public property
• channel.getProperty » Get a public property
• rmChan » Remove a channel
• userslist » List of users on the channel

• Sockets
• sockClient » A client socket class
• sockClient.write » Writes on the socket
• sockClient.close » Closes the socket
• sockClient.onConnect » Connection has been established callback
• sockClient.onRead » Data received callback
• sockClient.onDisconnect » Connection closed callback
• sockServer » A server socket class
• sockServer.onAccept » Client connected callback
• sockServer.onRead » Client data received callback
• sockServer.onDisconnect » Client disconnected callback

• More
• clearTimeout » Cancel a timeout created by setTimeout
• pipe.sendRaw » Send a custom RAW on the pipe
• pipe » A pipe object
• pipe.getProperty » Get a public property
• pipe.setProperty » Set a public property
• pipe.destroy » Destroy the custom pipe
• pipe.onSend » Raw "SEND" received callback
• base64.encode » Encode a string in base64
• base64.decode » Decode a base64 encoded string
• sha1.str » Hash a string using sha1 algorithm
• sha1.bin » Hash a string using sha1 algorithm as binary
• xorize » Apply a 'XOR' between two string (or binary)
• setTimeout » Execute a function after specified delay
• setInterval » Calls a function repeatedly
• include » Include another javascript file
• log » Log a message in console
• config » Get a configuration value