left

(since )



Left a channel.

Description


string left ( string pubid )

Left (unsubscribe) a channel and fire the pipeDelete

Parameters


pubid
pubid of the channel

Examples


//ape var is a reference to APE instance
 
//Join testchannel
ape.join('testchannel');
 
//Intercept pipeCreate event (this event is fired when you join a channel)
ape.addEvent('multiPipeCreate', function(pipe, options) {
    if (pipe.properties.name=='teschannel') {
        //If pipe is testchannel, left it :p 
        ape.left(pipe.getPubid());
    }
});

See also


User notes


asdf
asdf said:
It should be called "leave"
16/02/10 23:19

chappy
chappy said:
Also, testchannel is spelt wrong in your if statement :)
19/10/10 20:28

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.