uniPipeCreate

(since )



Event fired when a new Uni Pipe is created.

Description


uniPipeCreate

This event is fired when a new Uni Pipe is created. A new Uni Pipe is created when you call getPipe with the pubid of an user.

Arguments passed to the callback function


pipe
The pipe object.

options
Options passed to the constructor of the pipe.

Examples


//ape var is a reference to APE instance
ape.join('testChannel');
 
ape.addEvent('userJoin', function(user, pipe) {
    //For performance purpose, user are not pipe in APE JSF. If you want to have a pipe from an user, use getPipe.
    //Transform all user into a pipe object
    var pipe = ape.getPipe(user.pubid);
});
 
ape.addEvent('uniPipeCreate', function(pipe, options) {
    //Send 'Hello world' to the user
    pipe.send('Hello world');
});

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.