userJoin

(since )



Event fired when a user join a channel.

Description


userJoin

This event is fired when a user join a channel.

This event is fired both on core and pipe the user joined

Arguments passed to the callback function


user
The user.

pipe
Pipe objet that user join.

Examples


//ape var is a reference to APE instance
 
ape.addEvent('userJoin', function (user, pipe) {
    //An user join the channel
    console.log('the user ' + user.properties.name + ' join the channel ' + pipe.properties.name);
});
 
 

//ape var is a reference to APE instance
 
//Join two channel
ape.join(['channel1', 'channel2']);
 
ape.addEvent('pipeCreate', function(type, pipe, options) {
    //Attach userJoin event only to pipe "channel1"
    if (type == 'multi' && pipe.properties.name =='channel1') {
        pipe.addEvent('userJoin', function(user, pipe) {
            console.log('New user on channel1');
        });
    }
});

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.