left

(since 1.0)



Force the user leave the pipe.

Description


string left ( )

Left (unsubscribe) a channel and fire the pipeDelete event.

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 
          pipe.left();
      }
  });

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.