multiPipeCreate

(since )



Event fired when a new Multi Pipe is created.

Description


multiPipeCreate

This event is fired when a new Multi Pipe is created. A new Multi Pipe is created when you successfully joined a channel.

Arguments passed to the callback function


pipe
The pipe object.

options
Options passed to the constructor of the pipe. The options is the value sent by the APE server in a pipe object (properties, pubid, name, ...)

Examples


//ape var is a reference to APE instance
 
//Join channel "testchannel"
ape.join('testchannel'); 
 
//Intercept multiPipeCreate event
ape.addEvent('multiPipeCreate', function(pipe, options) {
     console.log('A new Multi pipe is created. Pipe object : ', pipe);
});

See also


User notes


# No comment

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.