start

(since )



Initiate connection to APE server

Description


string start ( [mixed options] )

Initiate connection to APE server. This method send a connect command to APE server.

By default no arguments are sent to the server.

Parameters


options
Arguments to send to the connect request

Examples


//ape var is a reference to APE instance
 
ape.start(); //Send CONNECT command to APE.

//ape var is a reference to APE instance
 
//If you use APE with libape-chat you need to send your nickname in the CONNECT request
ape.start('myNickname'); //Send CONNECT command with a nickname to APE.

User notes


Maanas
Maanas said:
What additional parameters can be sent while connect.
16/05/10 03:21

AndyW
AndyW said:
If you include nickname.js on the server, then you MUST pass in a nick name on the ape.start("me") call otherwise it will fail with a 001 invalid parms.
06/01/12 02:51

Post a note


User notes may be edited or deleted, and usually a note is deleted because of the following reasons:
  • Bugs: Instead report a bug
  • Missing documentation: report that as a bug.
  • Support questions: See the community for available options.

In other words, do not ask questions within the user notes.

Note <b>,<u>,<i> HTML tags are allowed in the posts and the note formatting is preserved. URLs will be turned into clickable links, JavaScipt and C code blocks enclosed in the <source="javascript">JS Code</source> and <source="c">C Code</source> tags will be source highlighted automatically.