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 JavaScript Framework Manual

• Core
• setSession » Save a session variable on the APE server.
• getSession » Retrieves a value from the session on the APE server.
• apeReconnect » Events sent when client reconnect.
• onCmd » Intercept a command
• onRaw » Intercept a raw
• fireEvent » Fire an event
• onError » Intercept an error event.
• clearSession » clear you APE session
• quit » Exit APE.
• start » Initiate connection to APE server
• join » Join one or many channels.
• left » Left a channel.
• getPipe » Get a pipe object.
• constructor » Create a new APE instance
• clearInterval » Clear an interval created by setInterval
• request.send » Send a command to the APE server
• request.stack.add » Add a command to request stack
• request.stack.send » Send the request stack.
• request.cycledStack.add » Add a command to cycled request stack
• request.cycledStack.send » Force sending stack.
• request.cycledStack.setTime » Change cycled stack time.
• user » Contain current user object
• delPipe » Delete a pipe from the Core.
• addEvent » Adds and event listener for an Ape event.

• Pipe
• addEvent » Intercept an event attached to a pipe.
• fireEvent » Executes all events of the specified type present in the pipe.
• fireGlobalEvent » Executes all events of the specified type present in the core and pipe.
• getPubid » Return the pubid of the pipe
• onRaw » Intercept a raw received on a pipe.
• onCmd » Intercept a command sent on a pipe.
• send » Shortcut to send a message on pipe.
• pipe » Variable containing pipe options

• Events
• proxyClose » Event sent when the proxy close the connection.
• proxyRead » Event sent when the client received data from the proxy.
• proxyConnect » Event sent when the client is connected to the proxy.
• userLeft » Event fired when a user leave a channel.
• multiPipeCreate » Event fired when a new Multi Pipe is created.
• restoreEnd » Event sent when the session is restored.
• clearSession » Events sent when the session is cleared.
• restoreStart » Event sent when the session restore begin.
• pipeDelete » Event sent when a pipe is deleted
• ready » Event sent when the client is connected to the APE server.
• load » Events sent when APE is loaded
• apeDisconnect » Events sent when client disconnect.
• userJoin » Event fired when a user join a channel.
• uniPipeCreate » Event fired when a new Uni Pipe is created.
• proxyPipeCreate » Event fired when a new proxy pipe is created.
• onRaw » Intercept all received raw.
• onCmd » Intercept outgoing command.
• multiPipeDelete »

• Client
• addEvent » Intercept an event
• load » Load the APE client
• fireEvent » Fire an event
• onError » Intercept an error event.
• onRaw » Intercept a raw
• onCmd » Intercept a command

• Proxy-pipe
• send » Send data to a proxy
• open » Open a new proxy connection

• Multi-pipe
• users » A MooTools hash of user on the pipe.
• getUser » Return an user object identified by his pubid.
• left » Force the user leave the pipe.