PircBot.html 257 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!--NewPage-->
  3. <HTML>
  4. <HEAD>
  5. <!-- Generated by javadoc (build 1.4.2) on Mon Dec 14 20:07:23 GMT 2009 -->
  6. <TITLE>
  7. PircBot (PircBot 1.5.0 - Java IRC API Bot Framework)
  8. </TITLE>
  9. <META NAME="keywords" CONTENT="org.jibble.pircbot.PircBot class">
  10. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../pircbot-style.css" TITLE="Style">
  11. <SCRIPT type="text/javascript">
  12. function windowTitle()
  13. {
  14. parent.document.title="PircBot (PircBot 1.5.0 - Java IRC API Bot Framework)";
  15. }
  16. </SCRIPT>
  17. </HEAD>
  18. <BODY BGCOLOR="white" onload="windowTitle();">
  19. <!-- ========= START OF TOP NAVBAR ======= -->
  20. <A NAME="navbar_top"><!-- --></A>
  21. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  22. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  23. <TR>
  24. <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  25. <A NAME="navbar_top_firstrow"><!-- --></A>
  26. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  27. <TR ALIGN="center" VALIGN="top">
  28. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  29. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  30. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PircBot.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  31. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  32. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  33. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  34. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  35. </TR>
  36. </TABLE>
  37. </TD>
  38. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  39. <b>PircBot Java IRC Bot</b></EM>
  40. </TD>
  41. </TR>
  42. <TR>
  43. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  44. &nbsp;<A HREF="../../../org/jibble/pircbot/OutputThread.html" title="class in org.jibble.pircbot"><B>PREV CLASS</B></A>&nbsp;
  45. &nbsp;<A HREF="../../../org/jibble/pircbot/Queue.html" title="class in org.jibble.pircbot"><B>NEXT CLASS</B></A></FONT></TD>
  46. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  47. <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
  48. &nbsp;<A HREF="PircBot.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  49. &nbsp;<SCRIPT type="text/javascript">
  50. <!--
  51. if(window==top) {
  52. document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  53. }
  54. //-->
  55. </SCRIPT>
  56. <NOSCRIPT>
  57. <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  58. </NOSCRIPT>
  59. </FONT></TD>
  60. </TR>
  61. <TR>
  62. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  63. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  64. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  65. DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  66. </TR>
  67. </TABLE>
  68. <A NAME="skip-navbar_top"></A>
  69. <!-- ========= END OF TOP NAVBAR ========= -->
  70. <HR>
  71. <!-- ======== START OF CLASS DATA ======== -->
  72. <H2>
  73. <FONT SIZE="-1">
  74. org.jibble.pircbot</FONT>
  75. <BR>
  76. Class PircBot</H2>
  77. <PRE>
  78. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
  79. <IMG SRC="../../../resources/inherit.gif" ALT="extended by"><B>org.jibble.pircbot.PircBot</B>
  80. </PRE>
  81. <DL>
  82. <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../org/jibble/pircbot/ReplyConstants.html" title="interface in org.jibble.pircbot">ReplyConstants</A></DD>
  83. </DL>
  84. <HR>
  85. <DL>
  86. <DT>public abstract class <B>PircBot</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../org/jibble/pircbot/ReplyConstants.html" title="interface in org.jibble.pircbot">ReplyConstants</A></DL>
  87. <P>
  88. PircBot is a Java framework for writing IRC bots quickly and easily.
  89. <p>
  90. It provides an event-driven architecture to handle common IRC
  91. events, flood protection, DCC support, ident support, and more.
  92. The comprehensive logfile format is suitable for use with pisg to generate
  93. channel statistics.
  94. <p>
  95. Methods of the PircBot class can be called to send events to the IRC server
  96. that it connects to. For example, calling the sendMessage method will
  97. send a message to a channel or user on the IRC server. Multiple servers
  98. can be supported using multiple instances of PircBot.
  99. <p>
  100. To perform an action when the PircBot receives a normal message from the IRC
  101. server, you would override the onMessage method defined in the PircBot
  102. class. All on<i>XYZ</i> methods in the PircBot class are automatically called
  103. when the event <i>XYZ</i> happens, so you would override these if you wish
  104. to do something when it does happen.
  105. <p>
  106. Some event methods, such as onPing, should only really perform a specific
  107. function (i.e. respond to a PING from the server). For your convenience, such
  108. methods are already correctly implemented in the PircBot and should not
  109. normally need to be overridden. Please read the full documentation for each
  110. method to see which ones are already implemented by the PircBot class.
  111. <p>
  112. Please visit the PircBot homepage at
  113. <a href="http://www.jibble.org/pircbot.php">http://www.jibble.org/pircbot.php</a>
  114. for full revision history, a beginners guide to creating your first PircBot
  115. and a list of some existing Java IRC bots and clients that use the PircBot
  116. framework.
  117. <P>
  118. <P>
  119. <DL>
  120. <DT><B>Version:</B></DT>
  121. <DD>1.5.0 (Build time: Mon Dec 14 20:07:17 2009)</DD>
  122. <DT><B>Author:</B></DT>
  123. <DD>Paul James Mutton,
  124. <a href="http://www.jibble.org/">http://www.jibble.org/</a></DD>
  125. </DL>
  126. <HR>
  127. <P>
  128. <!-- ======== NESTED CLASS SUMMARY ======== -->
  129. <!-- =========== FIELD SUMMARY =========== -->
  130. <A NAME="field_summary"><!-- --></A>
  131. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  132. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  133. <TD COLSPAN=2><FONT SIZE="+2">
  134. <B>Field Summary</B></FONT></TD>
  135. </TR>
  136. <TR BGCOLOR="white" CLASS="TableRowColor">
  137. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  138. <CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  139. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#VERSION">VERSION</A></B></CODE>
  140. <BR>
  141. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The definitive version number of this release of PircBot.</TD>
  142. </TR>
  143. </TABLE>
  144. &nbsp;<A NAME="fields_inherited_from_class_org.jibble.pircbot.ReplyConstants"><!-- --></A>
  145. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  146. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  147. <TD><B>Fields inherited from interface org.jibble.pircbot.<A HREF="../../../org/jibble/pircbot/ReplyConstants.html" title="interface in org.jibble.pircbot">ReplyConstants</A></B></TD>
  148. </TR>
  149. <TR BGCOLOR="white" CLASS="TableRowColor">
  150. <TD><CODE><A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_ALREADYREGISTRED">ERR_ALREADYREGISTRED</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_BADCHANMASK">ERR_BADCHANMASK</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_BADCHANNELKEY">ERR_BADCHANNELKEY</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_BANNEDFROMCHAN">ERR_BANNEDFROMCHAN</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_CANNOTSENDTOCHAN">ERR_CANNOTSENDTOCHAN</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_CANTKILLSERVER">ERR_CANTKILLSERVER</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_CHANNELISFULL">ERR_CHANNELISFULL</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_CHANOPRIVSNEEDED">ERR_CHANOPRIVSNEEDED</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_ERRONEUSNICKNAME">ERR_ERRONEUSNICKNAME</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_FILEERROR">ERR_FILEERROR</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_INVITEONLYCHAN">ERR_INVITEONLYCHAN</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_KEYSET">ERR_KEYSET</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NEEDMOREPARAMS">ERR_NEEDMOREPARAMS</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NICKCOLLISION">ERR_NICKCOLLISION</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NICKNAMEINUSE">ERR_NICKNAMEINUSE</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NOADMININFO">ERR_NOADMININFO</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NOLOGIN">ERR_NOLOGIN</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NOMOTD">ERR_NOMOTD</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NONICKNAMEGIVEN">ERR_NONICKNAMEGIVEN</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NOOPERHOST">ERR_NOOPERHOST</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NOORIGIN">ERR_NOORIGIN</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NOPERMFORHOST">ERR_NOPERMFORHOST</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NOPRIVILEGES">ERR_NOPRIVILEGES</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NORECIPIENT">ERR_NORECIPIENT</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NOSERVICEHOST">ERR_NOSERVICEHOST</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NOSUCHCHANNEL">ERR_NOSUCHCHANNEL</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NOSUCHNICK">ERR_NOSUCHNICK</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NOSUCHSERVER">ERR_NOSUCHSERVER</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NOTEXTTOSEND">ERR_NOTEXTTOSEND</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NOTONCHANNEL">ERR_NOTONCHANNEL</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NOTOPLEVEL">ERR_NOTOPLEVEL</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_NOTREGISTERED">ERR_NOTREGISTERED</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_PASSWDMISMATCH">ERR_PASSWDMISMATCH</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_SUMMONDISABLED">ERR_SUMMONDISABLED</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_TOOMANYCHANNELS">ERR_TOOMANYCHANNELS</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_TOOMANYTARGETS">ERR_TOOMANYTARGETS</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_UMODEUNKNOWNFLAG">ERR_UMODEUNKNOWNFLAG</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_UNKNOWNCOMMAND">ERR_UNKNOWNCOMMAND</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_UNKNOWNMODE">ERR_UNKNOWNMODE</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_USERNOTINCHANNEL">ERR_USERNOTINCHANNEL</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_USERONCHANNEL">ERR_USERONCHANNEL</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_USERSDISABLED">ERR_USERSDISABLED</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_USERSDONTMATCH">ERR_USERSDONTMATCH</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_WASNOSUCHNICK">ERR_WASNOSUCHNICK</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_WILDTOPLEVEL">ERR_WILDTOPLEVEL</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_YOUREBANNEDCREEP">ERR_YOUREBANNEDCREEP</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#ERR_YOUWILLBEBANNED">ERR_YOUWILLBEBANNED</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_ADMINEMAIL">RPL_ADMINEMAIL</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_ADMINLOC1">RPL_ADMINLOC1</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_ADMINLOC2">RPL_ADMINLOC2</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_ADMINME">RPL_ADMINME</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_AWAY">RPL_AWAY</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_BANLIST">RPL_BANLIST</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_CHANNELMODEIS">RPL_CHANNELMODEIS</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_CLOSEEND">RPL_CLOSEEND</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_CLOSING">RPL_CLOSING</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_ENDOFBANLIST">RPL_ENDOFBANLIST</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_ENDOFINFO">RPL_ENDOFINFO</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_ENDOFLINKS">RPL_ENDOFLINKS</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_ENDOFMOTD">RPL_ENDOFMOTD</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_ENDOFNAMES">RPL_ENDOFNAMES</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_ENDOFSERVICES">RPL_ENDOFSERVICES</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_ENDOFSTATS">RPL_ENDOFSTATS</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_ENDOFUSERS">RPL_ENDOFUSERS</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_ENDOFWHO">RPL_ENDOFWHO</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_ENDOFWHOIS">RPL_ENDOFWHOIS</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_ENDOFWHOWAS">RPL_ENDOFWHOWAS</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_INFO">RPL_INFO</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_INFOSTART">RPL_INFOSTART</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_INVITING">RPL_INVITING</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_ISON">RPL_ISON</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_KILLDONE">RPL_KILLDONE</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_LINKS">RPL_LINKS</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_LIST">RPL_LIST</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_LISTEND">RPL_LISTEND</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_LISTSTART">RPL_LISTSTART</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_LUSERCHANNELS">RPL_LUSERCHANNELS</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_LUSERCLIENT">RPL_LUSERCLIENT</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_LUSERME">RPL_LUSERME</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_LUSEROP">RPL_LUSEROP</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_LUSERUNKNOWN">RPL_LUSERUNKNOWN</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_MOTD">RPL_MOTD</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_MOTDSTART">RPL_MOTDSTART</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_MYPORTIS">RPL_MYPORTIS</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_NAMREPLY">RPL_NAMREPLY</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_NONE">RPL_NONE</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_NOTOPIC">RPL_NOTOPIC</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_NOUSERS">RPL_NOUSERS</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_NOWAWAY">RPL_NOWAWAY</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_REHASHING">RPL_REHASHING</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_SERVICE">RPL_SERVICE</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_SERVICEINFO">RPL_SERVICEINFO</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_SERVLIST">RPL_SERVLIST</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_SERVLISTEND">RPL_SERVLISTEND</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_STATSCLINE">RPL_STATSCLINE</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_STATSCOMMANDS">RPL_STATSCOMMANDS</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_STATSHLINE">RPL_STATSHLINE</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_STATSILINE">RPL_STATSILINE</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_STATSKLINE">RPL_STATSKLINE</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_STATSLINKINFO">RPL_STATSLINKINFO</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_STATSLLINE">RPL_STATSLLINE</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_STATSNLINE">RPL_STATSNLINE</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_STATSOLINE">RPL_STATSOLINE</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_STATSQLINE">RPL_STATSQLINE</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_STATSUPTIME">RPL_STATSUPTIME</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_STATSYLINE">RPL_STATSYLINE</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_SUMMONING">RPL_SUMMONING</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_TIME">RPL_TIME</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_TOPIC">RPL_TOPIC</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_TOPICINFO">RPL_TOPICINFO</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_TRACECLASS">RPL_TRACECLASS</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_TRACECONNECTING">RPL_TRACECONNECTING</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_TRACEHANDSHAKE">RPL_TRACEHANDSHAKE</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_TRACELINK">RPL_TRACELINK</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_TRACELOG">RPL_TRACELOG</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_TRACENEWTYPE">RPL_TRACENEWTYPE</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_TRACEOPERATOR">RPL_TRACEOPERATOR</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_TRACESERVER">RPL_TRACESERVER</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_TRACEUNKNOWN">RPL_TRACEUNKNOWN</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_TRACEUSER">RPL_TRACEUSER</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_UMODEIS">RPL_UMODEIS</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_UNAWAY">RPL_UNAWAY</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_USERHOST">RPL_USERHOST</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_USERS">RPL_USERS</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_USERSSTART">RPL_USERSSTART</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_VERSION">RPL_VERSION</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_WHOISCHANNELS">RPL_WHOISCHANNELS</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_WHOISCHANOP">RPL_WHOISCHANOP</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_WHOISIDLE">RPL_WHOISIDLE</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_WHOISOPERATOR">RPL_WHOISOPERATOR</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_WHOISSERVER">RPL_WHOISSERVER</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_WHOISUSER">RPL_WHOISUSER</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_WHOREPLY">RPL_WHOREPLY</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_WHOWASUSER">RPL_WHOWASUSER</A>, <A HREF="../../../org/jibble/pircbot/ReplyConstants.html#RPL_YOUREOPER">RPL_YOUREOPER</A></CODE></TD>
  151. </TR>
  152. </TABLE>
  153. &nbsp;
  154. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  155. <A NAME="constructor_summary"><!-- --></A>
  156. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  157. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  158. <TD COLSPAN=2><FONT SIZE="+2">
  159. <B>Constructor Summary</B></FONT></TD>
  160. </TR>
  161. <TR BGCOLOR="white" CLASS="TableRowColor">
  162. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#PircBot()">PircBot</A></B>()</CODE>
  163. <BR>
  164. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a PircBot with the default settings.</TD>
  165. </TR>
  166. </TABLE>
  167. &nbsp;
  168. <!-- ========== METHOD SUMMARY =========== -->
  169. <A NAME="method_summary"><!-- --></A>
  170. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  171. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  172. <TD COLSPAN=2><FONT SIZE="+2">
  173. <B>Method Summary</B></FONT></TD>
  174. </TR>
  175. <TR BGCOLOR="white" CLASS="TableRowColor">
  176. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  177. <CODE>&nbsp;void</CODE></FONT></TD>
  178. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#ban(java.lang.String, java.lang.String)">ban</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  179. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostmask)</CODE>
  180. <BR>
  181. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Bans a user from a channel.</TD>
  182. </TR>
  183. <TR BGCOLOR="white" CLASS="TableRowColor">
  184. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  185. <CODE>&nbsp;void</CODE></FONT></TD>
  186. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#changeNick(java.lang.String)">changeNick</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;newNick)</CODE>
  187. <BR>
  188. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attempt to change the current nick (nickname) of the bot when it
  189. is connected to an IRC server.</TD>
  190. </TR>
  191. <TR BGCOLOR="white" CLASS="TableRowColor">
  192. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  193. <CODE>&nbsp;void</CODE></FONT></TD>
  194. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#connect(java.lang.String)">connect</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostname)</CODE>
  195. <BR>
  196. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attempt to connect to the specified IRC server.</TD>
  197. </TR>
  198. <TR BGCOLOR="white" CLASS="TableRowColor">
  199. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  200. <CODE>&nbsp;void</CODE></FONT></TD>
  201. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#connect(java.lang.String, int)">connect</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostname,
  202. int&nbsp;port)</CODE>
  203. <BR>
  204. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attempt to connect to the specified IRC server and port number.</TD>
  205. </TR>
  206. <TR BGCOLOR="white" CLASS="TableRowColor">
  207. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  208. <CODE>&nbsp;void</CODE></FONT></TD>
  209. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#connect(java.lang.String, int, java.lang.String)">connect</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostname,
  210. int&nbsp;port,
  211. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;password)</CODE>
  212. <BR>
  213. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attempt to connect to the specified IRC server using the supplied
  214. password.</TD>
  215. </TR>
  216. <TR BGCOLOR="white" CLASS="TableRowColor">
  217. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  218. <CODE>protected &nbsp;<A HREF="../../../org/jibble/pircbot/DccChat.html" title="class in org.jibble.pircbot">DccChat</A></CODE></FONT></TD>
  219. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#dccAcceptChatRequest(java.lang.String, long, int)">dccAcceptChatRequest</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  220. long&nbsp;address,
  221. int&nbsp;port)</CODE>
  222. <BR>
  223. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>As of PircBot 1.2.0, use <A HREF="../../../org/jibble/pircbot/PircBot.html#onIncomingChatRequest(org.jibble.pircbot.DccChat)"><CODE>onIncomingChatRequest(DccChat)</CODE></A></I></TD>
  224. </TR>
  225. <TR BGCOLOR="white" CLASS="TableRowColor">
  226. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  227. <CODE>protected &nbsp;void</CODE></FONT></TD>
  228. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#dccReceiveFile(java.io.File, long, int, int)">dccReceiveFile</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html" title="class or interface in java.io">File</A>&nbsp;file,
  229. long&nbsp;address,
  230. int&nbsp;port,
  231. int&nbsp;size)</CODE>
  232. <BR>
  233. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>As of PircBot 1.2.0, use <A HREF="../../../org/jibble/pircbot/PircBot.html#onIncomingFileTransfer(org.jibble.pircbot.DccFileTransfer)"><CODE>onIncomingFileTransfer(DccFileTransfer)</CODE></A></I></TD>
  234. </TR>
  235. <TR BGCOLOR="white" CLASS="TableRowColor">
  236. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  237. <CODE>&nbsp;<A HREF="../../../org/jibble/pircbot/DccChat.html" title="class in org.jibble.pircbot">DccChat</A></CODE></FONT></TD>
  238. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#dccSendChatRequest(java.lang.String, int)">dccSendChatRequest</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nick,
  239. int&nbsp;timeout)</CODE>
  240. <BR>
  241. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attempts to establish a DCC CHAT session with a client.</TD>
  242. </TR>
  243. <TR BGCOLOR="white" CLASS="TableRowColor">
  244. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  245. <CODE>&nbsp;<A HREF="../../../org/jibble/pircbot/DccFileTransfer.html" title="class in org.jibble.pircbot">DccFileTransfer</A></CODE></FONT></TD>
  246. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#dccSendFile(java.io.File, java.lang.String, int)">dccSendFile</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html" title="class or interface in java.io">File</A>&nbsp;file,
  247. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nick,
  248. int&nbsp;timeout)</CODE>
  249. <BR>
  250. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends a file to another user.</TD>
  251. </TR>
  252. <TR BGCOLOR="white" CLASS="TableRowColor">
  253. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  254. <CODE>&nbsp;void</CODE></FONT></TD>
  255. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#deOp(java.lang.String, java.lang.String)">deOp</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  256. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nick)</CODE>
  257. <BR>
  258. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes operator privilidges from a user on a channel.</TD>
  259. </TR>
  260. <TR BGCOLOR="white" CLASS="TableRowColor">
  261. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  262. <CODE>&nbsp;void</CODE></FONT></TD>
  263. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#deVoice(java.lang.String, java.lang.String)">deVoice</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  264. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nick)</CODE>
  265. <BR>
  266. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes voice privilidges from a user on a channel.</TD>
  267. </TR>
  268. <TR BGCOLOR="white" CLASS="TableRowColor">
  269. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  270. <CODE>&nbsp;void</CODE></FONT></TD>
  271. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#disconnect()">disconnect</A></B>()</CODE>
  272. <BR>
  273. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method disconnects from the server cleanly by calling the
  274. quitServer() method.</TD>
  275. </TR>
  276. <TR BGCOLOR="white" CLASS="TableRowColor">
  277. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  278. <CODE>&nbsp;void</CODE></FONT></TD>
  279. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#dispose()">dispose</A></B>()</CODE>
  280. <BR>
  281. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Disposes of all thread resources used by this PircBot.</TD>
  282. </TR>
  283. <TR BGCOLOR="white" CLASS="TableRowColor">
  284. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  285. <CODE>&nbsp;boolean</CODE></FONT></TD>
  286. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;o)</CODE>
  287. <BR>
  288. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if and only if the object being compared is the exact
  289. same instance as this PircBot.</TD>
  290. </TR>
  291. <TR BGCOLOR="white" CLASS="TableRowColor">
  292. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  293. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD>
  294. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getChannels()">getChannels</A></B>()</CODE>
  295. <BR>
  296. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of all channels that we are in.</TD>
  297. </TR>
  298. <TR BGCOLOR="white" CLASS="TableRowColor">
  299. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  300. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/net/InetAddress.html" title="class or interface in java.net">InetAddress</A></CODE></FONT></TD>
  301. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getDccInetAddress()">getDccInetAddress</A></B>()</CODE>
  302. <BR>
  303. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the InetAddress used when sending DCC chat or file transfers.</TD>
  304. </TR>
  305. <TR BGCOLOR="white" CLASS="TableRowColor">
  306. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  307. <CODE>&nbsp;int[]</CODE></FONT></TD>
  308. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getDccPorts()">getDccPorts</A></B>()</CODE>
  309. <BR>
  310. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the set of port numbers to be used when sending a DCC chat
  311. or file transfer.</TD>
  312. </TR>
  313. <TR BGCOLOR="white" CLASS="TableRowColor">
  314. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  315. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  316. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getEncoding()">getEncoding</A></B>()</CODE>
  317. <BR>
  318. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the encoding used to send and receive lines from
  319. the IRC server, or null if not set.</TD>
  320. </TR>
  321. <TR BGCOLOR="white" CLASS="TableRowColor">
  322. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  323. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  324. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getFinger()">getFinger</A></B>()</CODE>
  325. <BR>
  326. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the internal finger message of the PircBot.</TD>
  327. </TR>
  328. <TR BGCOLOR="white" CLASS="TableRowColor">
  329. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  330. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/net/InetAddress.html" title="class or interface in java.net">InetAddress</A></CODE></FONT></TD>
  331. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getInetAddress()">getInetAddress</A></B>()</CODE>
  332. <BR>
  333. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the InetAddress used by the PircBot.</TD>
  334. </TR>
  335. <TR BGCOLOR="white" CLASS="TableRowColor">
  336. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  337. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  338. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getLogin()">getLogin</A></B>()</CODE>
  339. <BR>
  340. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the internal login of the PircBot.</TD>
  341. </TR>
  342. <TR BGCOLOR="white" CLASS="TableRowColor">
  343. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  344. <CODE>&nbsp;int</CODE></FONT></TD>
  345. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getMaxLineLength()">getMaxLineLength</A></B>()</CODE>
  346. <BR>
  347. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the maximum length of any line that is sent via the IRC protocol.</TD>
  348. </TR>
  349. <TR BGCOLOR="white" CLASS="TableRowColor">
  350. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  351. <CODE>&nbsp;long</CODE></FONT></TD>
  352. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getMessageDelay()">getMessageDelay</A></B>()</CODE>
  353. <BR>
  354. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of milliseconds that will be used to separate
  355. consecutive messages to the server from the outgoing message queue.</TD>
  356. </TR>
  357. <TR BGCOLOR="white" CLASS="TableRowColor">
  358. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  359. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  360. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getName()">getName</A></B>()</CODE>
  361. <BR>
  362. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the name of the PircBot.</TD>
  363. </TR>
  364. <TR BGCOLOR="white" CLASS="TableRowColor">
  365. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  366. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  367. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getNick()">getNick</A></B>()</CODE>
  368. <BR>
  369. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the current nick of the bot.</TD>
  370. </TR>
  371. <TR BGCOLOR="white" CLASS="TableRowColor">
  372. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  373. <CODE>&nbsp;int</CODE></FONT></TD>
  374. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getOutgoingQueueSize()">getOutgoingQueueSize</A></B>()</CODE>
  375. <BR>
  376. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the number of lines currently waiting in the outgoing message Queue.</TD>
  377. </TR>
  378. <TR BGCOLOR="white" CLASS="TableRowColor">
  379. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  380. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  381. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getPassword()">getPassword</A></B>()</CODE>
  382. <BR>
  383. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the last password that we used when connecting to an IRC server.</TD>
  384. </TR>
  385. <TR BGCOLOR="white" CLASS="TableRowColor">
  386. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  387. <CODE>&nbsp;int</CODE></FONT></TD>
  388. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getPort()">getPort</A></B>()</CODE>
  389. <BR>
  390. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the port number of the last IRC server that the PircBot tried
  391. to connect to.</TD>
  392. </TR>
  393. <TR BGCOLOR="white" CLASS="TableRowColor">
  394. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  395. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  396. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getServer()">getServer</A></B>()</CODE>
  397. <BR>
  398. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of the last IRC server the PircBot tried to connect to.</TD>
  399. </TR>
  400. <TR BGCOLOR="white" CLASS="TableRowColor">
  401. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  402. <CODE>&nbsp;<A HREF="../../../org/jibble/pircbot/User.html" title="class in org.jibble.pircbot">User</A>[]</CODE></FONT></TD>
  403. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getUsers(java.lang.String)">getUsers</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel)</CODE>
  404. <BR>
  405. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of all users in the specified channel.</TD>
  406. </TR>
  407. <TR BGCOLOR="white" CLASS="TableRowColor">
  408. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  409. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  410. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getVersion()">getVersion</A></B>()</CODE>
  411. <BR>
  412. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the internal version of the PircBot.</TD>
  413. </TR>
  414. <TR BGCOLOR="white" CLASS="TableRowColor">
  415. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  416. <CODE>protected &nbsp;void</CODE></FONT></TD>
  417. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#handleLine(java.lang.String)">handleLine</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;line)</CODE>
  418. <BR>
  419. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method handles events when any line of text arrives from the server,
  420. then calling the appropriate method in the PircBot.</TD>
  421. </TR>
  422. <TR BGCOLOR="white" CLASS="TableRowColor">
  423. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  424. <CODE>&nbsp;int</CODE></FONT></TD>
  425. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#hashCode()">hashCode</A></B>()</CODE>
  426. <BR>
  427. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the hashCode of this PircBot.</TD>
  428. </TR>
  429. <TR BGCOLOR="white" CLASS="TableRowColor">
  430. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  431. <CODE>&nbsp;void</CODE></FONT></TD>
  432. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#identify(java.lang.String)">identify</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;password)</CODE>
  433. <BR>
  434. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Identify the bot with NickServ, supplying the appropriate password.</TD>
  435. </TR>
  436. <TR BGCOLOR="white" CLASS="TableRowColor">
  437. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  438. <CODE>&nbsp;long</CODE></FONT></TD>
  439. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#ipToLong(byte[])">ipToLong</A></B>(byte[]&nbsp;address)</CODE>
  440. <BR>
  441. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A convenient method that accepts an IP address represented by a byte[]
  442. of size 4 and returns this as a long representation of the same IP
  443. address.</TD>
  444. </TR>
  445. <TR BGCOLOR="white" CLASS="TableRowColor">
  446. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  447. <CODE>&nbsp;boolean</CODE></FONT></TD>
  448. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#isConnected()">isConnected</A></B>()</CODE>
  449. <BR>
  450. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether or not the PircBot is currently connected to a server.</TD>
  451. </TR>
  452. <TR BGCOLOR="white" CLASS="TableRowColor">
  453. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  454. <CODE>&nbsp;void</CODE></FONT></TD>
  455. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#joinChannel(java.lang.String)">joinChannel</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel)</CODE>
  456. <BR>
  457. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Joins a channel.</TD>
  458. </TR>
  459. <TR BGCOLOR="white" CLASS="TableRowColor">
  460. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  461. <CODE>&nbsp;void</CODE></FONT></TD>
  462. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#joinChannel(java.lang.String, java.lang.String)">joinChannel</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  463. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;key)</CODE>
  464. <BR>
  465. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Joins a channel with a key.</TD>
  466. </TR>
  467. <TR BGCOLOR="white" CLASS="TableRowColor">
  468. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  469. <CODE>&nbsp;void</CODE></FONT></TD>
  470. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#kick(java.lang.String, java.lang.String)">kick</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  471. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nick)</CODE>
  472. <BR>
  473. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Kicks a user from a channel.</TD>
  474. </TR>
  475. <TR BGCOLOR="white" CLASS="TableRowColor">
  476. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  477. <CODE>&nbsp;void</CODE></FONT></TD>
  478. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#kick(java.lang.String, java.lang.String, java.lang.String)">kick</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  479. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nick,
  480. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;reason)</CODE>
  481. <BR>
  482. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Kicks a user from a channel, giving a reason.</TD>
  483. </TR>
  484. <TR BGCOLOR="white" CLASS="TableRowColor">
  485. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  486. <CODE>&nbsp;void</CODE></FONT></TD>
  487. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#listChannels()">listChannels</A></B>()</CODE>
  488. <BR>
  489. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Issues a request for a list of all channels on the IRC server.</TD>
  490. </TR>
  491. <TR BGCOLOR="white" CLASS="TableRowColor">
  492. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  493. <CODE>&nbsp;void</CODE></FONT></TD>
  494. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#listChannels(java.lang.String)">listChannels</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;parameters)</CODE>
  495. <BR>
  496. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Issues a request for a list of all channels on the IRC server.</TD>
  497. </TR>
  498. <TR BGCOLOR="white" CLASS="TableRowColor">
  499. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  500. <CODE>&nbsp;void</CODE></FONT></TD>
  501. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#log(java.lang.String)">log</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;line)</CODE>
  502. <BR>
  503. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a line to the log.</TD>
  504. </TR>
  505. <TR BGCOLOR="white" CLASS="TableRowColor">
  506. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  507. <CODE>&nbsp;int[]</CODE></FONT></TD>
  508. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#longToIp(long)">longToIp</A></B>(long&nbsp;address)</CODE>
  509. <BR>
  510. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A convenient method that accepts an IP address represented as a
  511. long and returns an integer array of size 4 representing the same
  512. IP address.</TD>
  513. </TR>
  514. <TR BGCOLOR="white" CLASS="TableRowColor">
  515. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  516. <CODE>protected &nbsp;void</CODE></FONT></TD>
  517. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onAction(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onAction</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sender,
  518. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;login,
  519. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostname,
  520. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target,
  521. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;action)</CODE>
  522. <BR>
  523. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called whenever an ACTION is sent from a user.</TD>
  524. </TR>
  525. <TR BGCOLOR="white" CLASS="TableRowColor">
  526. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  527. <CODE>protected &nbsp;void</CODE></FONT></TD>
  528. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onChannelInfo(java.lang.String, int, java.lang.String)">onChannelInfo</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  529. int&nbsp;userCount,
  530. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;topic)</CODE>
  531. <BR>
  532. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;After calling the listChannels() method in PircBot, the server
  533. will start to send us information about each channel on the
  534. server.</TD>
  535. </TR>
  536. <TR BGCOLOR="white" CLASS="TableRowColor">
  537. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  538. <CODE>protected &nbsp;void</CODE></FONT></TD>
  539. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onConnect()">onConnect</A></B>()</CODE>
  540. <BR>
  541. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called once the PircBot has successfully connected to
  542. the IRC server.</TD>
  543. </TR>
  544. <TR BGCOLOR="white" CLASS="TableRowColor">
  545. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  546. <CODE>protected &nbsp;void</CODE></FONT></TD>
  547. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onDccChatRequest(java.lang.String, java.lang.String, java.lang.String, long, int)">onDccChatRequest</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  548. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  549. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  550. long&nbsp;address,
  551. int&nbsp;port)</CODE>
  552. <BR>
  553. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>As of PircBot 1.2.0, use <A HREF="../../../org/jibble/pircbot/PircBot.html#onIncomingChatRequest(org.jibble.pircbot.DccChat)"><CODE>onIncomingChatRequest(DccChat)</CODE></A></I></TD>
  554. </TR>
  555. <TR BGCOLOR="white" CLASS="TableRowColor">
  556. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  557. <CODE>protected &nbsp;void</CODE></FONT></TD>
  558. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onDccSendRequest(java.lang.String, java.lang.String, java.lang.String, java.lang.String, long, int, int)">onDccSendRequest</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  559. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  560. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  561. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;filename,
  562. long&nbsp;address,
  563. int&nbsp;port,
  564. int&nbsp;size)</CODE>
  565. <BR>
  566. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>As of PircBot 1.2.0, use <A HREF="../../../org/jibble/pircbot/PircBot.html#onIncomingFileTransfer(org.jibble.pircbot.DccFileTransfer)"><CODE>onIncomingFileTransfer(DccFileTransfer)</CODE></A></I></TD>
  567. </TR>
  568. <TR BGCOLOR="white" CLASS="TableRowColor">
  569. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  570. <CODE>protected &nbsp;void</CODE></FONT></TD>
  571. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onDeop(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onDeop</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  572. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  573. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  574. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  575. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;recipient)</CODE>
  576. <BR>
  577. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a user (possibly us) gets operator status taken away.</TD>
  578. </TR>
  579. <TR BGCOLOR="white" CLASS="TableRowColor">
  580. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  581. <CODE>protected &nbsp;void</CODE></FONT></TD>
  582. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onDeVoice(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onDeVoice</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  583. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  584. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  585. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  586. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;recipient)</CODE>
  587. <BR>
  588. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a user (possibly us) gets voice status removed.</TD>
  589. </TR>
  590. <TR BGCOLOR="white" CLASS="TableRowColor">
  591. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  592. <CODE>protected &nbsp;void</CODE></FONT></TD>
  593. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onDisconnect()">onDisconnect</A></B>()</CODE>
  594. <BR>
  595. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method carries out the actions to be performed when the PircBot
  596. gets disconnected.</TD>
  597. </TR>
  598. <TR BGCOLOR="white" CLASS="TableRowColor">
  599. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  600. <CODE>protected &nbsp;void</CODE></FONT></TD>
  601. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onFileTransferFinished(org.jibble.pircbot.DccFileTransfer, java.lang.Exception)">onFileTransferFinished</A></B>(<A HREF="../../../org/jibble/pircbot/DccFileTransfer.html" title="class in org.jibble.pircbot">DccFileTransfer</A>&nbsp;transfer,
  602. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A>&nbsp;e)</CODE>
  603. <BR>
  604. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method gets called when a DccFileTransfer has finished.</TD>
  605. </TR>
  606. <TR BGCOLOR="white" CLASS="TableRowColor">
  607. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  608. <CODE>protected &nbsp;void</CODE></FONT></TD>
  609. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onFinger(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onFinger</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  610. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  611. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  612. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target)</CODE>
  613. <BR>
  614. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called whenever we receive a FINGER request.</TD>
  615. </TR>
  616. <TR BGCOLOR="white" CLASS="TableRowColor">
  617. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  618. <CODE>protected &nbsp;void</CODE></FONT></TD>
  619. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onIncomingChatRequest(org.jibble.pircbot.DccChat)">onIncomingChatRequest</A></B>(<A HREF="../../../org/jibble/pircbot/DccChat.html" title="class in org.jibble.pircbot">DccChat</A>&nbsp;chat)</CODE>
  620. <BR>
  621. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method will be called whenever a DCC Chat request is received.</TD>
  622. </TR>
  623. <TR BGCOLOR="white" CLASS="TableRowColor">
  624. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  625. <CODE>protected &nbsp;void</CODE></FONT></TD>
  626. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onIncomingFileTransfer(org.jibble.pircbot.DccFileTransfer)">onIncomingFileTransfer</A></B>(<A HREF="../../../org/jibble/pircbot/DccFileTransfer.html" title="class in org.jibble.pircbot">DccFileTransfer</A>&nbsp;transfer)</CODE>
  627. <BR>
  628. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called whenever a DCC SEND request is sent to the PircBot.</TD>
  629. </TR>
  630. <TR BGCOLOR="white" CLASS="TableRowColor">
  631. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  632. <CODE>protected &nbsp;void</CODE></FONT></TD>
  633. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onInvite(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onInvite</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;targetNick,
  634. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  635. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  636. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  637. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel)</CODE>
  638. <BR>
  639. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when we are invited to a channel by a user.</TD>
  640. </TR>
  641. <TR BGCOLOR="white" CLASS="TableRowColor">
  642. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  643. <CODE>protected &nbsp;void</CODE></FONT></TD>
  644. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onJoin(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onJoin</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  645. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sender,
  646. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;login,
  647. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostname)</CODE>
  648. <BR>
  649. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called whenever someone (possibly us) joins a channel
  650. which we are on.</TD>
  651. </TR>
  652. <TR BGCOLOR="white" CLASS="TableRowColor">
  653. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  654. <CODE>protected &nbsp;void</CODE></FONT></TD>
  655. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onKick(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onKick</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  656. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;kickerNick,
  657. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;kickerLogin,
  658. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;kickerHostname,
  659. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;recipientNick,
  660. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;reason)</CODE>
  661. <BR>
  662. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called whenever someone (possibly us) is kicked from
  663. any of the channels that we are in.</TD>
  664. </TR>
  665. <TR BGCOLOR="white" CLASS="TableRowColor">
  666. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  667. <CODE>protected &nbsp;void</CODE></FONT></TD>
  668. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onMessage(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onMessage</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  669. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sender,
  670. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;login,
  671. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostname,
  672. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;message)</CODE>
  673. <BR>
  674. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called whenever a message is sent to a channel.</TD>
  675. </TR>
  676. <TR BGCOLOR="white" CLASS="TableRowColor">
  677. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  678. <CODE>protected &nbsp;void</CODE></FONT></TD>
  679. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onMode(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onMode</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  680. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  681. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  682. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  683. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;mode)</CODE>
  684. <BR>
  685. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when the mode of a channel is set.</TD>
  686. </TR>
  687. <TR BGCOLOR="white" CLASS="TableRowColor">
  688. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  689. <CODE>protected &nbsp;void</CODE></FONT></TD>
  690. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onNickChange(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onNickChange</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;oldNick,
  691. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;login,
  692. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostname,
  693. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;newNick)</CODE>
  694. <BR>
  695. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called whenever someone (possibly us) changes nick on any
  696. of the channels that we are on.</TD>
  697. </TR>
  698. <TR BGCOLOR="white" CLASS="TableRowColor">
  699. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  700. <CODE>protected &nbsp;void</CODE></FONT></TD>
  701. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onNotice(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onNotice</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  702. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  703. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  704. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target,
  705. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;notice)</CODE>
  706. <BR>
  707. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called whenever we receive a notice.</TD>
  708. </TR>
  709. <TR BGCOLOR="white" CLASS="TableRowColor">
  710. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  711. <CODE>protected &nbsp;void</CODE></FONT></TD>
  712. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onOp(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onOp</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  713. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  714. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  715. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  716. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;recipient)</CODE>
  717. <BR>
  718. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a user (possibly us) gets granted operator status for a channel.</TD>
  719. </TR>
  720. <TR BGCOLOR="white" CLASS="TableRowColor">
  721. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  722. <CODE>protected &nbsp;void</CODE></FONT></TD>
  723. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onPart(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onPart</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  724. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sender,
  725. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;login,
  726. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostname)</CODE>
  727. <BR>
  728. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called whenever someone (possibly us) parts a channel
  729. which we are on.</TD>
  730. </TR>
  731. <TR BGCOLOR="white" CLASS="TableRowColor">
  732. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  733. <CODE>protected &nbsp;void</CODE></FONT></TD>
  734. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onPing(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onPing</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  735. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  736. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  737. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target,
  738. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;pingValue)</CODE>
  739. <BR>
  740. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called whenever we receive a PING request from another
  741. user.</TD>
  742. </TR>
  743. <TR BGCOLOR="white" CLASS="TableRowColor">
  744. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  745. <CODE>protected &nbsp;void</CODE></FONT></TD>
  746. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onPrivateMessage(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onPrivateMessage</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sender,
  747. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;login,
  748. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostname,
  749. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;message)</CODE>
  750. <BR>
  751. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called whenever a private message is sent to the PircBot.</TD>
  752. </TR>
  753. <TR BGCOLOR="white" CLASS="TableRowColor">
  754. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  755. <CODE>protected &nbsp;void</CODE></FONT></TD>
  756. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onQuit(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onQuit</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  757. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  758. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  759. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;reason)</CODE>
  760. <BR>
  761. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called whenever someone (possibly us) quits from the
  762. server.</TD>
  763. </TR>
  764. <TR BGCOLOR="white" CLASS="TableRowColor">
  765. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  766. <CODE>protected &nbsp;void</CODE></FONT></TD>
  767. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onRemoveChannelBan(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onRemoveChannelBan</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  768. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  769. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  770. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  771. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostmask)</CODE>
  772. <BR>
  773. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a hostmask ban is removed from a channel.</TD>
  774. </TR>
  775. <TR BGCOLOR="white" CLASS="TableRowColor">
  776. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  777. <CODE>protected &nbsp;void</CODE></FONT></TD>
  778. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onRemoveChannelKey(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onRemoveChannelKey</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  779. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  780. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  781. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  782. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;key)</CODE>
  783. <BR>
  784. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a channel key is removed.</TD>
  785. </TR>
  786. <TR BGCOLOR="white" CLASS="TableRowColor">
  787. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  788. <CODE>protected &nbsp;void</CODE></FONT></TD>
  789. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onRemoveChannelLimit(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onRemoveChannelLimit</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  790. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  791. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  792. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</CODE>
  793. <BR>
  794. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when the user limit is removed for a channel.</TD>
  795. </TR>
  796. <TR BGCOLOR="white" CLASS="TableRowColor">
  797. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  798. <CODE>protected &nbsp;void</CODE></FONT></TD>
  799. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onRemoveInviteOnly(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onRemoveInviteOnly</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  800. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  801. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  802. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</CODE>
  803. <BR>
  804. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a channel has 'invite only' removed.</TD>
  805. </TR>
  806. <TR BGCOLOR="white" CLASS="TableRowColor">
  807. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  808. <CODE>protected &nbsp;void</CODE></FONT></TD>
  809. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onRemoveModerated(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onRemoveModerated</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  810. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  811. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  812. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</CODE>
  813. <BR>
  814. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a channel has moderated mode removed.</TD>
  815. </TR>
  816. <TR BGCOLOR="white" CLASS="TableRowColor">
  817. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  818. <CODE>protected &nbsp;void</CODE></FONT></TD>
  819. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onRemoveNoExternalMessages(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onRemoveNoExternalMessages</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  820. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  821. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  822. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</CODE>
  823. <BR>
  824. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a channel is set to allow messages from any user, even
  825. if they are not actually in the channel.</TD>
  826. </TR>
  827. <TR BGCOLOR="white" CLASS="TableRowColor">
  828. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  829. <CODE>protected &nbsp;void</CODE></FONT></TD>
  830. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onRemovePrivate(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onRemovePrivate</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  831. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  832. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  833. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</CODE>
  834. <BR>
  835. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a channel is marked as not being in private mode.</TD>
  836. </TR>
  837. <TR BGCOLOR="white" CLASS="TableRowColor">
  838. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  839. <CODE>protected &nbsp;void</CODE></FONT></TD>
  840. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onRemoveSecret(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onRemoveSecret</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  841. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  842. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  843. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</CODE>
  844. <BR>
  845. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a channel has 'secret' mode removed.</TD>
  846. </TR>
  847. <TR BGCOLOR="white" CLASS="TableRowColor">
  848. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  849. <CODE>protected &nbsp;void</CODE></FONT></TD>
  850. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onRemoveTopicProtection(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onRemoveTopicProtection</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  851. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  852. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  853. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</CODE>
  854. <BR>
  855. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when topic protection is removed for a channel.</TD>
  856. </TR>
  857. <TR BGCOLOR="white" CLASS="TableRowColor">
  858. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  859. <CODE>protected &nbsp;void</CODE></FONT></TD>
  860. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onServerPing(java.lang.String)">onServerPing</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;response)</CODE>
  861. <BR>
  862. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The actions to perform when a PING request comes from the server.</TD>
  863. </TR>
  864. <TR BGCOLOR="white" CLASS="TableRowColor">
  865. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  866. <CODE>protected &nbsp;void</CODE></FONT></TD>
  867. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onServerResponse(int, java.lang.String)">onServerResponse</A></B>(int&nbsp;code,
  868. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;response)</CODE>
  869. <BR>
  870. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called when we receive a numeric response from the
  871. IRC server.</TD>
  872. </TR>
  873. <TR BGCOLOR="white" CLASS="TableRowColor">
  874. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  875. <CODE>protected &nbsp;void</CODE></FONT></TD>
  876. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onSetChannelBan(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onSetChannelBan</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  877. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  878. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  879. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  880. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostmask)</CODE>
  881. <BR>
  882. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a user (possibly us) gets banned from a channel.</TD>
  883. </TR>
  884. <TR BGCOLOR="white" CLASS="TableRowColor">
  885. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  886. <CODE>protected &nbsp;void</CODE></FONT></TD>
  887. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onSetChannelKey(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onSetChannelKey</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  888. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  889. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  890. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  891. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;key)</CODE>
  892. <BR>
  893. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a channel key is set.</TD>
  894. </TR>
  895. <TR BGCOLOR="white" CLASS="TableRowColor">
  896. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  897. <CODE>protected &nbsp;void</CODE></FONT></TD>
  898. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onSetChannelLimit(java.lang.String, java.lang.String, java.lang.String, java.lang.String, int)">onSetChannelLimit</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  899. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  900. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  901. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  902. int&nbsp;limit)</CODE>
  903. <BR>
  904. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a user limit is set for a channel.</TD>
  905. </TR>
  906. <TR BGCOLOR="white" CLASS="TableRowColor">
  907. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  908. <CODE>protected &nbsp;void</CODE></FONT></TD>
  909. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onSetInviteOnly(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onSetInviteOnly</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  910. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  911. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  912. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</CODE>
  913. <BR>
  914. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a channel is set to 'invite only' mode.</TD>
  915. </TR>
  916. <TR BGCOLOR="white" CLASS="TableRowColor">
  917. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  918. <CODE>protected &nbsp;void</CODE></FONT></TD>
  919. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onSetModerated(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onSetModerated</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  920. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  921. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  922. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</CODE>
  923. <BR>
  924. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a channel is set to 'moderated' mode.</TD>
  925. </TR>
  926. <TR BGCOLOR="white" CLASS="TableRowColor">
  927. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  928. <CODE>protected &nbsp;void</CODE></FONT></TD>
  929. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onSetNoExternalMessages(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onSetNoExternalMessages</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  930. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  931. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  932. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</CODE>
  933. <BR>
  934. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a channel is set to only allow messages from users that
  935. are in the channel.</TD>
  936. </TR>
  937. <TR BGCOLOR="white" CLASS="TableRowColor">
  938. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  939. <CODE>protected &nbsp;void</CODE></FONT></TD>
  940. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onSetPrivate(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onSetPrivate</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  941. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  942. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  943. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</CODE>
  944. <BR>
  945. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a channel is marked as being in private mode.</TD>
  946. </TR>
  947. <TR BGCOLOR="white" CLASS="TableRowColor">
  948. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  949. <CODE>protected &nbsp;void</CODE></FONT></TD>
  950. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onSetSecret(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onSetSecret</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  951. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  952. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  953. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</CODE>
  954. <BR>
  955. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a channel is set to be in 'secret' mode.</TD>
  956. </TR>
  957. <TR BGCOLOR="white" CLASS="TableRowColor">
  958. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  959. <CODE>protected &nbsp;void</CODE></FONT></TD>
  960. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onSetTopicProtection(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onSetTopicProtection</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  961. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  962. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  963. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</CODE>
  964. <BR>
  965. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when topic protection is enabled for a channel.</TD>
  966. </TR>
  967. <TR BGCOLOR="white" CLASS="TableRowColor">
  968. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  969. <CODE>protected &nbsp;void</CODE></FONT></TD>
  970. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onTime(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onTime</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  971. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  972. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  973. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target)</CODE>
  974. <BR>
  975. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called whenever we receive a TIME request.</TD>
  976. </TR>
  977. <TR BGCOLOR="white" CLASS="TableRowColor">
  978. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  979. <CODE>protected &nbsp;void</CODE></FONT></TD>
  980. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onTopic(java.lang.String, java.lang.String)">onTopic</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  981. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;topic)</CODE>
  982. <BR>
  983. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>As of 1.2.0, replaced by <A HREF="../../../org/jibble/pircbot/PircBot.html#onTopic(java.lang.String, java.lang.String, java.lang.String, long, boolean)"><CODE>onTopic(String,String,String,long,boolean)</CODE></A></I></TD>
  984. </TR>
  985. <TR BGCOLOR="white" CLASS="TableRowColor">
  986. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  987. <CODE>protected &nbsp;void</CODE></FONT></TD>
  988. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onTopic(java.lang.String, java.lang.String, java.lang.String, long, boolean)">onTopic</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  989. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;topic,
  990. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;setBy,
  991. long&nbsp;date,
  992. boolean&nbsp;changed)</CODE>
  993. <BR>
  994. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called whenever a user sets the topic, or when
  995. PircBot joins a new channel and discovers its topic.</TD>
  996. </TR>
  997. <TR BGCOLOR="white" CLASS="TableRowColor">
  998. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  999. <CODE>protected &nbsp;void</CODE></FONT></TD>
  1000. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onUnknown(java.lang.String)">onUnknown</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;line)</CODE>
  1001. <BR>
  1002. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called whenever we receive a line from the server that
  1003. the PircBot has not been programmed to recognise.</TD>
  1004. </TR>
  1005. <TR BGCOLOR="white" CLASS="TableRowColor">
  1006. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1007. <CODE>protected &nbsp;void</CODE></FONT></TD>
  1008. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onUserList(java.lang.String, org.jibble.pircbot.User[])">onUserList</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1009. <A HREF="../../../org/jibble/pircbot/User.html" title="class in org.jibble.pircbot">User</A>[]&nbsp;users)</CODE>
  1010. <BR>
  1011. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called when we receive a user list from the server
  1012. after joining a channel.</TD>
  1013. </TR>
  1014. <TR BGCOLOR="white" CLASS="TableRowColor">
  1015. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1016. <CODE>protected &nbsp;void</CODE></FONT></TD>
  1017. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onUserMode(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onUserMode</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;targetNick,
  1018. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  1019. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  1020. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  1021. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;mode)</CODE>
  1022. <BR>
  1023. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when the mode of a user is set.</TD>
  1024. </TR>
  1025. <TR BGCOLOR="white" CLASS="TableRowColor">
  1026. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1027. <CODE>protected &nbsp;void</CODE></FONT></TD>
  1028. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onVersion(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onVersion</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  1029. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  1030. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  1031. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target)</CODE>
  1032. <BR>
  1033. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called whenever we receive a VERSION request.</TD>
  1034. </TR>
  1035. <TR BGCOLOR="white" CLASS="TableRowColor">
  1036. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1037. <CODE>protected &nbsp;void</CODE></FONT></TD>
  1038. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onVoice(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">onVoice</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1039. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  1040. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  1041. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  1042. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;recipient)</CODE>
  1043. <BR>
  1044. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a user (possibly us) gets voice status granted in a channel.</TD>
  1045. </TR>
  1046. <TR BGCOLOR="white" CLASS="TableRowColor">
  1047. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1048. <CODE>&nbsp;void</CODE></FONT></TD>
  1049. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#op(java.lang.String, java.lang.String)">op</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1050. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nick)</CODE>
  1051. <BR>
  1052. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Grants operator privilidges to a user on a channel.</TD>
  1053. </TR>
  1054. <TR BGCOLOR="white" CLASS="TableRowColor">
  1055. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1056. <CODE>&nbsp;void</CODE></FONT></TD>
  1057. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#partChannel(java.lang.String)">partChannel</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel)</CODE>
  1058. <BR>
  1059. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parts a channel.</TD>
  1060. </TR>
  1061. <TR BGCOLOR="white" CLASS="TableRowColor">
  1062. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1063. <CODE>&nbsp;void</CODE></FONT></TD>
  1064. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#partChannel(java.lang.String, java.lang.String)">partChannel</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1065. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;reason)</CODE>
  1066. <BR>
  1067. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parts a channel, giving a reason.</TD>
  1068. </TR>
  1069. <TR BGCOLOR="white" CLASS="TableRowColor">
  1070. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1071. <CODE>&nbsp;void</CODE></FONT></TD>
  1072. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#quitServer()">quitServer</A></B>()</CODE>
  1073. <BR>
  1074. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Quits from the IRC server.</TD>
  1075. </TR>
  1076. <TR BGCOLOR="white" CLASS="TableRowColor">
  1077. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1078. <CODE>&nbsp;void</CODE></FONT></TD>
  1079. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#quitServer(java.lang.String)">quitServer</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;reason)</CODE>
  1080. <BR>
  1081. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Quits from the IRC server with a reason.</TD>
  1082. </TR>
  1083. <TR BGCOLOR="white" CLASS="TableRowColor">
  1084. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1085. <CODE>&nbsp;void</CODE></FONT></TD>
  1086. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#reconnect()">reconnect</A></B>()</CODE>
  1087. <BR>
  1088. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reconnects to the IRC server that we were previously connected to.</TD>
  1089. </TR>
  1090. <TR BGCOLOR="white" CLASS="TableRowColor">
  1091. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1092. <CODE>&nbsp;void</CODE></FONT></TD>
  1093. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#sendAction(java.lang.String, java.lang.String)">sendAction</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target,
  1094. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;action)</CODE>
  1095. <BR>
  1096. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends an action to the channel or to a user.</TD>
  1097. </TR>
  1098. <TR BGCOLOR="white" CLASS="TableRowColor">
  1099. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1100. <CODE>&nbsp;void</CODE></FONT></TD>
  1101. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#sendCTCPCommand(java.lang.String, java.lang.String)">sendCTCPCommand</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target,
  1102. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;command)</CODE>
  1103. <BR>
  1104. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends a CTCP command to a channel or user.</TD>
  1105. </TR>
  1106. <TR BGCOLOR="white" CLASS="TableRowColor">
  1107. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1108. <CODE>&nbsp;void</CODE></FONT></TD>
  1109. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#sendInvite(java.lang.String, java.lang.String)">sendInvite</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nick,
  1110. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel)</CODE>
  1111. <BR>
  1112. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends an invitation to join a channel.</TD>
  1113. </TR>
  1114. <TR BGCOLOR="white" CLASS="TableRowColor">
  1115. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1116. <CODE>&nbsp;void</CODE></FONT></TD>
  1117. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#sendMessage(java.lang.String, java.lang.String)">sendMessage</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target,
  1118. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;message)</CODE>
  1119. <BR>
  1120. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends a message to a channel or a private message to a user.</TD>
  1121. </TR>
  1122. <TR BGCOLOR="white" CLASS="TableRowColor">
  1123. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1124. <CODE>&nbsp;void</CODE></FONT></TD>
  1125. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#sendNotice(java.lang.String, java.lang.String)">sendNotice</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target,
  1126. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;notice)</CODE>
  1127. <BR>
  1128. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends a notice to the channel or to a user.</TD>
  1129. </TR>
  1130. <TR BGCOLOR="white" CLASS="TableRowColor">
  1131. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1132. <CODE>&nbsp;void</CODE></FONT></TD>
  1133. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#sendRawLine(java.lang.String)">sendRawLine</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;line)</CODE>
  1134. <BR>
  1135. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends a raw line to the IRC server as soon as possible, bypassing the
  1136. outgoing message queue.</TD>
  1137. </TR>
  1138. <TR BGCOLOR="white" CLASS="TableRowColor">
  1139. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1140. <CODE>&nbsp;void</CODE></FONT></TD>
  1141. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#sendRawLineViaQueue(java.lang.String)">sendRawLineViaQueue</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;line)</CODE>
  1142. <BR>
  1143. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends a raw line through the outgoing message queue.</TD>
  1144. </TR>
  1145. <TR BGCOLOR="white" CLASS="TableRowColor">
  1146. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1147. <CODE>&nbsp;void</CODE></FONT></TD>
  1148. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#setAutoNickChange(boolean)">setAutoNickChange</A></B>(boolean&nbsp;autoNickChange)</CODE>
  1149. <BR>
  1150. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;When you connect to a server and your nick is already in use and
  1151. this is set to true, a new nick will be automatically chosen.</TD>
  1152. </TR>
  1153. <TR BGCOLOR="white" CLASS="TableRowColor">
  1154. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1155. <CODE>&nbsp;void</CODE></FONT></TD>
  1156. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#setDccInetAddress(java.net.InetAddress)">setDccInetAddress</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/net/InetAddress.html" title="class or interface in java.net">InetAddress</A>&nbsp;dccInetAddress)</CODE>
  1157. <BR>
  1158. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the InetAddress to be used when sending DCC chat or file transfers.</TD>
  1159. </TR>
  1160. <TR BGCOLOR="white" CLASS="TableRowColor">
  1161. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1162. <CODE>&nbsp;void</CODE></FONT></TD>
  1163. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#setDccPorts(int[])">setDccPorts</A></B>(int[]&nbsp;ports)</CODE>
  1164. <BR>
  1165. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the choice of port numbers that can be used when sending a DCC chat
  1166. or file transfer.</TD>
  1167. </TR>
  1168. <TR BGCOLOR="white" CLASS="TableRowColor">
  1169. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1170. <CODE>&nbsp;void</CODE></FONT></TD>
  1171. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#setEncoding(java.lang.String)">setEncoding</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;charset)</CODE>
  1172. <BR>
  1173. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the encoding charset to be used when sending or receiving lines
  1174. from the IRC server.</TD>
  1175. </TR>
  1176. <TR BGCOLOR="white" CLASS="TableRowColor">
  1177. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1178. <CODE>protected &nbsp;void</CODE></FONT></TD>
  1179. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#setFinger(java.lang.String)">setFinger</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;finger)</CODE>
  1180. <BR>
  1181. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the interal finger message.</TD>
  1182. </TR>
  1183. <TR BGCOLOR="white" CLASS="TableRowColor">
  1184. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1185. <CODE>protected &nbsp;void</CODE></FONT></TD>
  1186. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#setLogin(java.lang.String)">setLogin</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;login)</CODE>
  1187. <BR>
  1188. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the internal login of the Bot.</TD>
  1189. </TR>
  1190. <TR BGCOLOR="white" CLASS="TableRowColor">
  1191. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1192. <CODE>&nbsp;void</CODE></FONT></TD>
  1193. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#setMessageDelay(long)">setMessageDelay</A></B>(long&nbsp;delay)</CODE>
  1194. <BR>
  1195. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the number of milliseconds to delay between consecutive
  1196. messages when there are multiple messages waiting in the
  1197. outgoing message queue.</TD>
  1198. </TR>
  1199. <TR BGCOLOR="white" CLASS="TableRowColor">
  1200. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1201. <CODE>&nbsp;void</CODE></FONT></TD>
  1202. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#setMode(java.lang.String, java.lang.String)">setMode</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1203. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;mode)</CODE>
  1204. <BR>
  1205. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the mode of a channel.</TD>
  1206. </TR>
  1207. <TR BGCOLOR="white" CLASS="TableRowColor">
  1208. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1209. <CODE>protected &nbsp;void</CODE></FONT></TD>
  1210. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#setName(java.lang.String)">setName</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)</CODE>
  1211. <BR>
  1212. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the name of the bot, which will be used as its nick when it
  1213. tries to join an IRC server.</TD>
  1214. </TR>
  1215. <TR BGCOLOR="white" CLASS="TableRowColor">
  1216. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1217. <CODE>&nbsp;void</CODE></FONT></TD>
  1218. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#setTopic(java.lang.String, java.lang.String)">setTopic</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1219. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;topic)</CODE>
  1220. <BR>
  1221. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the topic for a channel.</TD>
  1222. </TR>
  1223. <TR BGCOLOR="white" CLASS="TableRowColor">
  1224. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1225. <CODE>&nbsp;void</CODE></FONT></TD>
  1226. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#setVerbose(boolean)">setVerbose</A></B>(boolean&nbsp;verbose)</CODE>
  1227. <BR>
  1228. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the verbose mode.</TD>
  1229. </TR>
  1230. <TR BGCOLOR="white" CLASS="TableRowColor">
  1231. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1232. <CODE>protected &nbsp;void</CODE></FONT></TD>
  1233. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#setVersion(java.lang.String)">setVersion</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;version)</CODE>
  1234. <BR>
  1235. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the internal version of the Bot.</TD>
  1236. </TR>
  1237. <TR BGCOLOR="white" CLASS="TableRowColor">
  1238. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1239. <CODE>&nbsp;void</CODE></FONT></TD>
  1240. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#startIdentServer()">startIdentServer</A></B>()</CODE>
  1241. <BR>
  1242. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Starts an ident server (Identification Protocol Server, RFC 1413).</TD>
  1243. </TR>
  1244. <TR BGCOLOR="white" CLASS="TableRowColor">
  1245. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1246. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  1247. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#toString()">toString</A></B>()</CODE>
  1248. <BR>
  1249. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a String representation of this object.</TD>
  1250. </TR>
  1251. <TR BGCOLOR="white" CLASS="TableRowColor">
  1252. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1253. <CODE>&nbsp;void</CODE></FONT></TD>
  1254. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#unBan(java.lang.String, java.lang.String)">unBan</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1255. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostmask)</CODE>
  1256. <BR>
  1257. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Unbans a user from a channel.</TD>
  1258. </TR>
  1259. <TR BGCOLOR="white" CLASS="TableRowColor">
  1260. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  1261. <CODE>&nbsp;void</CODE></FONT></TD>
  1262. <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#voice(java.lang.String, java.lang.String)">voice</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1263. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nick)</CODE>
  1264. <BR>
  1265. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Grants voice privilidges to a user on a channel.</TD>
  1266. </TR>
  1267. </TABLE>
  1268. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  1269. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  1270. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  1271. <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TD>
  1272. </TR>
  1273. <TR BGCOLOR="white" CLASS="TableRowColor">
  1274. <TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
  1275. </TR>
  1276. </TABLE>
  1277. &nbsp;
  1278. <P>
  1279. <!-- ============ FIELD DETAIL =========== -->
  1280. <A NAME="field_detail"><!-- --></A>
  1281. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  1282. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  1283. <TD COLSPAN=1><FONT SIZE="+2">
  1284. <B>Field Detail</B></FONT></TD>
  1285. </TR>
  1286. </TABLE>
  1287. <A NAME="VERSION"><!-- --></A><H3>
  1288. VERSION</H3>
  1289. <PRE>
  1290. public static final <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>VERSION</B></PRE>
  1291. <DL>
  1292. <DD>The definitive version number of this release of PircBot.
  1293. (Note: Change this before automatically building releases)
  1294. <P>
  1295. <DL>
  1296. <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.jibble.pircbot.PircBot.VERSION">Constant Field Values</A></DL>
  1297. </DL>
  1298. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  1299. <A NAME="constructor_detail"><!-- --></A>
  1300. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  1301. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  1302. <TD COLSPAN=1><FONT SIZE="+2">
  1303. <B>Constructor Detail</B></FONT></TD>
  1304. </TR>
  1305. </TABLE>
  1306. <A NAME="PircBot()"><!-- --></A><H3>
  1307. PircBot</H3>
  1308. <PRE>
  1309. public <B>PircBot</B>()</PRE>
  1310. <DL>
  1311. <DD>Constructs a PircBot with the default settings. Your own constructors
  1312. in classes which extend the PircBot abstract class should be responsible
  1313. for changing the default settings if required.
  1314. <P>
  1315. </DL>
  1316. <!-- ============ METHOD DETAIL ========== -->
  1317. <A NAME="method_detail"><!-- --></A>
  1318. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  1319. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  1320. <TD COLSPAN=1><FONT SIZE="+2">
  1321. <B>Method Detail</B></FONT></TD>
  1322. </TR>
  1323. </TABLE>
  1324. <A NAME="connect(java.lang.String)"><!-- --></A><H3>
  1325. connect</H3>
  1326. <PRE>
  1327. public final void <B>connect</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostname)
  1328. throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A>,
  1329. <A HREF="../../../org/jibble/pircbot/IrcException.html" title="class in org.jibble.pircbot">IrcException</A>,
  1330. <A HREF="../../../org/jibble/pircbot/NickAlreadyInUseException.html" title="class in org.jibble.pircbot">NickAlreadyInUseException</A></PRE>
  1331. <DL>
  1332. <DD>Attempt to connect to the specified IRC server.
  1333. The onConnect method is called upon success.
  1334. <P>
  1335. <DD><DL>
  1336. </DL>
  1337. </DD>
  1338. <DD><DL>
  1339. <DT><B>Parameters:</B><DD><CODE>hostname</CODE> - The hostname of the server to connect to.
  1340. <DT><B>Throws:</B>
  1341. <DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if it was not possible to connect to the server.
  1342. <DD><CODE><A HREF="../../../org/jibble/pircbot/IrcException.html" title="class in org.jibble.pircbot">IrcException</A></CODE> - if the server would not let us join it.
  1343. <DD><CODE><A HREF="../../../org/jibble/pircbot/NickAlreadyInUseException.html" title="class in org.jibble.pircbot">NickAlreadyInUseException</A></CODE> - if our nick is already in use on the server.</DL>
  1344. </DD>
  1345. </DL>
  1346. <HR>
  1347. <A NAME="connect(java.lang.String, int)"><!-- --></A><H3>
  1348. connect</H3>
  1349. <PRE>
  1350. public final void <B>connect</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostname,
  1351. int&nbsp;port)
  1352. throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A>,
  1353. <A HREF="../../../org/jibble/pircbot/IrcException.html" title="class in org.jibble.pircbot">IrcException</A>,
  1354. <A HREF="../../../org/jibble/pircbot/NickAlreadyInUseException.html" title="class in org.jibble.pircbot">NickAlreadyInUseException</A></PRE>
  1355. <DL>
  1356. <DD>Attempt to connect to the specified IRC server and port number.
  1357. The onConnect method is called upon success.
  1358. <P>
  1359. <DD><DL>
  1360. </DL>
  1361. </DD>
  1362. <DD><DL>
  1363. <DT><B>Parameters:</B><DD><CODE>hostname</CODE> - The hostname of the server to connect to.<DD><CODE>port</CODE> - The port number to connect to on the server.
  1364. <DT><B>Throws:</B>
  1365. <DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if it was not possible to connect to the server.
  1366. <DD><CODE><A HREF="../../../org/jibble/pircbot/IrcException.html" title="class in org.jibble.pircbot">IrcException</A></CODE> - if the server would not let us join it.
  1367. <DD><CODE><A HREF="../../../org/jibble/pircbot/NickAlreadyInUseException.html" title="class in org.jibble.pircbot">NickAlreadyInUseException</A></CODE> - if our nick is already in use on the server.</DL>
  1368. </DD>
  1369. </DL>
  1370. <HR>
  1371. <A NAME="connect(java.lang.String, int, java.lang.String)"><!-- --></A><H3>
  1372. connect</H3>
  1373. <PRE>
  1374. public final void <B>connect</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostname,
  1375. int&nbsp;port,
  1376. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;password)
  1377. throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A>,
  1378. <A HREF="../../../org/jibble/pircbot/IrcException.html" title="class in org.jibble.pircbot">IrcException</A>,
  1379. <A HREF="../../../org/jibble/pircbot/NickAlreadyInUseException.html" title="class in org.jibble.pircbot">NickAlreadyInUseException</A></PRE>
  1380. <DL>
  1381. <DD>Attempt to connect to the specified IRC server using the supplied
  1382. password.
  1383. The onConnect method is called upon success.
  1384. <P>
  1385. <DD><DL>
  1386. </DL>
  1387. </DD>
  1388. <DD><DL>
  1389. <DT><B>Parameters:</B><DD><CODE>hostname</CODE> - The hostname of the server to connect to.<DD><CODE>port</CODE> - The port number to connect to on the server.<DD><CODE>password</CODE> - The password to use to join the server.
  1390. <DT><B>Throws:</B>
  1391. <DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if it was not possible to connect to the server.
  1392. <DD><CODE><A HREF="../../../org/jibble/pircbot/IrcException.html" title="class in org.jibble.pircbot">IrcException</A></CODE> - if the server would not let us join it.
  1393. <DD><CODE><A HREF="../../../org/jibble/pircbot/NickAlreadyInUseException.html" title="class in org.jibble.pircbot">NickAlreadyInUseException</A></CODE> - if our nick is already in use on the server.</DL>
  1394. </DD>
  1395. </DL>
  1396. <HR>
  1397. <A NAME="reconnect()"><!-- --></A><H3>
  1398. reconnect</H3>
  1399. <PRE>
  1400. public final void <B>reconnect</B>()
  1401. throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A>,
  1402. <A HREF="../../../org/jibble/pircbot/IrcException.html" title="class in org.jibble.pircbot">IrcException</A>,
  1403. <A HREF="../../../org/jibble/pircbot/NickAlreadyInUseException.html" title="class in org.jibble.pircbot">NickAlreadyInUseException</A></PRE>
  1404. <DL>
  1405. <DD>Reconnects to the IRC server that we were previously connected to.
  1406. If necessary, the appropriate port number and password will be used.
  1407. This method will throw an IrcException if we have never connected
  1408. to an IRC server previously.
  1409. <P>
  1410. <DD><DL>
  1411. </DL>
  1412. </DD>
  1413. <DD><DL>
  1414. <DT><B>Throws:</B>
  1415. <DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if it was not possible to connect to the server.
  1416. <DD><CODE><A HREF="../../../org/jibble/pircbot/IrcException.html" title="class in org.jibble.pircbot">IrcException</A></CODE> - if the server would not let us join it.
  1417. <DD><CODE><A HREF="../../../org/jibble/pircbot/NickAlreadyInUseException.html" title="class in org.jibble.pircbot">NickAlreadyInUseException</A></CODE> - if our nick is already in use on the server.<DT><B>Since:</B></DT>
  1418. <DD>PircBot 0.9.9</DD>
  1419. </DL>
  1420. </DD>
  1421. </DL>
  1422. <HR>
  1423. <A NAME="disconnect()"><!-- --></A><H3>
  1424. disconnect</H3>
  1425. <PRE>
  1426. public final void <B>disconnect</B>()</PRE>
  1427. <DL>
  1428. <DD>This method disconnects from the server cleanly by calling the
  1429. quitServer() method. Providing the PircBot was connected to an
  1430. IRC server, the onDisconnect() will be called as soon as the
  1431. disconnection is made by the server.
  1432. <P>
  1433. <DD><DL>
  1434. </DL>
  1435. </DD>
  1436. <DD><DL>
  1437. <DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/PircBot.html#quitServer()"><CODE>quitServer</CODE></A>,
  1438. <A HREF="../../../org/jibble/pircbot/PircBot.html#quitServer(java.lang.String)"><CODE>quitServer</CODE></A></DL>
  1439. </DD>
  1440. </DL>
  1441. <HR>
  1442. <A NAME="setAutoNickChange(boolean)"><!-- --></A><H3>
  1443. setAutoNickChange</H3>
  1444. <PRE>
  1445. public void <B>setAutoNickChange</B>(boolean&nbsp;autoNickChange)</PRE>
  1446. <DL>
  1447. <DD>When you connect to a server and your nick is already in use and
  1448. this is set to true, a new nick will be automatically chosen.
  1449. This is done by adding numbers to the end of the nick until an
  1450. available nick is found.
  1451. <P>
  1452. <DD><DL>
  1453. </DL>
  1454. </DD>
  1455. <DD><DL>
  1456. <DT><B>Parameters:</B><DD><CODE>autoNickChange</CODE> - Set to true if you want automatic nick changes
  1457. during connection.</DL>
  1458. </DD>
  1459. </DL>
  1460. <HR>
  1461. <A NAME="startIdentServer()"><!-- --></A><H3>
  1462. startIdentServer</H3>
  1463. <PRE>
  1464. public final void <B>startIdentServer</B>()</PRE>
  1465. <DL>
  1466. <DD>Starts an ident server (Identification Protocol Server, RFC 1413).
  1467. <p>
  1468. Most IRC servers attempt to contact the ident server on connecting
  1469. hosts in order to determine the user's identity. A few IRC servers
  1470. will not allow you to connect unless this information is provided.
  1471. <p>
  1472. So when a PircBot is run on a machine that does not run an ident server,
  1473. it may be necessary to call this method to start one up.
  1474. <p>
  1475. Calling this method starts up an ident server which will respond with
  1476. the login provided by calling getLogin() and then shut down immediately.
  1477. It will also be shut down if it has not been contacted within 60 seconds
  1478. of creation.
  1479. <p>
  1480. If you require an ident response, then the correct procedure is to start
  1481. the ident server and then connect to the IRC server. The IRC server may
  1482. then contact the ident server to get the information it needs.
  1483. <p>
  1484. The ident server will fail to start if there is already an ident server
  1485. running on port 113, or if you are running as an unprivileged user who
  1486. is unable to create a server socket on that port number.
  1487. <p>
  1488. If it is essential for you to use an ident server when connecting to an
  1489. IRC server, then make sure that port 113 on your machine is visible to
  1490. the IRC server so that it may contact the ident server.
  1491. <P>
  1492. <DD><DL>
  1493. </DL>
  1494. </DD>
  1495. <DD><DL>
  1496. <DT><B>Since:</B></DT>
  1497. <DD>PircBot 0.9c</DD>
  1498. </DL>
  1499. </DD>
  1500. </DL>
  1501. <HR>
  1502. <A NAME="joinChannel(java.lang.String)"><!-- --></A><H3>
  1503. joinChannel</H3>
  1504. <PRE>
  1505. public final void <B>joinChannel</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel)</PRE>
  1506. <DL>
  1507. <DD>Joins a channel.
  1508. <P>
  1509. <DD><DL>
  1510. </DL>
  1511. </DD>
  1512. <DD><DL>
  1513. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The name of the channel to join (eg "#cs").</DL>
  1514. </DD>
  1515. </DL>
  1516. <HR>
  1517. <A NAME="joinChannel(java.lang.String, java.lang.String)"><!-- --></A><H3>
  1518. joinChannel</H3>
  1519. <PRE>
  1520. public final void <B>joinChannel</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1521. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;key)</PRE>
  1522. <DL>
  1523. <DD>Joins a channel with a key.
  1524. <P>
  1525. <DD><DL>
  1526. </DL>
  1527. </DD>
  1528. <DD><DL>
  1529. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The name of the channel to join (eg "#cs").<DD><CODE>key</CODE> - The key that will be used to join the channel.</DL>
  1530. </DD>
  1531. </DL>
  1532. <HR>
  1533. <A NAME="partChannel(java.lang.String)"><!-- --></A><H3>
  1534. partChannel</H3>
  1535. <PRE>
  1536. public final void <B>partChannel</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel)</PRE>
  1537. <DL>
  1538. <DD>Parts a channel.
  1539. <P>
  1540. <DD><DL>
  1541. </DL>
  1542. </DD>
  1543. <DD><DL>
  1544. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The name of the channel to leave.</DL>
  1545. </DD>
  1546. </DL>
  1547. <HR>
  1548. <A NAME="partChannel(java.lang.String, java.lang.String)"><!-- --></A><H3>
  1549. partChannel</H3>
  1550. <PRE>
  1551. public final void <B>partChannel</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1552. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;reason)</PRE>
  1553. <DL>
  1554. <DD>Parts a channel, giving a reason.
  1555. <P>
  1556. <DD><DL>
  1557. </DL>
  1558. </DD>
  1559. <DD><DL>
  1560. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The name of the channel to leave.<DD><CODE>reason</CODE> - The reason for parting the channel.</DL>
  1561. </DD>
  1562. </DL>
  1563. <HR>
  1564. <A NAME="quitServer()"><!-- --></A><H3>
  1565. quitServer</H3>
  1566. <PRE>
  1567. public final void <B>quitServer</B>()</PRE>
  1568. <DL>
  1569. <DD>Quits from the IRC server.
  1570. Providing we are actually connected to an IRC server, the
  1571. onDisconnect() method will be called as soon as the IRC server
  1572. disconnects us.
  1573. <P>
  1574. <DD><DL>
  1575. </DL>
  1576. </DD>
  1577. <DD><DL>
  1578. </DL>
  1579. </DD>
  1580. </DL>
  1581. <HR>
  1582. <A NAME="quitServer(java.lang.String)"><!-- --></A><H3>
  1583. quitServer</H3>
  1584. <PRE>
  1585. public final void <B>quitServer</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;reason)</PRE>
  1586. <DL>
  1587. <DD>Quits from the IRC server with a reason.
  1588. Providing we are actually connected to an IRC server, the
  1589. onDisconnect() method will be called as soon as the IRC server
  1590. disconnects us.
  1591. <P>
  1592. <DD><DL>
  1593. </DL>
  1594. </DD>
  1595. <DD><DL>
  1596. <DT><B>Parameters:</B><DD><CODE>reason</CODE> - The reason for quitting the server.</DL>
  1597. </DD>
  1598. </DL>
  1599. <HR>
  1600. <A NAME="sendRawLine(java.lang.String)"><!-- --></A><H3>
  1601. sendRawLine</H3>
  1602. <PRE>
  1603. public final void <B>sendRawLine</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;line)</PRE>
  1604. <DL>
  1605. <DD>Sends a raw line to the IRC server as soon as possible, bypassing the
  1606. outgoing message queue.
  1607. <P>
  1608. <DD><DL>
  1609. </DL>
  1610. </DD>
  1611. <DD><DL>
  1612. <DT><B>Parameters:</B><DD><CODE>line</CODE> - The raw line to send to the IRC server.</DL>
  1613. </DD>
  1614. </DL>
  1615. <HR>
  1616. <A NAME="sendRawLineViaQueue(java.lang.String)"><!-- --></A><H3>
  1617. sendRawLineViaQueue</H3>
  1618. <PRE>
  1619. public final void <B>sendRawLineViaQueue</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;line)</PRE>
  1620. <DL>
  1621. <DD>Sends a raw line through the outgoing message queue.
  1622. <P>
  1623. <DD><DL>
  1624. </DL>
  1625. </DD>
  1626. <DD><DL>
  1627. <DT><B>Parameters:</B><DD><CODE>line</CODE> - The raw line to send to the IRC server.</DL>
  1628. </DD>
  1629. </DL>
  1630. <HR>
  1631. <A NAME="sendMessage(java.lang.String, java.lang.String)"><!-- --></A><H3>
  1632. sendMessage</H3>
  1633. <PRE>
  1634. public final void <B>sendMessage</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target,
  1635. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;message)</PRE>
  1636. <DL>
  1637. <DD>Sends a message to a channel or a private message to a user. These
  1638. messages are added to the outgoing message queue and sent at the
  1639. earliest possible opportunity.
  1640. <p>
  1641. Some examples: -
  1642. <pre> // Send the message "Hello!" to the channel #cs.
  1643. sendMessage("#cs", "Hello!");
  1644. // Send a private message to Paul that says "Hi".
  1645. sendMessage("Paul", "Hi");</pre>
  1646. You may optionally apply colours, boldness, underlining, etc to
  1647. the message by using the <code>Colors</code> class.
  1648. <P>
  1649. <DD><DL>
  1650. </DL>
  1651. </DD>
  1652. <DD><DL>
  1653. <DT><B>Parameters:</B><DD><CODE>target</CODE> - The name of the channel or user nick to send to.<DD><CODE>message</CODE> - The message to send.<DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/Colors.html" title="class in org.jibble.pircbot"><CODE>Colors</CODE></A></DL>
  1654. </DD>
  1655. </DL>
  1656. <HR>
  1657. <A NAME="sendAction(java.lang.String, java.lang.String)"><!-- --></A><H3>
  1658. sendAction</H3>
  1659. <PRE>
  1660. public final void <B>sendAction</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target,
  1661. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;action)</PRE>
  1662. <DL>
  1663. <DD>Sends an action to the channel or to a user.
  1664. <P>
  1665. <DD><DL>
  1666. </DL>
  1667. </DD>
  1668. <DD><DL>
  1669. <DT><B>Parameters:</B><DD><CODE>target</CODE> - The name of the channel or user nick to send to.<DD><CODE>action</CODE> - The action to send.<DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/Colors.html" title="class in org.jibble.pircbot"><CODE>Colors</CODE></A></DL>
  1670. </DD>
  1671. </DL>
  1672. <HR>
  1673. <A NAME="sendNotice(java.lang.String, java.lang.String)"><!-- --></A><H3>
  1674. sendNotice</H3>
  1675. <PRE>
  1676. public final void <B>sendNotice</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target,
  1677. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;notice)</PRE>
  1678. <DL>
  1679. <DD>Sends a notice to the channel or to a user.
  1680. <P>
  1681. <DD><DL>
  1682. </DL>
  1683. </DD>
  1684. <DD><DL>
  1685. <DT><B>Parameters:</B><DD><CODE>target</CODE> - The name of the channel or user nick to send to.<DD><CODE>notice</CODE> - The notice to send.</DL>
  1686. </DD>
  1687. </DL>
  1688. <HR>
  1689. <A NAME="sendCTCPCommand(java.lang.String, java.lang.String)"><!-- --></A><H3>
  1690. sendCTCPCommand</H3>
  1691. <PRE>
  1692. public final void <B>sendCTCPCommand</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target,
  1693. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;command)</PRE>
  1694. <DL>
  1695. <DD>Sends a CTCP command to a channel or user. (Client to client protocol).
  1696. Examples of such commands are "PING <number>", "FINGER", "VERSION", etc.
  1697. For example, if you wish to request the version of a user called "Dave",
  1698. then you would call <code>sendCTCPCommand("Dave", "VERSION");</code>.
  1699. The type of response to such commands is largely dependant on the target
  1700. client software.
  1701. <P>
  1702. <DD><DL>
  1703. </DL>
  1704. </DD>
  1705. <DD><DL>
  1706. <DT><B>Parameters:</B><DD><CODE>target</CODE> - The name of the channel or user to send the CTCP message to.<DD><CODE>command</CODE> - The CTCP command to send.<DT><B>Since:</B></DT>
  1707. <DD>PircBot 0.9.5</DD>
  1708. </DL>
  1709. </DD>
  1710. </DL>
  1711. <HR>
  1712. <A NAME="changeNick(java.lang.String)"><!-- --></A><H3>
  1713. changeNick</H3>
  1714. <PRE>
  1715. public final void <B>changeNick</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;newNick)</PRE>
  1716. <DL>
  1717. <DD>Attempt to change the current nick (nickname) of the bot when it
  1718. is connected to an IRC server.
  1719. After confirmation of a successful nick change, the getNick method
  1720. will return the new nick.
  1721. <P>
  1722. <DD><DL>
  1723. </DL>
  1724. </DD>
  1725. <DD><DL>
  1726. <DT><B>Parameters:</B><DD><CODE>newNick</CODE> - The new nick to use.</DL>
  1727. </DD>
  1728. </DL>
  1729. <HR>
  1730. <A NAME="identify(java.lang.String)"><!-- --></A><H3>
  1731. identify</H3>
  1732. <PRE>
  1733. public final void <B>identify</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;password)</PRE>
  1734. <DL>
  1735. <DD>Identify the bot with NickServ, supplying the appropriate password.
  1736. Some IRC Networks (such as freenode) require users to <i>register</i> and
  1737. <i>identify</i> with NickServ before they are able to send private messages
  1738. to other users, thus reducing the amount of spam. If you are using
  1739. an IRC network where this kind of policy is enforced, you will need
  1740. to make your bot <i>identify</i> itself to NickServ before you can send
  1741. private messages. Assuming you have already registered your bot's
  1742. nick with NickServ, this method can be used to <i>identify</i> with
  1743. the supplied password. It usually makes sense to identify with NickServ
  1744. immediately after connecting to a server.
  1745. <p>
  1746. This method issues a raw NICKSERV command to the server, and is therefore
  1747. safer than the alternative approach of sending a private message to
  1748. NickServ. The latter approach is considered dangerous, as it may cause
  1749. you to inadvertently transmit your password to an untrusted party if you
  1750. connect to a network which does not run a NickServ service and where the
  1751. untrusted party has assumed the nick "NickServ". However, if your IRC
  1752. network is only compatible with the private message approach, you may
  1753. typically identify like so:
  1754. <pre>sendMessage("NickServ", "identify PASSWORD");</pre>
  1755. <P>
  1756. <DD><DL>
  1757. </DL>
  1758. </DD>
  1759. <DD><DL>
  1760. <DT><B>Parameters:</B><DD><CODE>password</CODE> - The password which will be used to identify with NickServ.</DL>
  1761. </DD>
  1762. </DL>
  1763. <HR>
  1764. <A NAME="setMode(java.lang.String, java.lang.String)"><!-- --></A><H3>
  1765. setMode</H3>
  1766. <PRE>
  1767. public final void <B>setMode</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1768. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;mode)</PRE>
  1769. <DL>
  1770. <DD>Set the mode of a channel.
  1771. This method attempts to set the mode of a channel. This
  1772. may require the bot to have operator status on the channel.
  1773. For example, if the bot has operator status, we can grant
  1774. operator status to "Dave" on the #cs channel
  1775. by calling setMode("#cs", "+o Dave");
  1776. An alternative way of doing this would be to use the op method.
  1777. <P>
  1778. <DD><DL>
  1779. </DL>
  1780. </DD>
  1781. <DD><DL>
  1782. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel on which to perform the mode change.<DD><CODE>mode</CODE> - The new mode to apply to the channel. This may include
  1783. zero or more arguments if necessary.<DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/PircBot.html#op(java.lang.String, java.lang.String)"><CODE>op</CODE></A></DL>
  1784. </DD>
  1785. </DL>
  1786. <HR>
  1787. <A NAME="sendInvite(java.lang.String, java.lang.String)"><!-- --></A><H3>
  1788. sendInvite</H3>
  1789. <PRE>
  1790. public final void <B>sendInvite</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nick,
  1791. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel)</PRE>
  1792. <DL>
  1793. <DD>Sends an invitation to join a channel. Some channels can be marked
  1794. as "invite-only", so it may be useful to allow a bot to invite people
  1795. into it.
  1796. <P>
  1797. <DD><DL>
  1798. </DL>
  1799. </DD>
  1800. <DD><DL>
  1801. <DT><B>Parameters:</B><DD><CODE>nick</CODE> - The nick of the user to invite<DD><CODE>channel</CODE> - The channel you are inviting the user to join.</DL>
  1802. </DD>
  1803. </DL>
  1804. <HR>
  1805. <A NAME="ban(java.lang.String, java.lang.String)"><!-- --></A><H3>
  1806. ban</H3>
  1807. <PRE>
  1808. public final void <B>ban</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1809. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostmask)</PRE>
  1810. <DL>
  1811. <DD>Bans a user from a channel. An example of a valid hostmask is
  1812. "*!*compu@*.18hp.net". This may be used in conjunction with the
  1813. kick method to permanently remove a user from a channel.
  1814. Successful use of this method may require the bot to have operator
  1815. status itself.
  1816. <P>
  1817. <DD><DL>
  1818. </DL>
  1819. </DD>
  1820. <DD><DL>
  1821. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel to ban the user from.<DD><CODE>hostmask</CODE> - A hostmask representing the user we're banning.</DL>
  1822. </DD>
  1823. </DL>
  1824. <HR>
  1825. <A NAME="unBan(java.lang.String, java.lang.String)"><!-- --></A><H3>
  1826. unBan</H3>
  1827. <PRE>
  1828. public final void <B>unBan</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1829. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostmask)</PRE>
  1830. <DL>
  1831. <DD>Unbans a user from a channel. An example of a valid hostmask is
  1832. "*!*compu@*.18hp.net".
  1833. Successful use of this method may require the bot to have operator
  1834. status itself.
  1835. <P>
  1836. <DD><DL>
  1837. </DL>
  1838. </DD>
  1839. <DD><DL>
  1840. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel to unban the user from.<DD><CODE>hostmask</CODE> - A hostmask representing the user we're unbanning.</DL>
  1841. </DD>
  1842. </DL>
  1843. <HR>
  1844. <A NAME="op(java.lang.String, java.lang.String)"><!-- --></A><H3>
  1845. op</H3>
  1846. <PRE>
  1847. public final void <B>op</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1848. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nick)</PRE>
  1849. <DL>
  1850. <DD>Grants operator privilidges to a user on a channel.
  1851. Successful use of this method may require the bot to have operator
  1852. status itself.
  1853. <P>
  1854. <DD><DL>
  1855. </DL>
  1856. </DD>
  1857. <DD><DL>
  1858. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel we're opping the user on.<DD><CODE>nick</CODE> - The nick of the user we are opping.</DL>
  1859. </DD>
  1860. </DL>
  1861. <HR>
  1862. <A NAME="deOp(java.lang.String, java.lang.String)"><!-- --></A><H3>
  1863. deOp</H3>
  1864. <PRE>
  1865. public final void <B>deOp</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1866. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nick)</PRE>
  1867. <DL>
  1868. <DD>Removes operator privilidges from a user on a channel.
  1869. Successful use of this method may require the bot to have operator
  1870. status itself.
  1871. <P>
  1872. <DD><DL>
  1873. </DL>
  1874. </DD>
  1875. <DD><DL>
  1876. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel we're deopping the user on.<DD><CODE>nick</CODE> - The nick of the user we are deopping.</DL>
  1877. </DD>
  1878. </DL>
  1879. <HR>
  1880. <A NAME="voice(java.lang.String, java.lang.String)"><!-- --></A><H3>
  1881. voice</H3>
  1882. <PRE>
  1883. public final void <B>voice</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1884. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nick)</PRE>
  1885. <DL>
  1886. <DD>Grants voice privilidges to a user on a channel.
  1887. Successful use of this method may require the bot to have operator
  1888. status itself.
  1889. <P>
  1890. <DD><DL>
  1891. </DL>
  1892. </DD>
  1893. <DD><DL>
  1894. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel we're voicing the user on.<DD><CODE>nick</CODE> - The nick of the user we are voicing.</DL>
  1895. </DD>
  1896. </DL>
  1897. <HR>
  1898. <A NAME="deVoice(java.lang.String, java.lang.String)"><!-- --></A><H3>
  1899. deVoice</H3>
  1900. <PRE>
  1901. public final void <B>deVoice</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1902. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nick)</PRE>
  1903. <DL>
  1904. <DD>Removes voice privilidges from a user on a channel.
  1905. Successful use of this method may require the bot to have operator
  1906. status itself.
  1907. <P>
  1908. <DD><DL>
  1909. </DL>
  1910. </DD>
  1911. <DD><DL>
  1912. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel we're devoicing the user on.<DD><CODE>nick</CODE> - The nick of the user we are devoicing.</DL>
  1913. </DD>
  1914. </DL>
  1915. <HR>
  1916. <A NAME="setTopic(java.lang.String, java.lang.String)"><!-- --></A><H3>
  1917. setTopic</H3>
  1918. <PRE>
  1919. public final void <B>setTopic</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1920. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;topic)</PRE>
  1921. <DL>
  1922. <DD>Set the topic for a channel.
  1923. This method attempts to set the topic of a channel. This
  1924. may require the bot to have operator status if the topic
  1925. is protected.
  1926. <P>
  1927. <DD><DL>
  1928. </DL>
  1929. </DD>
  1930. <DD><DL>
  1931. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel on which to perform the mode change.<DD><CODE>topic</CODE> - The new topic for the channel.</DL>
  1932. </DD>
  1933. </DL>
  1934. <HR>
  1935. <A NAME="kick(java.lang.String, java.lang.String)"><!-- --></A><H3>
  1936. kick</H3>
  1937. <PRE>
  1938. public final void <B>kick</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1939. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nick)</PRE>
  1940. <DL>
  1941. <DD>Kicks a user from a channel.
  1942. This method attempts to kick a user from a channel and
  1943. may require the bot to have operator status in the channel.
  1944. <P>
  1945. <DD><DL>
  1946. </DL>
  1947. </DD>
  1948. <DD><DL>
  1949. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel to kick the user from.<DD><CODE>nick</CODE> - The nick of the user to kick.</DL>
  1950. </DD>
  1951. </DL>
  1952. <HR>
  1953. <A NAME="kick(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  1954. kick</H3>
  1955. <PRE>
  1956. public final void <B>kick</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  1957. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nick,
  1958. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;reason)</PRE>
  1959. <DL>
  1960. <DD>Kicks a user from a channel, giving a reason.
  1961. This method attempts to kick a user from a channel and
  1962. may require the bot to have operator status in the channel.
  1963. <P>
  1964. <DD><DL>
  1965. </DL>
  1966. </DD>
  1967. <DD><DL>
  1968. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel to kick the user from.<DD><CODE>nick</CODE> - The nick of the user to kick.<DD><CODE>reason</CODE> - A description of the reason for kicking a user.</DL>
  1969. </DD>
  1970. </DL>
  1971. <HR>
  1972. <A NAME="listChannels()"><!-- --></A><H3>
  1973. listChannels</H3>
  1974. <PRE>
  1975. public final void <B>listChannels</B>()</PRE>
  1976. <DL>
  1977. <DD>Issues a request for a list of all channels on the IRC server.
  1978. When the PircBot receives information for each channel, it will
  1979. call the onChannelInfo method, which you will need to override
  1980. if you want it to do anything useful.
  1981. <P>
  1982. <DD><DL>
  1983. </DL>
  1984. </DD>
  1985. <DD><DL>
  1986. <DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/PircBot.html#onChannelInfo(java.lang.String, int, java.lang.String)"><CODE>onChannelInfo</CODE></A></DL>
  1987. </DD>
  1988. </DL>
  1989. <HR>
  1990. <A NAME="listChannels(java.lang.String)"><!-- --></A><H3>
  1991. listChannels</H3>
  1992. <PRE>
  1993. public final void <B>listChannels</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;parameters)</PRE>
  1994. <DL>
  1995. <DD>Issues a request for a list of all channels on the IRC server.
  1996. When the PircBot receives information for each channel, it will
  1997. call the onChannelInfo method, which you will need to override
  1998. if you want it to do anything useful.
  1999. <p>
  2000. Some IRC servers support certain parameters for LIST requests.
  2001. One example is a parameter of ">10" to list only those channels
  2002. that have more than 10 users in them. Whether these parameters
  2003. are supported or not will depend on the IRC server software.
  2004. <P>
  2005. <DD><DL>
  2006. </DL>
  2007. </DD>
  2008. <DD><DL>
  2009. <DT><B>Parameters:</B><DD><CODE>parameters</CODE> - The parameters to supply when requesting the
  2010. list.<DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/PircBot.html#onChannelInfo(java.lang.String, int, java.lang.String)"><CODE>onChannelInfo</CODE></A></DL>
  2011. </DD>
  2012. </DL>
  2013. <HR>
  2014. <A NAME="dccSendFile(java.io.File, java.lang.String, int)"><!-- --></A><H3>
  2015. dccSendFile</H3>
  2016. <PRE>
  2017. public final <A HREF="../../../org/jibble/pircbot/DccFileTransfer.html" title="class in org.jibble.pircbot">DccFileTransfer</A> <B>dccSendFile</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html" title="class or interface in java.io">File</A>&nbsp;file,
  2018. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nick,
  2019. int&nbsp;timeout)</PRE>
  2020. <DL>
  2021. <DD>Sends a file to another user. Resuming is supported.
  2022. The other user must be able to connect directly to your bot to be
  2023. able to receive the file.
  2024. <p>
  2025. You may throttle the speed of this file transfer by calling the
  2026. setPacketDelay method on the DccFileTransfer that is returned.
  2027. <p>
  2028. This method may not be overridden.
  2029. <P>
  2030. <DD><DL>
  2031. </DL>
  2032. </DD>
  2033. <DD><DL>
  2034. <DT><B>Parameters:</B><DD><CODE>file</CODE> - The file to send.<DD><CODE>nick</CODE> - The user to whom the file is to be sent.<DD><CODE>timeout</CODE> - The number of milliseconds to wait for the recipient to
  2035. acccept the file (we recommend about 120000).
  2036. <DT><B>Returns:</B><DD>The DccFileTransfer that can be used to monitor this transfer.<DT><B>Since:</B></DT>
  2037. <DD>0.9c</DD>
  2038. <DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/DccFileTransfer.html" title="class in org.jibble.pircbot"><CODE>DccFileTransfer</CODE></A></DL>
  2039. </DD>
  2040. </DL>
  2041. <HR>
  2042. <A NAME="dccReceiveFile(java.io.File, long, int, int)"><!-- --></A><H3>
  2043. dccReceiveFile</H3>
  2044. <PRE>
  2045. protected final void <B>dccReceiveFile</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html" title="class or interface in java.io">File</A>&nbsp;file,
  2046. long&nbsp;address,
  2047. int&nbsp;port,
  2048. int&nbsp;size)</PRE>
  2049. <DL>
  2050. <DD><B>Deprecated.</B>&nbsp;<I>As of PircBot 1.2.0, use <A HREF="../../../org/jibble/pircbot/PircBot.html#onIncomingFileTransfer(org.jibble.pircbot.DccFileTransfer)"><CODE>onIncomingFileTransfer(DccFileTransfer)</CODE></A></I>
  2051. <P>
  2052. <DD>Receives a file that is being sent to us by a DCC SEND request.
  2053. Please use the onIncomingFileTransfer method to receive files.
  2054. <P>
  2055. <DD><DL>
  2056. </DL>
  2057. </DD>
  2058. <DD><DL>
  2059. </DL>
  2060. </DD>
  2061. </DL>
  2062. <HR>
  2063. <A NAME="dccSendChatRequest(java.lang.String, int)"><!-- --></A><H3>
  2064. dccSendChatRequest</H3>
  2065. <PRE>
  2066. public final <A HREF="../../../org/jibble/pircbot/DccChat.html" title="class in org.jibble.pircbot">DccChat</A> <B>dccSendChatRequest</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nick,
  2067. int&nbsp;timeout)</PRE>
  2068. <DL>
  2069. <DD>Attempts to establish a DCC CHAT session with a client. This method
  2070. issues the connection request to the client and then waits for the
  2071. client to respond. If the connection is successfully made, then a
  2072. DccChat object is returned by this method. If the connection is not
  2073. made within the time limit specified by the timeout value, then null
  2074. is returned.
  2075. <p>
  2076. It is <b>strongly recommended</b> that you call this method within a new
  2077. Thread, as it may take a long time to return.
  2078. <p>
  2079. This method may not be overridden.
  2080. <P>
  2081. <DD><DL>
  2082. </DL>
  2083. </DD>
  2084. <DD><DL>
  2085. <DT><B>Parameters:</B><DD><CODE>nick</CODE> - The nick of the user we are trying to establish a chat with.<DD><CODE>timeout</CODE> - The number of milliseconds to wait for the recipient to
  2086. accept the chat connection (we recommend about 120000).
  2087. <DT><B>Returns:</B><DD>a DccChat object that can be used to send and recieve lines of
  2088. text. Returns <b>null</b> if the connection could not be made.<DT><B>Since:</B></DT>
  2089. <DD>PircBot 0.9.8</DD>
  2090. <DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/DccChat.html" title="class in org.jibble.pircbot"><CODE>DccChat</CODE></A></DL>
  2091. </DD>
  2092. </DL>
  2093. <HR>
  2094. <A NAME="dccAcceptChatRequest(java.lang.String, long, int)"><!-- --></A><H3>
  2095. dccAcceptChatRequest</H3>
  2096. <PRE>
  2097. protected final <A HREF="../../../org/jibble/pircbot/DccChat.html" title="class in org.jibble.pircbot">DccChat</A> <B>dccAcceptChatRequest</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2098. long&nbsp;address,
  2099. int&nbsp;port)</PRE>
  2100. <DL>
  2101. <DD><B>Deprecated.</B>&nbsp;<I>As of PircBot 1.2.0, use <A HREF="../../../org/jibble/pircbot/PircBot.html#onIncomingChatRequest(org.jibble.pircbot.DccChat)"><CODE>onIncomingChatRequest(DccChat)</CODE></A></I>
  2102. <P>
  2103. <DD>Attempts to accept a DCC CHAT request by a client.
  2104. Please use the onIncomingChatRequest method to receive files.
  2105. <P>
  2106. <DD><DL>
  2107. </DL>
  2108. </DD>
  2109. <DD><DL>
  2110. </DL>
  2111. </DD>
  2112. </DL>
  2113. <HR>
  2114. <A NAME="log(java.lang.String)"><!-- --></A><H3>
  2115. log</H3>
  2116. <PRE>
  2117. public void <B>log</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;line)</PRE>
  2118. <DL>
  2119. <DD>Adds a line to the log. This log is currently output to the standard
  2120. output and is in the correct format for use by tools such as pisg, the
  2121. Perl IRC Statistics Generator. You may override this method if you wish
  2122. to do something else with log entries.
  2123. Each line in the log begins with a number which
  2124. represents the logging time (as the number of milliseconds since the
  2125. epoch). This timestamp and the following log entry are separated by
  2126. a single space character, " ". Outgoing messages are distinguishable
  2127. by a log entry that has ">>>" immediately following the space character
  2128. after the timestamp. DCC events use "+++" and warnings about unhandled
  2129. Exceptions and Errors use "###".
  2130. <p>
  2131. This implementation of the method will only cause log entries to be
  2132. output if the PircBot has had its verbose mode turned on by calling
  2133. setVerbose(true);
  2134. <P>
  2135. <DD><DL>
  2136. </DL>
  2137. </DD>
  2138. <DD><DL>
  2139. <DT><B>Parameters:</B><DD><CODE>line</CODE> - The line to add to the log.</DL>
  2140. </DD>
  2141. </DL>
  2142. <HR>
  2143. <A NAME="handleLine(java.lang.String)"><!-- --></A><H3>
  2144. handleLine</H3>
  2145. <PRE>
  2146. protected void <B>handleLine</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;line)</PRE>
  2147. <DL>
  2148. <DD>This method handles events when any line of text arrives from the server,
  2149. then calling the appropriate method in the PircBot. This method is
  2150. protected and only called by the InputThread for this instance.
  2151. <p>
  2152. This method may not be overridden!
  2153. <P>
  2154. <DD><DL>
  2155. </DL>
  2156. </DD>
  2157. <DD><DL>
  2158. <DT><B>Parameters:</B><DD><CODE>line</CODE> - The raw line of text from the server.</DL>
  2159. </DD>
  2160. </DL>
  2161. <HR>
  2162. <A NAME="onConnect()"><!-- --></A><H3>
  2163. onConnect</H3>
  2164. <PRE>
  2165. protected void <B>onConnect</B>()</PRE>
  2166. <DL>
  2167. <DD>This method is called once the PircBot has successfully connected to
  2168. the IRC server.
  2169. <p>
  2170. The implementation of this method in the PircBot abstract class
  2171. performs no actions and may be overridden as required.
  2172. <P>
  2173. <DD><DL>
  2174. </DL>
  2175. </DD>
  2176. <DD><DL>
  2177. <DT><B>Since:</B></DT>
  2178. <DD>PircBot 0.9.6</DD>
  2179. </DL>
  2180. </DD>
  2181. </DL>
  2182. <HR>
  2183. <A NAME="onDisconnect()"><!-- --></A><H3>
  2184. onDisconnect</H3>
  2185. <PRE>
  2186. protected void <B>onDisconnect</B>()</PRE>
  2187. <DL>
  2188. <DD>This method carries out the actions to be performed when the PircBot
  2189. gets disconnected. This may happen if the PircBot quits from the
  2190. server, or if the connection is unexpectedly lost.
  2191. <p>
  2192. Disconnection from the IRC server is detected immediately if either
  2193. we or the server close the connection normally. If the connection to
  2194. the server is lost, but neither we nor the server have explicitly closed
  2195. the connection, then it may take a few minutes to detect (this is
  2196. commonly referred to as a "ping timeout").
  2197. <p>
  2198. If you wish to get your IRC bot to automatically rejoin a server after
  2199. the connection has been lost, then this is probably the ideal method to
  2200. override to implement such functionality.
  2201. <p>
  2202. The implementation of this method in the PircBot abstract class
  2203. performs no actions and may be overridden as required.
  2204. <P>
  2205. <DD><DL>
  2206. </DL>
  2207. </DD>
  2208. <DD><DL>
  2209. </DL>
  2210. </DD>
  2211. </DL>
  2212. <HR>
  2213. <A NAME="onServerResponse(int, java.lang.String)"><!-- --></A><H3>
  2214. onServerResponse</H3>
  2215. <PRE>
  2216. protected void <B>onServerResponse</B>(int&nbsp;code,
  2217. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;response)</PRE>
  2218. <DL>
  2219. <DD>This method is called when we receive a numeric response from the
  2220. IRC server.
  2221. <p>
  2222. Numerics in the range from 001 to 099 are used for client-server
  2223. connections only and should never travel between servers. Replies
  2224. generated in response to commands are found in the range from 200
  2225. to 399. Error replies are found in the range from 400 to 599.
  2226. <p>
  2227. For example, we can use this method to discover the topic of a
  2228. channel when we join it. If we join the channel #test which
  2229. has a topic of &quot;I am King of Test&quot; then the response
  2230. will be &quot;<code>PircBot #test :I Am King of Test</code>&quot;
  2231. with a code of 332 to signify that this is a topic.
  2232. (This is just an example - note that overriding the
  2233. <code>onTopic</code> method is an easier way of finding the
  2234. topic for a channel). Check the IRC RFC for the full list of other
  2235. command response codes.
  2236. <p>
  2237. PircBot implements the interface ReplyConstants, which contains
  2238. contstants that you may find useful here.
  2239. <p>
  2240. The implementation of this method in the PircBot abstract class
  2241. performs no actions and may be overridden as required.
  2242. <P>
  2243. <DD><DL>
  2244. </DL>
  2245. </DD>
  2246. <DD><DL>
  2247. <DT><B>Parameters:</B><DD><CODE>code</CODE> - The three-digit numerical code for the response.<DD><CODE>response</CODE> - The full response from the IRC server.<DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/ReplyConstants.html" title="interface in org.jibble.pircbot"><CODE>ReplyConstants</CODE></A></DL>
  2248. </DD>
  2249. </DL>
  2250. <HR>
  2251. <A NAME="onUserList(java.lang.String, org.jibble.pircbot.User[])"><!-- --></A><H3>
  2252. onUserList</H3>
  2253. <PRE>
  2254. protected void <B>onUserList</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2255. <A HREF="../../../org/jibble/pircbot/User.html" title="class in org.jibble.pircbot">User</A>[]&nbsp;users)</PRE>
  2256. <DL>
  2257. <DD>This method is called when we receive a user list from the server
  2258. after joining a channel.
  2259. <p>
  2260. Shortly after joining a channel, the IRC server sends a list of all
  2261. users in that channel. The PircBot collects this information and
  2262. calls this method as soon as it has the full list.
  2263. <p>
  2264. To obtain the nick of each user in the channel, call the getNick()
  2265. method on each User object in the array.
  2266. <p>
  2267. At a later time, you may call the getUsers method to obtain an
  2268. up to date list of the users in the channel.
  2269. <p>
  2270. The implementation of this method in the PircBot abstract class
  2271. performs no actions and may be overridden as required.
  2272. <P>
  2273. <DD><DL>
  2274. </DL>
  2275. </DD>
  2276. <DD><DL>
  2277. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The name of the channel.<DD><CODE>users</CODE> - An array of User objects belonging to this channel.<DT><B>Since:</B></DT>
  2278. <DD>PircBot 1.0.0</DD>
  2279. <DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/User.html" title="class in org.jibble.pircbot"><CODE>User</CODE></A></DL>
  2280. </DD>
  2281. </DL>
  2282. <HR>
  2283. <A NAME="onMessage(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2284. onMessage</H3>
  2285. <PRE>
  2286. protected void <B>onMessage</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2287. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sender,
  2288. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;login,
  2289. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostname,
  2290. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;message)</PRE>
  2291. <DL>
  2292. <DD>This method is called whenever a message is sent to a channel.
  2293. <p>
  2294. The implementation of this method in the PircBot abstract class
  2295. performs no actions and may be overridden as required.
  2296. <P>
  2297. <DD><DL>
  2298. </DL>
  2299. </DD>
  2300. <DD><DL>
  2301. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel to which the message was sent.<DD><CODE>sender</CODE> - The nick of the person who sent the message.<DD><CODE>login</CODE> - The login of the person who sent the message.<DD><CODE>hostname</CODE> - The hostname of the person who sent the message.<DD><CODE>message</CODE> - The actual message sent to the channel.</DL>
  2302. </DD>
  2303. </DL>
  2304. <HR>
  2305. <A NAME="onPrivateMessage(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2306. onPrivateMessage</H3>
  2307. <PRE>
  2308. protected void <B>onPrivateMessage</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sender,
  2309. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;login,
  2310. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostname,
  2311. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;message)</PRE>
  2312. <DL>
  2313. <DD>This method is called whenever a private message is sent to the PircBot.
  2314. <p>
  2315. The implementation of this method in the PircBot abstract class
  2316. performs no actions and may be overridden as required.
  2317. <P>
  2318. <DD><DL>
  2319. </DL>
  2320. </DD>
  2321. <DD><DL>
  2322. <DT><B>Parameters:</B><DD><CODE>sender</CODE> - The nick of the person who sent the private message.<DD><CODE>login</CODE> - The login of the person who sent the private message.<DD><CODE>hostname</CODE> - The hostname of the person who sent the private message.<DD><CODE>message</CODE> - The actual message.</DL>
  2323. </DD>
  2324. </DL>
  2325. <HR>
  2326. <A NAME="onAction(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2327. onAction</H3>
  2328. <PRE>
  2329. protected void <B>onAction</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sender,
  2330. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;login,
  2331. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostname,
  2332. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target,
  2333. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;action)</PRE>
  2334. <DL>
  2335. <DD>This method is called whenever an ACTION is sent from a user. E.g.
  2336. such events generated by typing "/me goes shopping" in most IRC clients.
  2337. <p>
  2338. The implementation of this method in the PircBot abstract class
  2339. performs no actions and may be overridden as required.
  2340. <P>
  2341. <DD><DL>
  2342. </DL>
  2343. </DD>
  2344. <DD><DL>
  2345. <DT><B>Parameters:</B><DD><CODE>sender</CODE> - The nick of the user that sent the action.<DD><CODE>login</CODE> - The login of the user that sent the action.<DD><CODE>hostname</CODE> - The hostname of the user that sent the action.<DD><CODE>target</CODE> - The target of the action, be it a channel or our nick.<DD><CODE>action</CODE> - The action carried out by the user.</DL>
  2346. </DD>
  2347. </DL>
  2348. <HR>
  2349. <A NAME="onNotice(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2350. onNotice</H3>
  2351. <PRE>
  2352. protected void <B>onNotice</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2353. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  2354. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  2355. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target,
  2356. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;notice)</PRE>
  2357. <DL>
  2358. <DD>This method is called whenever we receive a notice.
  2359. <p>
  2360. The implementation of this method in the PircBot abstract class
  2361. performs no actions and may be overridden as required.
  2362. <P>
  2363. <DD><DL>
  2364. </DL>
  2365. </DD>
  2366. <DD><DL>
  2367. <DT><B>Parameters:</B><DD><CODE>sourceNick</CODE> - The nick of the user that sent the notice.<DD><CODE>sourceLogin</CODE> - The login of the user that sent the notice.<DD><CODE>sourceHostname</CODE> - The hostname of the user that sent the notice.<DD><CODE>target</CODE> - The target of the notice, be it our nick or a channel name.<DD><CODE>notice</CODE> - The notice message.</DL>
  2368. </DD>
  2369. </DL>
  2370. <HR>
  2371. <A NAME="onJoin(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2372. onJoin</H3>
  2373. <PRE>
  2374. protected void <B>onJoin</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2375. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sender,
  2376. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;login,
  2377. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostname)</PRE>
  2378. <DL>
  2379. <DD>This method is called whenever someone (possibly us) joins a channel
  2380. which we are on.
  2381. <p>
  2382. The implementation of this method in the PircBot abstract class
  2383. performs no actions and may be overridden as required.
  2384. <P>
  2385. <DD><DL>
  2386. </DL>
  2387. </DD>
  2388. <DD><DL>
  2389. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel which somebody joined.<DD><CODE>sender</CODE> - The nick of the user who joined the channel.<DD><CODE>login</CODE> - The login of the user who joined the channel.<DD><CODE>hostname</CODE> - The hostname of the user who joined the channel.</DL>
  2390. </DD>
  2391. </DL>
  2392. <HR>
  2393. <A NAME="onPart(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2394. onPart</H3>
  2395. <PRE>
  2396. protected void <B>onPart</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2397. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sender,
  2398. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;login,
  2399. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostname)</PRE>
  2400. <DL>
  2401. <DD>This method is called whenever someone (possibly us) parts a channel
  2402. which we are on.
  2403. <p>
  2404. The implementation of this method in the PircBot abstract class
  2405. performs no actions and may be overridden as required.
  2406. <P>
  2407. <DD><DL>
  2408. </DL>
  2409. </DD>
  2410. <DD><DL>
  2411. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel which somebody parted from.<DD><CODE>sender</CODE> - The nick of the user who parted from the channel.<DD><CODE>login</CODE> - The login of the user who parted from the channel.<DD><CODE>hostname</CODE> - The hostname of the user who parted from the channel.</DL>
  2412. </DD>
  2413. </DL>
  2414. <HR>
  2415. <A NAME="onNickChange(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2416. onNickChange</H3>
  2417. <PRE>
  2418. protected void <B>onNickChange</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;oldNick,
  2419. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;login,
  2420. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostname,
  2421. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;newNick)</PRE>
  2422. <DL>
  2423. <DD>This method is called whenever someone (possibly us) changes nick on any
  2424. of the channels that we are on.
  2425. <p>
  2426. The implementation of this method in the PircBot abstract class
  2427. performs no actions and may be overridden as required.
  2428. <P>
  2429. <DD><DL>
  2430. </DL>
  2431. </DD>
  2432. <DD><DL>
  2433. <DT><B>Parameters:</B><DD><CODE>oldNick</CODE> - The old nick.<DD><CODE>login</CODE> - The login of the user.<DD><CODE>hostname</CODE> - The hostname of the user.<DD><CODE>newNick</CODE> - The new nick.</DL>
  2434. </DD>
  2435. </DL>
  2436. <HR>
  2437. <A NAME="onKick(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2438. onKick</H3>
  2439. <PRE>
  2440. protected void <B>onKick</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2441. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;kickerNick,
  2442. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;kickerLogin,
  2443. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;kickerHostname,
  2444. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;recipientNick,
  2445. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;reason)</PRE>
  2446. <DL>
  2447. <DD>This method is called whenever someone (possibly us) is kicked from
  2448. any of the channels that we are in.
  2449. <p>
  2450. The implementation of this method in the PircBot abstract class
  2451. performs no actions and may be overridden as required.
  2452. <P>
  2453. <DD><DL>
  2454. </DL>
  2455. </DD>
  2456. <DD><DL>
  2457. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel from which the recipient was kicked.<DD><CODE>kickerNick</CODE> - The nick of the user who performed the kick.<DD><CODE>kickerLogin</CODE> - The login of the user who performed the kick.<DD><CODE>kickerHostname</CODE> - The hostname of the user who performed the kick.<DD><CODE>recipientNick</CODE> - The unfortunate recipient of the kick.<DD><CODE>reason</CODE> - The reason given by the user who performed the kick.</DL>
  2458. </DD>
  2459. </DL>
  2460. <HR>
  2461. <A NAME="onQuit(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2462. onQuit</H3>
  2463. <PRE>
  2464. protected void <B>onQuit</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2465. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  2466. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  2467. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;reason)</PRE>
  2468. <DL>
  2469. <DD>This method is called whenever someone (possibly us) quits from the
  2470. server. We will only observe this if the user was in one of the
  2471. channels to which we are connected.
  2472. <p>
  2473. The implementation of this method in the PircBot abstract class
  2474. performs no actions and may be overridden as required.
  2475. <P>
  2476. <DD><DL>
  2477. </DL>
  2478. </DD>
  2479. <DD><DL>
  2480. <DT><B>Parameters:</B><DD><CODE>sourceNick</CODE> - The nick of the user that quit from the server.<DD><CODE>sourceLogin</CODE> - The login of the user that quit from the server.<DD><CODE>sourceHostname</CODE> - The hostname of the user that quit from the server.<DD><CODE>reason</CODE> - The reason given for quitting the server.</DL>
  2481. </DD>
  2482. </DL>
  2483. <HR>
  2484. <A NAME="onTopic(java.lang.String, java.lang.String)"><!-- --></A><H3>
  2485. onTopic</H3>
  2486. <PRE>
  2487. protected void <B>onTopic</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2488. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;topic)</PRE>
  2489. <DL>
  2490. <DD><B>Deprecated.</B>&nbsp;<I>As of 1.2.0, replaced by <A HREF="../../../org/jibble/pircbot/PircBot.html#onTopic(java.lang.String, java.lang.String, java.lang.String, long, boolean)"><CODE>onTopic(String,String,String,long,boolean)</CODE></A></I>
  2491. <P>
  2492. <DD>This method is called whenever a user sets the topic, or when
  2493. PircBot joins a new channel and discovers its topic.
  2494. <p>
  2495. The implementation of this method in the PircBot abstract class
  2496. performs no actions and may be overridden as required.
  2497. <P>
  2498. <DD><DL>
  2499. </DL>
  2500. </DD>
  2501. <DD><DL>
  2502. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel that the topic belongs to.<DD><CODE>topic</CODE> - The topic for the channel.</DL>
  2503. </DD>
  2504. </DL>
  2505. <HR>
  2506. <A NAME="onTopic(java.lang.String, java.lang.String, java.lang.String, long, boolean)"><!-- --></A><H3>
  2507. onTopic</H3>
  2508. <PRE>
  2509. protected void <B>onTopic</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2510. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;topic,
  2511. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;setBy,
  2512. long&nbsp;date,
  2513. boolean&nbsp;changed)</PRE>
  2514. <DL>
  2515. <DD>This method is called whenever a user sets the topic, or when
  2516. PircBot joins a new channel and discovers its topic.
  2517. <p>
  2518. The implementation of this method in the PircBot abstract class
  2519. performs no actions and may be overridden as required.
  2520. <P>
  2521. <DD><DL>
  2522. </DL>
  2523. </DD>
  2524. <DD><DL>
  2525. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel that the topic belongs to.<DD><CODE>topic</CODE> - The topic for the channel.<DD><CODE>setBy</CODE> - The nick of the user that set the topic.<DD><CODE>date</CODE> - When the topic was set (milliseconds since the epoch).<DD><CODE>changed</CODE> - True if the topic has just been changed, false if
  2526. the topic was already there.</DL>
  2527. </DD>
  2528. </DL>
  2529. <HR>
  2530. <A NAME="onChannelInfo(java.lang.String, int, java.lang.String)"><!-- --></A><H3>
  2531. onChannelInfo</H3>
  2532. <PRE>
  2533. protected void <B>onChannelInfo</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2534. int&nbsp;userCount,
  2535. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;topic)</PRE>
  2536. <DL>
  2537. <DD>After calling the listChannels() method in PircBot, the server
  2538. will start to send us information about each channel on the
  2539. server. You may override this method in order to receive the
  2540. information about each channel as soon as it is received.
  2541. <p>
  2542. Note that certain channels, such as those marked as hidden,
  2543. may not appear in channel listings.
  2544. <p>
  2545. The implementation of this method in the PircBot abstract class
  2546. performs no actions and may be overridden as required.
  2547. <P>
  2548. <DD><DL>
  2549. </DL>
  2550. </DD>
  2551. <DD><DL>
  2552. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The name of the channel.<DD><CODE>userCount</CODE> - The number of users visible in this channel.<DD><CODE>topic</CODE> - The topic for this channel.<DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/PircBot.html#listChannels()"><CODE>listChannels</CODE></A></DL>
  2553. </DD>
  2554. </DL>
  2555. <HR>
  2556. <A NAME="onMode(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2557. onMode</H3>
  2558. <PRE>
  2559. protected void <B>onMode</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2560. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2561. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  2562. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  2563. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;mode)</PRE>
  2564. <DL>
  2565. <DD>Called when the mode of a channel is set.
  2566. <p>
  2567. You may find it more convenient to decode the meaning of the mode
  2568. string by overriding the onOp, onDeOp, onVoice, onDeVoice,
  2569. onChannelKey, onDeChannelKey, onChannelLimit, onDeChannelLimit,
  2570. onChannelBan or onDeChannelBan methods as appropriate.
  2571. <p>
  2572. The implementation of this method in the PircBot abstract class
  2573. performs no actions and may be overridden as required.
  2574. <P>
  2575. <DD><DL>
  2576. </DL>
  2577. </DD>
  2578. <DD><DL>
  2579. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel that the mode operation applies to.<DD><CODE>sourceNick</CODE> - The nick of the user that set the mode.<DD><CODE>sourceLogin</CODE> - The login of the user that set the mode.<DD><CODE>sourceHostname</CODE> - The hostname of the user that set the mode.<DD><CODE>mode</CODE> - The mode that has been set.</DL>
  2580. </DD>
  2581. </DL>
  2582. <HR>
  2583. <A NAME="onUserMode(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2584. onUserMode</H3>
  2585. <PRE>
  2586. protected void <B>onUserMode</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;targetNick,
  2587. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2588. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  2589. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  2590. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;mode)</PRE>
  2591. <DL>
  2592. <DD>Called when the mode of a user is set.
  2593. <p>
  2594. The implementation of this method in the PircBot abstract class
  2595. performs no actions and may be overridden as required.
  2596. <P>
  2597. <DD><DL>
  2598. </DL>
  2599. </DD>
  2600. <DD><DL>
  2601. <DT><B>Parameters:</B><DD><CODE>targetNick</CODE> - The nick that the mode operation applies to.<DD><CODE>sourceNick</CODE> - The nick of the user that set the mode.<DD><CODE>sourceLogin</CODE> - The login of the user that set the mode.<DD><CODE>sourceHostname</CODE> - The hostname of the user that set the mode.<DD><CODE>mode</CODE> - The mode that has been set.<DT><B>Since:</B></DT>
  2602. <DD>PircBot 1.2.0</DD>
  2603. </DL>
  2604. </DD>
  2605. </DL>
  2606. <HR>
  2607. <A NAME="onOp(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2608. onOp</H3>
  2609. <PRE>
  2610. protected void <B>onOp</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2611. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2612. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  2613. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  2614. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;recipient)</PRE>
  2615. <DL>
  2616. <DD>Called when a user (possibly us) gets granted operator status for a channel.
  2617. <p>
  2618. This is a type of mode change and is also passed to the onMode
  2619. method in the PircBot class.
  2620. <p>
  2621. The implementation of this method in the PircBot abstract class
  2622. performs no actions and may be overridden as required.
  2623. <P>
  2624. <DD><DL>
  2625. </DL>
  2626. </DD>
  2627. <DD><DL>
  2628. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DD><CODE>recipient</CODE> - The nick of the user that got 'opped'.<DT><B>Since:</B></DT>
  2629. <DD>PircBot 0.9.5</DD>
  2630. </DL>
  2631. </DD>
  2632. </DL>
  2633. <HR>
  2634. <A NAME="onDeop(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2635. onDeop</H3>
  2636. <PRE>
  2637. protected void <B>onDeop</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2638. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2639. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  2640. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  2641. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;recipient)</PRE>
  2642. <DL>
  2643. <DD>Called when a user (possibly us) gets operator status taken away.
  2644. <p>
  2645. This is a type of mode change and is also passed to the onMode
  2646. method in the PircBot class.
  2647. <p>
  2648. The implementation of this method in the PircBot abstract class
  2649. performs no actions and may be overridden as required.
  2650. <P>
  2651. <DD><DL>
  2652. </DL>
  2653. </DD>
  2654. <DD><DL>
  2655. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DD><CODE>recipient</CODE> - The nick of the user that got 'deopped'.<DT><B>Since:</B></DT>
  2656. <DD>PircBot 0.9.5</DD>
  2657. </DL>
  2658. </DD>
  2659. </DL>
  2660. <HR>
  2661. <A NAME="onVoice(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2662. onVoice</H3>
  2663. <PRE>
  2664. protected void <B>onVoice</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2665. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2666. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  2667. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  2668. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;recipient)</PRE>
  2669. <DL>
  2670. <DD>Called when a user (possibly us) gets voice status granted in a channel.
  2671. <p>
  2672. This is a type of mode change and is also passed to the onMode
  2673. method in the PircBot class.
  2674. <p>
  2675. The implementation of this method in the PircBot abstract class
  2676. performs no actions and may be overridden as required.
  2677. <P>
  2678. <DD><DL>
  2679. </DL>
  2680. </DD>
  2681. <DD><DL>
  2682. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DD><CODE>recipient</CODE> - The nick of the user that got 'voiced'.<DT><B>Since:</B></DT>
  2683. <DD>PircBot 0.9.5</DD>
  2684. </DL>
  2685. </DD>
  2686. </DL>
  2687. <HR>
  2688. <A NAME="onDeVoice(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2689. onDeVoice</H3>
  2690. <PRE>
  2691. protected void <B>onDeVoice</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2692. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2693. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  2694. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  2695. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;recipient)</PRE>
  2696. <DL>
  2697. <DD>Called when a user (possibly us) gets voice status removed.
  2698. <p>
  2699. This is a type of mode change and is also passed to the onMode
  2700. method in the PircBot class.
  2701. <p>
  2702. The implementation of this method in the PircBot abstract class
  2703. performs no actions and may be overridden as required.
  2704. <P>
  2705. <DD><DL>
  2706. </DL>
  2707. </DD>
  2708. <DD><DL>
  2709. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DD><CODE>recipient</CODE> - The nick of the user that got 'devoiced'.<DT><B>Since:</B></DT>
  2710. <DD>PircBot 0.9.5</DD>
  2711. </DL>
  2712. </DD>
  2713. </DL>
  2714. <HR>
  2715. <A NAME="onSetChannelKey(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2716. onSetChannelKey</H3>
  2717. <PRE>
  2718. protected void <B>onSetChannelKey</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2719. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2720. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  2721. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  2722. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;key)</PRE>
  2723. <DL>
  2724. <DD>Called when a channel key is set. When the channel key has been set,
  2725. other users may only join that channel if they know the key. Channel keys
  2726. are sometimes referred to as passwords.
  2727. <p>
  2728. This is a type of mode change and is also passed to the onMode
  2729. method in the PircBot class.
  2730. <p>
  2731. The implementation of this method in the PircBot abstract class
  2732. performs no actions and may be overridden as required.
  2733. <P>
  2734. <DD><DL>
  2735. </DL>
  2736. </DD>
  2737. <DD><DL>
  2738. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DD><CODE>key</CODE> - The new key for the channel.<DT><B>Since:</B></DT>
  2739. <DD>PircBot 0.9.5</DD>
  2740. </DL>
  2741. </DD>
  2742. </DL>
  2743. <HR>
  2744. <A NAME="onRemoveChannelKey(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2745. onRemoveChannelKey</H3>
  2746. <PRE>
  2747. protected void <B>onRemoveChannelKey</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2748. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2749. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  2750. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  2751. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;key)</PRE>
  2752. <DL>
  2753. <DD>Called when a channel key is removed.
  2754. <p>
  2755. This is a type of mode change and is also passed to the onMode
  2756. method in the PircBot class.
  2757. <p>
  2758. The implementation of this method in the PircBot abstract class
  2759. performs no actions and may be overridden as required.
  2760. <P>
  2761. <DD><DL>
  2762. </DL>
  2763. </DD>
  2764. <DD><DL>
  2765. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DD><CODE>key</CODE> - The key that was in use before the channel key was removed.<DT><B>Since:</B></DT>
  2766. <DD>PircBot 0.9.5</DD>
  2767. </DL>
  2768. </DD>
  2769. </DL>
  2770. <HR>
  2771. <A NAME="onSetChannelLimit(java.lang.String, java.lang.String, java.lang.String, java.lang.String, int)"><!-- --></A><H3>
  2772. onSetChannelLimit</H3>
  2773. <PRE>
  2774. protected void <B>onSetChannelLimit</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2775. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2776. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  2777. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  2778. int&nbsp;limit)</PRE>
  2779. <DL>
  2780. <DD>Called when a user limit is set for a channel. The number of users in
  2781. the channel cannot exceed this limit.
  2782. <p>
  2783. This is a type of mode change and is also passed to the onMode
  2784. method in the PircBot class.
  2785. <p>
  2786. The implementation of this method in the PircBot abstract class
  2787. performs no actions and may be overridden as required.
  2788. <P>
  2789. <DD><DL>
  2790. </DL>
  2791. </DD>
  2792. <DD><DL>
  2793. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DD><CODE>limit</CODE> - The maximum number of users that may be in this channel at the same time.<DT><B>Since:</B></DT>
  2794. <DD>PircBot 0.9.5</DD>
  2795. </DL>
  2796. </DD>
  2797. </DL>
  2798. <HR>
  2799. <A NAME="onRemoveChannelLimit(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2800. onRemoveChannelLimit</H3>
  2801. <PRE>
  2802. protected void <B>onRemoveChannelLimit</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2803. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2804. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  2805. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</PRE>
  2806. <DL>
  2807. <DD>Called when the user limit is removed for a channel.
  2808. <p>
  2809. This is a type of mode change and is also passed to the onMode
  2810. method in the PircBot class.
  2811. <p>
  2812. The implementation of this method in the PircBot abstract class
  2813. performs no actions and may be overridden as required.
  2814. <P>
  2815. <DD><DL>
  2816. </DL>
  2817. </DD>
  2818. <DD><DL>
  2819. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DT><B>Since:</B></DT>
  2820. <DD>PircBot 0.9.5</DD>
  2821. </DL>
  2822. </DD>
  2823. </DL>
  2824. <HR>
  2825. <A NAME="onSetChannelBan(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2826. onSetChannelBan</H3>
  2827. <PRE>
  2828. protected void <B>onSetChannelBan</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2829. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2830. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  2831. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  2832. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostmask)</PRE>
  2833. <DL>
  2834. <DD>Called when a user (possibly us) gets banned from a channel. Being
  2835. banned from a channel prevents any user with a matching hostmask from
  2836. joining the channel. For this reason, most bans are usually directly
  2837. followed by the user being kicked :-)
  2838. <p>
  2839. This is a type of mode change and is also passed to the onMode
  2840. method in the PircBot class.
  2841. <p>
  2842. The implementation of this method in the PircBot abstract class
  2843. performs no actions and may be overridden as required.
  2844. <P>
  2845. <DD><DL>
  2846. </DL>
  2847. </DD>
  2848. <DD><DL>
  2849. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DD><CODE>hostmask</CODE> - The hostmask of the user that has been banned.<DT><B>Since:</B></DT>
  2850. <DD>PircBot 0.9.5</DD>
  2851. </DL>
  2852. </DD>
  2853. </DL>
  2854. <HR>
  2855. <A NAME="onRemoveChannelBan(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2856. onRemoveChannelBan</H3>
  2857. <PRE>
  2858. protected void <B>onRemoveChannelBan</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2859. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2860. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  2861. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  2862. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostmask)</PRE>
  2863. <DL>
  2864. <DD>Called when a hostmask ban is removed from a channel.
  2865. <p>
  2866. This is a type of mode change and is also passed to the onMode
  2867. method in the PircBot class.
  2868. <p>
  2869. The implementation of this method in the PircBot abstract class
  2870. performs no actions and may be overridden as required.
  2871. <P>
  2872. <DD><DL>
  2873. </DL>
  2874. </DD>
  2875. <DD><DL>
  2876. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DD><CODE>hostmask</CODE> - <DT><B>Since:</B></DT>
  2877. <DD>PircBot 0.9.5</DD>
  2878. </DL>
  2879. </DD>
  2880. </DL>
  2881. <HR>
  2882. <A NAME="onSetTopicProtection(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2883. onSetTopicProtection</H3>
  2884. <PRE>
  2885. protected void <B>onSetTopicProtection</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2886. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2887. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  2888. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</PRE>
  2889. <DL>
  2890. <DD>Called when topic protection is enabled for a channel. Topic protection
  2891. means that only operators in a channel may change the topic.
  2892. <p>
  2893. This is a type of mode change and is also passed to the onMode
  2894. method in the PircBot class.
  2895. <p>
  2896. The implementation of this method in the PircBot abstract class
  2897. performs no actions and may be overridden as required.
  2898. <P>
  2899. <DD><DL>
  2900. </DL>
  2901. </DD>
  2902. <DD><DL>
  2903. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DT><B>Since:</B></DT>
  2904. <DD>PircBot 0.9.5</DD>
  2905. </DL>
  2906. </DD>
  2907. </DL>
  2908. <HR>
  2909. <A NAME="onRemoveTopicProtection(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2910. onRemoveTopicProtection</H3>
  2911. <PRE>
  2912. protected void <B>onRemoveTopicProtection</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2913. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2914. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  2915. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</PRE>
  2916. <DL>
  2917. <DD>Called when topic protection is removed for a channel.
  2918. <p>
  2919. This is a type of mode change and is also passed to the onMode
  2920. method in the PircBot class.
  2921. <p>
  2922. The implementation of this method in the PircBot abstract class
  2923. performs no actions and may be overridden as required.
  2924. <P>
  2925. <DD><DL>
  2926. </DL>
  2927. </DD>
  2928. <DD><DL>
  2929. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DT><B>Since:</B></DT>
  2930. <DD>PircBot 0.9.5</DD>
  2931. </DL>
  2932. </DD>
  2933. </DL>
  2934. <HR>
  2935. <A NAME="onSetNoExternalMessages(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2936. onSetNoExternalMessages</H3>
  2937. <PRE>
  2938. protected void <B>onSetNoExternalMessages</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2939. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2940. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  2941. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</PRE>
  2942. <DL>
  2943. <DD>Called when a channel is set to only allow messages from users that
  2944. are in the channel.
  2945. <p>
  2946. This is a type of mode change and is also passed to the onMode
  2947. method in the PircBot class.
  2948. <p>
  2949. The implementation of this method in the PircBot abstract class
  2950. performs no actions and may be overridden as required.
  2951. <P>
  2952. <DD><DL>
  2953. </DL>
  2954. </DD>
  2955. <DD><DL>
  2956. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DT><B>Since:</B></DT>
  2957. <DD>PircBot 0.9.5</DD>
  2958. </DL>
  2959. </DD>
  2960. </DL>
  2961. <HR>
  2962. <A NAME="onRemoveNoExternalMessages(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2963. onRemoveNoExternalMessages</H3>
  2964. <PRE>
  2965. protected void <B>onRemoveNoExternalMessages</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2966. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2967. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  2968. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</PRE>
  2969. <DL>
  2970. <DD>Called when a channel is set to allow messages from any user, even
  2971. if they are not actually in the channel.
  2972. <p>
  2973. This is a type of mode change and is also passed to the onMode
  2974. method in the PircBot class.
  2975. <p>
  2976. The implementation of this method in the PircBot abstract class
  2977. performs no actions and may be overridden as required.
  2978. <P>
  2979. <DD><DL>
  2980. </DL>
  2981. </DD>
  2982. <DD><DL>
  2983. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DT><B>Since:</B></DT>
  2984. <DD>PircBot 0.9.5</DD>
  2985. </DL>
  2986. </DD>
  2987. </DL>
  2988. <HR>
  2989. <A NAME="onSetInviteOnly(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  2990. onSetInviteOnly</H3>
  2991. <PRE>
  2992. protected void <B>onSetInviteOnly</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  2993. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  2994. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  2995. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</PRE>
  2996. <DL>
  2997. <DD>Called when a channel is set to 'invite only' mode. A user may only
  2998. join the channel if they are invited by someone who is already in the
  2999. channel.
  3000. <p>
  3001. This is a type of mode change and is also passed to the onMode
  3002. method in the PircBot class.
  3003. <p>
  3004. The implementation of this method in the PircBot abstract class
  3005. performs no actions and may be overridden as required.
  3006. <P>
  3007. <DD><DL>
  3008. </DL>
  3009. </DD>
  3010. <DD><DL>
  3011. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DT><B>Since:</B></DT>
  3012. <DD>PircBot 0.9.5</DD>
  3013. </DL>
  3014. </DD>
  3015. </DL>
  3016. <HR>
  3017. <A NAME="onRemoveInviteOnly(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  3018. onRemoveInviteOnly</H3>
  3019. <PRE>
  3020. protected void <B>onRemoveInviteOnly</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  3021. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  3022. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  3023. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</PRE>
  3024. <DL>
  3025. <DD>Called when a channel has 'invite only' removed.
  3026. <p>
  3027. This is a type of mode change and is also passed to the onMode
  3028. method in the PircBot class.
  3029. <p>
  3030. The implementation of this method in the PircBot abstract class
  3031. performs no actions and may be overridden as required.
  3032. <P>
  3033. <DD><DL>
  3034. </DL>
  3035. </DD>
  3036. <DD><DL>
  3037. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DT><B>Since:</B></DT>
  3038. <DD>PircBot 0.9.5</DD>
  3039. </DL>
  3040. </DD>
  3041. </DL>
  3042. <HR>
  3043. <A NAME="onSetModerated(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  3044. onSetModerated</H3>
  3045. <PRE>
  3046. protected void <B>onSetModerated</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  3047. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  3048. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  3049. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</PRE>
  3050. <DL>
  3051. <DD>Called when a channel is set to 'moderated' mode. If a channel is
  3052. moderated, then only users who have been 'voiced' or 'opped' may speak
  3053. or change their nicks.
  3054. <p>
  3055. This is a type of mode change and is also passed to the onMode
  3056. method in the PircBot class.
  3057. <p>
  3058. The implementation of this method in the PircBot abstract class
  3059. performs no actions and may be overridden as required.
  3060. <P>
  3061. <DD><DL>
  3062. </DL>
  3063. </DD>
  3064. <DD><DL>
  3065. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DT><B>Since:</B></DT>
  3066. <DD>PircBot 0.9.5</DD>
  3067. </DL>
  3068. </DD>
  3069. </DL>
  3070. <HR>
  3071. <A NAME="onRemoveModerated(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  3072. onRemoveModerated</H3>
  3073. <PRE>
  3074. protected void <B>onRemoveModerated</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  3075. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  3076. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  3077. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</PRE>
  3078. <DL>
  3079. <DD>Called when a channel has moderated mode removed.
  3080. <p>
  3081. This is a type of mode change and is also passed to the onMode
  3082. method in the PircBot class.
  3083. <p>
  3084. The implementation of this method in the PircBot abstract class
  3085. performs no actions and may be overridden as required.
  3086. <P>
  3087. <DD><DL>
  3088. </DL>
  3089. </DD>
  3090. <DD><DL>
  3091. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DT><B>Since:</B></DT>
  3092. <DD>PircBot 0.9.5</DD>
  3093. </DL>
  3094. </DD>
  3095. </DL>
  3096. <HR>
  3097. <A NAME="onSetPrivate(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  3098. onSetPrivate</H3>
  3099. <PRE>
  3100. protected void <B>onSetPrivate</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  3101. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  3102. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  3103. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</PRE>
  3104. <DL>
  3105. <DD>Called when a channel is marked as being in private mode.
  3106. <p>
  3107. This is a type of mode change and is also passed to the onMode
  3108. method in the PircBot class.
  3109. <p>
  3110. The implementation of this method in the PircBot abstract class
  3111. performs no actions and may be overridden as required.
  3112. <P>
  3113. <DD><DL>
  3114. </DL>
  3115. </DD>
  3116. <DD><DL>
  3117. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DT><B>Since:</B></DT>
  3118. <DD>PircBot 0.9.5</DD>
  3119. </DL>
  3120. </DD>
  3121. </DL>
  3122. <HR>
  3123. <A NAME="onRemovePrivate(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  3124. onRemovePrivate</H3>
  3125. <PRE>
  3126. protected void <B>onRemovePrivate</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  3127. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  3128. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  3129. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</PRE>
  3130. <DL>
  3131. <DD>Called when a channel is marked as not being in private mode.
  3132. <p>
  3133. This is a type of mode change and is also passed to the onMode
  3134. method in the PircBot class.
  3135. <p>
  3136. The implementation of this method in the PircBot abstract class
  3137. performs no actions and may be overridden as required.
  3138. <P>
  3139. <DD><DL>
  3140. </DL>
  3141. </DD>
  3142. <DD><DL>
  3143. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DT><B>Since:</B></DT>
  3144. <DD>PircBot 0.9.5</DD>
  3145. </DL>
  3146. </DD>
  3147. </DL>
  3148. <HR>
  3149. <A NAME="onSetSecret(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  3150. onSetSecret</H3>
  3151. <PRE>
  3152. protected void <B>onSetSecret</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  3153. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  3154. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  3155. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</PRE>
  3156. <DL>
  3157. <DD>Called when a channel is set to be in 'secret' mode. Such channels
  3158. typically do not appear on a server's channel listing.
  3159. <p>
  3160. This is a type of mode change and is also passed to the onMode
  3161. method in the PircBot class.
  3162. <p>
  3163. The implementation of this method in the PircBot abstract class
  3164. performs no actions and may be overridden as required.
  3165. <P>
  3166. <DD><DL>
  3167. </DL>
  3168. </DD>
  3169. <DD><DL>
  3170. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DT><B>Since:</B></DT>
  3171. <DD>PircBot 0.9.5</DD>
  3172. </DL>
  3173. </DD>
  3174. </DL>
  3175. <HR>
  3176. <A NAME="onRemoveSecret(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  3177. onRemoveSecret</H3>
  3178. <PRE>
  3179. protected void <B>onRemoveSecret</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel,
  3180. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  3181. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  3182. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname)</PRE>
  3183. <DL>
  3184. <DD>Called when a channel has 'secret' mode removed.
  3185. <p>
  3186. This is a type of mode change and is also passed to the onMode
  3187. method in the PircBot class.
  3188. <p>
  3189. The implementation of this method in the PircBot abstract class
  3190. performs no actions and may be overridden as required.
  3191. <P>
  3192. <DD><DL>
  3193. </DL>
  3194. </DD>
  3195. <DD><DL>
  3196. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The channel in which the mode change took place.<DD><CODE>sourceNick</CODE> - The nick of the user that performed the mode change.<DD><CODE>sourceLogin</CODE> - The login of the user that performed the mode change.<DD><CODE>sourceHostname</CODE> - The hostname of the user that performed the mode change.<DT><B>Since:</B></DT>
  3197. <DD>PircBot 0.9.5</DD>
  3198. </DL>
  3199. </DD>
  3200. </DL>
  3201. <HR>
  3202. <A NAME="onInvite(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  3203. onInvite</H3>
  3204. <PRE>
  3205. protected void <B>onInvite</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;targetNick,
  3206. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  3207. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  3208. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  3209. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel)</PRE>
  3210. <DL>
  3211. <DD>Called when we are invited to a channel by a user.
  3212. <p>
  3213. The implementation of this method in the PircBot abstract class
  3214. performs no actions and may be overridden as required.
  3215. <P>
  3216. <DD><DL>
  3217. </DL>
  3218. </DD>
  3219. <DD><DL>
  3220. <DT><B>Parameters:</B><DD><CODE>targetNick</CODE> - The nick of the user being invited - should be us!<DD><CODE>sourceNick</CODE> - The nick of the user that sent the invitation.<DD><CODE>sourceLogin</CODE> - The login of the user that sent the invitation.<DD><CODE>sourceHostname</CODE> - The hostname of the user that sent the invitation.<DD><CODE>channel</CODE> - The channel that we're being invited to.<DT><B>Since:</B></DT>
  3221. <DD>PircBot 0.9.5</DD>
  3222. </DL>
  3223. </DD>
  3224. </DL>
  3225. <HR>
  3226. <A NAME="onDccSendRequest(java.lang.String, java.lang.String, java.lang.String, java.lang.String, long, int, int)"><!-- --></A><H3>
  3227. onDccSendRequest</H3>
  3228. <PRE>
  3229. protected void <B>onDccSendRequest</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  3230. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  3231. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  3232. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;filename,
  3233. long&nbsp;address,
  3234. int&nbsp;port,
  3235. int&nbsp;size)</PRE>
  3236. <DL>
  3237. <DD><B>Deprecated.</B>&nbsp;<I>As of PircBot 1.2.0, use <A HREF="../../../org/jibble/pircbot/PircBot.html#onIncomingFileTransfer(org.jibble.pircbot.DccFileTransfer)"><CODE>onIncomingFileTransfer(DccFileTransfer)</CODE></A></I>
  3238. <P>
  3239. <DD>This method used to be called when a DCC SEND request was sent to the PircBot.
  3240. Please use the onIncomingFileTransfer method to receive files, as it
  3241. has better functionality and supports resuming.
  3242. <P>
  3243. <DD><DL>
  3244. </DL>
  3245. </DD>
  3246. <DD><DL>
  3247. </DL>
  3248. </DD>
  3249. </DL>
  3250. <HR>
  3251. <A NAME="onDccChatRequest(java.lang.String, java.lang.String, java.lang.String, long, int)"><!-- --></A><H3>
  3252. onDccChatRequest</H3>
  3253. <PRE>
  3254. protected void <B>onDccChatRequest</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  3255. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  3256. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  3257. long&nbsp;address,
  3258. int&nbsp;port)</PRE>
  3259. <DL>
  3260. <DD><B>Deprecated.</B>&nbsp;<I>As of PircBot 1.2.0, use <A HREF="../../../org/jibble/pircbot/PircBot.html#onIncomingChatRequest(org.jibble.pircbot.DccChat)"><CODE>onIncomingChatRequest(DccChat)</CODE></A></I>
  3261. <P>
  3262. <DD>This method used to be called when a DCC CHAT request was sent to the PircBot.
  3263. Please use the onIncomingChatRequest method to accept chats, as it
  3264. has better functionality.
  3265. <P>
  3266. <DD><DL>
  3267. </DL>
  3268. </DD>
  3269. <DD><DL>
  3270. </DL>
  3271. </DD>
  3272. </DL>
  3273. <HR>
  3274. <A NAME="onIncomingFileTransfer(org.jibble.pircbot.DccFileTransfer)"><!-- --></A><H3>
  3275. onIncomingFileTransfer</H3>
  3276. <PRE>
  3277. protected void <B>onIncomingFileTransfer</B>(<A HREF="../../../org/jibble/pircbot/DccFileTransfer.html" title="class in org.jibble.pircbot">DccFileTransfer</A>&nbsp;transfer)</PRE>
  3278. <DL>
  3279. <DD>This method is called whenever a DCC SEND request is sent to the PircBot.
  3280. This means that a client has requested to send a file to us.
  3281. This abstract implementation performs no action, which means that all
  3282. DCC SEND requests will be ignored by default. If you wish to receive
  3283. the file, then you may override this method and call the receive method
  3284. on the DccFileTransfer object, which connects to the sender and downloads
  3285. the file.
  3286. <p>
  3287. Example:
  3288. <pre> public void onIncomingFileTransfer(DccFileTransfer transfer) {
  3289. // Use the suggested file name.
  3290. File file = transfer.getFile();
  3291. // Receive the transfer and save it to the file, allowing resuming.
  3292. transfer.receive(file, true);
  3293. }</pre>
  3294. <p>
  3295. <b>Warning:</b> Receiving an incoming file transfer will cause a file
  3296. to be written to disk. Please ensure that you make adequate security
  3297. checks so that this file does not overwrite anything important!
  3298. <p>
  3299. Each time a file is received, it happens within a new Thread
  3300. in order to allow multiple files to be downloaded by the PircBot
  3301. at the same time.
  3302. <p>
  3303. If you allow resuming and the file already partly exists, it will
  3304. be appended to instead of overwritten. If resuming is not enabled,
  3305. the file will be overwritten if it already exists.
  3306. <p>
  3307. You can throttle the speed of the transfer by calling the setPacketDelay
  3308. method on the DccFileTransfer object, either before you receive the
  3309. file or at any moment during the transfer.
  3310. <p>
  3311. The implementation of this method in the PircBot abstract class
  3312. performs no actions and may be overridden as required.
  3313. <P>
  3314. <DD><DL>
  3315. </DL>
  3316. </DD>
  3317. <DD><DL>
  3318. <DT><B>Parameters:</B><DD><CODE>transfer</CODE> - The DcccFileTransfer that you may accept.<DT><B>Since:</B></DT>
  3319. <DD>PircBot 1.2.0</DD>
  3320. <DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/DccFileTransfer.html" title="class in org.jibble.pircbot"><CODE>DccFileTransfer</CODE></A></DL>
  3321. </DD>
  3322. </DL>
  3323. <HR>
  3324. <A NAME="onFileTransferFinished(org.jibble.pircbot.DccFileTransfer, java.lang.Exception)"><!-- --></A><H3>
  3325. onFileTransferFinished</H3>
  3326. <PRE>
  3327. protected void <B>onFileTransferFinished</B>(<A HREF="../../../org/jibble/pircbot/DccFileTransfer.html" title="class in org.jibble.pircbot">DccFileTransfer</A>&nbsp;transfer,
  3328. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A>&nbsp;e)</PRE>
  3329. <DL>
  3330. <DD>This method gets called when a DccFileTransfer has finished.
  3331. If there was a problem, the Exception will say what went wrong.
  3332. If the file was sent successfully, the Exception will be null.
  3333. <p>
  3334. Both incoming and outgoing file transfers are passed to this method.
  3335. You can determine the type by calling the isIncoming or isOutgoing
  3336. methods on the DccFileTransfer object.
  3337. <P>
  3338. <DD><DL>
  3339. </DL>
  3340. </DD>
  3341. <DD><DL>
  3342. <DT><B>Parameters:</B><DD><CODE>transfer</CODE> - The DccFileTransfer that has finished.<DD><CODE>e</CODE> - null if the file was transfered successfully, otherwise this
  3343. will report what went wrong.<DT><B>Since:</B></DT>
  3344. <DD>PircBot 1.2.0</DD>
  3345. <DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/DccFileTransfer.html" title="class in org.jibble.pircbot"><CODE>DccFileTransfer</CODE></A></DL>
  3346. </DD>
  3347. </DL>
  3348. <HR>
  3349. <A NAME="onIncomingChatRequest(org.jibble.pircbot.DccChat)"><!-- --></A><H3>
  3350. onIncomingChatRequest</H3>
  3351. <PRE>
  3352. protected void <B>onIncomingChatRequest</B>(<A HREF="../../../org/jibble/pircbot/DccChat.html" title="class in org.jibble.pircbot">DccChat</A>&nbsp;chat)</PRE>
  3353. <DL>
  3354. <DD>This method will be called whenever a DCC Chat request is received.
  3355. This means that a client has requested to chat to us directly rather
  3356. than via the IRC server. This is useful for sending many lines of text
  3357. to and from the bot without having to worry about flooding the server
  3358. or any operators of the server being able to "spy" on what is being
  3359. said. This abstract implementation performs no action, which means
  3360. that all DCC CHAT requests will be ignored by default.
  3361. <p>
  3362. If you wish to accept the connection, then you may override this
  3363. method and call the accept() method on the DccChat object, which
  3364. connects to the sender of the chat request and allows lines to be
  3365. sent to and from the bot.
  3366. <p>
  3367. Your bot must be able to connect directly to the user that sent the
  3368. request.
  3369. <p>
  3370. Example:
  3371. <pre> public void onIncomingChatRequest(DccChat chat) {
  3372. try {
  3373. // Accept all chat, whoever it's from.
  3374. chat.accept();
  3375. chat.sendLine("Hello");
  3376. String response = chat.readLine();
  3377. chat.close();
  3378. }
  3379. catch (IOException e) {}
  3380. }</pre>
  3381. Each time this method is called, it is called from within a new Thread
  3382. so that multiple DCC CHAT sessions can run concurrently.
  3383. <p>
  3384. The implementation of this method in the PircBot abstract class
  3385. performs no actions and may be overridden as required.
  3386. <P>
  3387. <DD><DL>
  3388. </DL>
  3389. </DD>
  3390. <DD><DL>
  3391. <DT><B>Parameters:</B><DD><CODE>chat</CODE> - A DccChat object that represents the incoming chat request.<DT><B>Since:</B></DT>
  3392. <DD>PircBot 1.2.0</DD>
  3393. <DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/DccChat.html" title="class in org.jibble.pircbot"><CODE>DccChat</CODE></A></DL>
  3394. </DD>
  3395. </DL>
  3396. <HR>
  3397. <A NAME="onVersion(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  3398. onVersion</H3>
  3399. <PRE>
  3400. protected void <B>onVersion</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  3401. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  3402. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  3403. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target)</PRE>
  3404. <DL>
  3405. <DD>This method is called whenever we receive a VERSION request.
  3406. This abstract implementation responds with the PircBot's _version string,
  3407. so if you override this method, be sure to either mimic its functionality
  3408. or to call super.onVersion(...);
  3409. <P>
  3410. <DD><DL>
  3411. </DL>
  3412. </DD>
  3413. <DD><DL>
  3414. <DT><B>Parameters:</B><DD><CODE>sourceNick</CODE> - The nick of the user that sent the VERSION request.<DD><CODE>sourceLogin</CODE> - The login of the user that sent the VERSION request.<DD><CODE>sourceHostname</CODE> - The hostname of the user that sent the VERSION request.<DD><CODE>target</CODE> - The target of the VERSION request, be it our nick or a channel name.</DL>
  3415. </DD>
  3416. </DL>
  3417. <HR>
  3418. <A NAME="onPing(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  3419. onPing</H3>
  3420. <PRE>
  3421. protected void <B>onPing</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  3422. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  3423. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  3424. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target,
  3425. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;pingValue)</PRE>
  3426. <DL>
  3427. <DD>This method is called whenever we receive a PING request from another
  3428. user.
  3429. <p>
  3430. This abstract implementation responds correctly, so if you override this
  3431. method, be sure to either mimic its functionality or to call
  3432. super.onPing(...);
  3433. <P>
  3434. <DD><DL>
  3435. </DL>
  3436. </DD>
  3437. <DD><DL>
  3438. <DT><B>Parameters:</B><DD><CODE>sourceNick</CODE> - The nick of the user that sent the PING request.<DD><CODE>sourceLogin</CODE> - The login of the user that sent the PING request.<DD><CODE>sourceHostname</CODE> - The hostname of the user that sent the PING request.<DD><CODE>target</CODE> - The target of the PING request, be it our nick or a channel name.<DD><CODE>pingValue</CODE> - The value that was supplied as an argument to the PING command.</DL>
  3439. </DD>
  3440. </DL>
  3441. <HR>
  3442. <A NAME="onServerPing(java.lang.String)"><!-- --></A><H3>
  3443. onServerPing</H3>
  3444. <PRE>
  3445. protected void <B>onServerPing</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;response)</PRE>
  3446. <DL>
  3447. <DD>The actions to perform when a PING request comes from the server.
  3448. <p>
  3449. This sends back a correct response, so if you override this method,
  3450. be sure to either mimic its functionality or to call
  3451. super.onServerPing(response);
  3452. <P>
  3453. <DD><DL>
  3454. </DL>
  3455. </DD>
  3456. <DD><DL>
  3457. <DT><B>Parameters:</B><DD><CODE>response</CODE> - The response that should be given back in your PONG.</DL>
  3458. </DD>
  3459. </DL>
  3460. <HR>
  3461. <A NAME="onTime(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  3462. onTime</H3>
  3463. <PRE>
  3464. protected void <B>onTime</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  3465. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  3466. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  3467. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target)</PRE>
  3468. <DL>
  3469. <DD>This method is called whenever we receive a TIME request.
  3470. <p>
  3471. This abstract implementation responds correctly, so if you override this
  3472. method, be sure to either mimic its functionality or to call
  3473. super.onTime(...);
  3474. <P>
  3475. <DD><DL>
  3476. </DL>
  3477. </DD>
  3478. <DD><DL>
  3479. <DT><B>Parameters:</B><DD><CODE>sourceNick</CODE> - The nick of the user that sent the TIME request.<DD><CODE>sourceLogin</CODE> - The login of the user that sent the TIME request.<DD><CODE>sourceHostname</CODE> - The hostname of the user that sent the TIME request.<DD><CODE>target</CODE> - The target of the TIME request, be it our nick or a channel name.</DL>
  3480. </DD>
  3481. </DL>
  3482. <HR>
  3483. <A NAME="onFinger(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  3484. onFinger</H3>
  3485. <PRE>
  3486. protected void <B>onFinger</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceNick,
  3487. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceLogin,
  3488. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;sourceHostname,
  3489. <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;target)</PRE>
  3490. <DL>
  3491. <DD>This method is called whenever we receive a FINGER request.
  3492. <p>
  3493. This abstract implementation responds correctly, so if you override this
  3494. method, be sure to either mimic its functionality or to call
  3495. super.onFinger(...);
  3496. <P>
  3497. <DD><DL>
  3498. </DL>
  3499. </DD>
  3500. <DD><DL>
  3501. <DT><B>Parameters:</B><DD><CODE>sourceNick</CODE> - The nick of the user that sent the FINGER request.<DD><CODE>sourceLogin</CODE> - The login of the user that sent the FINGER request.<DD><CODE>sourceHostname</CODE> - The hostname of the user that sent the FINGER request.<DD><CODE>target</CODE> - The target of the FINGER request, be it our nick or a channel name.</DL>
  3502. </DD>
  3503. </DL>
  3504. <HR>
  3505. <A NAME="onUnknown(java.lang.String)"><!-- --></A><H3>
  3506. onUnknown</H3>
  3507. <PRE>
  3508. protected void <B>onUnknown</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;line)</PRE>
  3509. <DL>
  3510. <DD>This method is called whenever we receive a line from the server that
  3511. the PircBot has not been programmed to recognise.
  3512. <p>
  3513. The implementation of this method in the PircBot abstract class
  3514. performs no actions and may be overridden as required.
  3515. <P>
  3516. <DD><DL>
  3517. </DL>
  3518. </DD>
  3519. <DD><DL>
  3520. <DT><B>Parameters:</B><DD><CODE>line</CODE> - The raw line that was received from the server.</DL>
  3521. </DD>
  3522. </DL>
  3523. <HR>
  3524. <A NAME="setVerbose(boolean)"><!-- --></A><H3>
  3525. setVerbose</H3>
  3526. <PRE>
  3527. public final void <B>setVerbose</B>(boolean&nbsp;verbose)</PRE>
  3528. <DL>
  3529. <DD>Sets the verbose mode. If verbose mode is set to true, then log entries
  3530. will be printed to the standard output. The default value is false and
  3531. will result in no output. For general development, we strongly recommend
  3532. setting the verbose mode to true.
  3533. <P>
  3534. <DD><DL>
  3535. </DL>
  3536. </DD>
  3537. <DD><DL>
  3538. <DT><B>Parameters:</B><DD><CODE>verbose</CODE> - true if verbose mode is to be used. Default is false.</DL>
  3539. </DD>
  3540. </DL>
  3541. <HR>
  3542. <A NAME="setName(java.lang.String)"><!-- --></A><H3>
  3543. setName</H3>
  3544. <PRE>
  3545. protected final void <B>setName</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
  3546. <DL>
  3547. <DD>Sets the name of the bot, which will be used as its nick when it
  3548. tries to join an IRC server. This should be set before joining
  3549. any servers, otherwise the default nick will be used. You would
  3550. typically call this method from the constructor of the class that
  3551. extends PircBot.
  3552. <p>
  3553. The changeNick method should be used if you wish to change your nick
  3554. when you are connected to a server.
  3555. <P>
  3556. <DD><DL>
  3557. </DL>
  3558. </DD>
  3559. <DD><DL>
  3560. <DT><B>Parameters:</B><DD><CODE>name</CODE> - The new name of the Bot.</DL>
  3561. </DD>
  3562. </DL>
  3563. <HR>
  3564. <A NAME="setLogin(java.lang.String)"><!-- --></A><H3>
  3565. setLogin</H3>
  3566. <PRE>
  3567. protected final void <B>setLogin</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;login)</PRE>
  3568. <DL>
  3569. <DD>Sets the internal login of the Bot. This should be set before joining
  3570. any servers.
  3571. <P>
  3572. <DD><DL>
  3573. </DL>
  3574. </DD>
  3575. <DD><DL>
  3576. <DT><B>Parameters:</B><DD><CODE>login</CODE> - The new login of the Bot.</DL>
  3577. </DD>
  3578. </DL>
  3579. <HR>
  3580. <A NAME="setVersion(java.lang.String)"><!-- --></A><H3>
  3581. setVersion</H3>
  3582. <PRE>
  3583. protected final void <B>setVersion</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;version)</PRE>
  3584. <DL>
  3585. <DD>Sets the internal version of the Bot. This should be set before joining
  3586. any servers.
  3587. <P>
  3588. <DD><DL>
  3589. </DL>
  3590. </DD>
  3591. <DD><DL>
  3592. <DT><B>Parameters:</B><DD><CODE>version</CODE> - The new version of the Bot.</DL>
  3593. </DD>
  3594. </DL>
  3595. <HR>
  3596. <A NAME="setFinger(java.lang.String)"><!-- --></A><H3>
  3597. setFinger</H3>
  3598. <PRE>
  3599. protected final void <B>setFinger</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;finger)</PRE>
  3600. <DL>
  3601. <DD>Sets the interal finger message. This should be set before joining
  3602. any servers.
  3603. <P>
  3604. <DD><DL>
  3605. </DL>
  3606. </DD>
  3607. <DD><DL>
  3608. <DT><B>Parameters:</B><DD><CODE>finger</CODE> - The new finger message for the Bot.</DL>
  3609. </DD>
  3610. </DL>
  3611. <HR>
  3612. <A NAME="getName()"><!-- --></A><H3>
  3613. getName</H3>
  3614. <PRE>
  3615. public final <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getName</B>()</PRE>
  3616. <DL>
  3617. <DD>Gets the name of the PircBot. This is the name that will be used as
  3618. as a nick when we try to join servers.
  3619. <P>
  3620. <DD><DL>
  3621. </DL>
  3622. </DD>
  3623. <DD><DL>
  3624. <DT><B>Returns:</B><DD>The name of the PircBot.</DL>
  3625. </DD>
  3626. </DL>
  3627. <HR>
  3628. <A NAME="getNick()"><!-- --></A><H3>
  3629. getNick</H3>
  3630. <PRE>
  3631. public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getNick</B>()</PRE>
  3632. <DL>
  3633. <DD>Returns the current nick of the bot. Note that if you have just changed
  3634. your nick, this method will still return the old nick until confirmation
  3635. of the nick change is received from the server.
  3636. <p>
  3637. The nick returned by this method is maintained only by the PircBot
  3638. class and is guaranteed to be correct in the context of the IRC server.
  3639. <P>
  3640. <DD><DL>
  3641. </DL>
  3642. </DD>
  3643. <DD><DL>
  3644. <DT><B>Returns:</B><DD>The current nick of the bot.<DT><B>Since:</B></DT>
  3645. <DD>PircBot 1.0.0</DD>
  3646. </DL>
  3647. </DD>
  3648. </DL>
  3649. <HR>
  3650. <A NAME="getLogin()"><!-- --></A><H3>
  3651. getLogin</H3>
  3652. <PRE>
  3653. public final <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getLogin</B>()</PRE>
  3654. <DL>
  3655. <DD>Gets the internal login of the PircBot.
  3656. <P>
  3657. <DD><DL>
  3658. </DL>
  3659. </DD>
  3660. <DD><DL>
  3661. <DT><B>Returns:</B><DD>The login of the PircBot.</DL>
  3662. </DD>
  3663. </DL>
  3664. <HR>
  3665. <A NAME="getVersion()"><!-- --></A><H3>
  3666. getVersion</H3>
  3667. <PRE>
  3668. public final <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getVersion</B>()</PRE>
  3669. <DL>
  3670. <DD>Gets the internal version of the PircBot.
  3671. <P>
  3672. <DD><DL>
  3673. </DL>
  3674. </DD>
  3675. <DD><DL>
  3676. <DT><B>Returns:</B><DD>The version of the PircBot.</DL>
  3677. </DD>
  3678. </DL>
  3679. <HR>
  3680. <A NAME="getFinger()"><!-- --></A><H3>
  3681. getFinger</H3>
  3682. <PRE>
  3683. public final <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getFinger</B>()</PRE>
  3684. <DL>
  3685. <DD>Gets the internal finger message of the PircBot.
  3686. <P>
  3687. <DD><DL>
  3688. </DL>
  3689. </DD>
  3690. <DD><DL>
  3691. <DT><B>Returns:</B><DD>The finger message of the PircBot.</DL>
  3692. </DD>
  3693. </DL>
  3694. <HR>
  3695. <A NAME="isConnected()"><!-- --></A><H3>
  3696. isConnected</H3>
  3697. <PRE>
  3698. public final boolean <B>isConnected</B>()</PRE>
  3699. <DL>
  3700. <DD>Returns whether or not the PircBot is currently connected to a server.
  3701. The result of this method should only act as a rough guide,
  3702. as the result may not be valid by the time you act upon it.
  3703. <P>
  3704. <DD><DL>
  3705. </DL>
  3706. </DD>
  3707. <DD><DL>
  3708. <DT><B>Returns:</B><DD>True if and only if the PircBot is currently connected to a server.</DL>
  3709. </DD>
  3710. </DL>
  3711. <HR>
  3712. <A NAME="setMessageDelay(long)"><!-- --></A><H3>
  3713. setMessageDelay</H3>
  3714. <PRE>
  3715. public final void <B>setMessageDelay</B>(long&nbsp;delay)</PRE>
  3716. <DL>
  3717. <DD>Sets the number of milliseconds to delay between consecutive
  3718. messages when there are multiple messages waiting in the
  3719. outgoing message queue. This has a default value of 1000ms.
  3720. It is a good idea to stick to this default value, as it will
  3721. prevent your bot from spamming servers and facing the subsequent
  3722. wrath! However, if you do need to change this delay value (<b>not
  3723. recommended</b>), then this is the method to use.
  3724. <P>
  3725. <DD><DL>
  3726. </DL>
  3727. </DD>
  3728. <DD><DL>
  3729. <DT><B>Parameters:</B><DD><CODE>delay</CODE> - The number of milliseconds between each outgoing message.</DL>
  3730. </DD>
  3731. </DL>
  3732. <HR>
  3733. <A NAME="getMessageDelay()"><!-- --></A><H3>
  3734. getMessageDelay</H3>
  3735. <PRE>
  3736. public final long <B>getMessageDelay</B>()</PRE>
  3737. <DL>
  3738. <DD>Returns the number of milliseconds that will be used to separate
  3739. consecutive messages to the server from the outgoing message queue.
  3740. <P>
  3741. <DD><DL>
  3742. </DL>
  3743. </DD>
  3744. <DD><DL>
  3745. <DT><B>Returns:</B><DD>Number of milliseconds.</DL>
  3746. </DD>
  3747. </DL>
  3748. <HR>
  3749. <A NAME="getMaxLineLength()"><!-- --></A><H3>
  3750. getMaxLineLength</H3>
  3751. <PRE>
  3752. public final int <B>getMaxLineLength</B>()</PRE>
  3753. <DL>
  3754. <DD>Gets the maximum length of any line that is sent via the IRC protocol.
  3755. The IRC RFC specifies that line lengths, including the trailing \r\n
  3756. must not exceed 512 bytes. Hence, there is currently no option to
  3757. change this value in PircBot. All lines greater than this length
  3758. will be truncated before being sent to the IRC server.
  3759. <P>
  3760. <DD><DL>
  3761. </DL>
  3762. </DD>
  3763. <DD><DL>
  3764. <DT><B>Returns:</B><DD>The maximum line length (currently fixed at 512)</DL>
  3765. </DD>
  3766. </DL>
  3767. <HR>
  3768. <A NAME="getOutgoingQueueSize()"><!-- --></A><H3>
  3769. getOutgoingQueueSize</H3>
  3770. <PRE>
  3771. public final int <B>getOutgoingQueueSize</B>()</PRE>
  3772. <DL>
  3773. <DD>Gets the number of lines currently waiting in the outgoing message Queue.
  3774. If this returns 0, then the Queue is empty and any new message is likely
  3775. to be sent to the IRC server immediately.
  3776. <P>
  3777. <DD><DL>
  3778. </DL>
  3779. </DD>
  3780. <DD><DL>
  3781. <DT><B>Returns:</B><DD>The number of lines in the outgoing message Queue.<DT><B>Since:</B></DT>
  3782. <DD>PircBot 0.9.9</DD>
  3783. </DL>
  3784. </DD>
  3785. </DL>
  3786. <HR>
  3787. <A NAME="getServer()"><!-- --></A><H3>
  3788. getServer</H3>
  3789. <PRE>
  3790. public final <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getServer</B>()</PRE>
  3791. <DL>
  3792. <DD>Returns the name of the last IRC server the PircBot tried to connect to.
  3793. This does not imply that the connection attempt to the server was
  3794. successful (we suggest you look at the onConnect method).
  3795. A value of null is returned if the PircBot has never tried to connect
  3796. to a server.
  3797. <P>
  3798. <DD><DL>
  3799. </DL>
  3800. </DD>
  3801. <DD><DL>
  3802. <DT><B>Returns:</B><DD>The name of the last machine we tried to connect to. Returns
  3803. null if no connection attempts have ever been made.</DL>
  3804. </DD>
  3805. </DL>
  3806. <HR>
  3807. <A NAME="getPort()"><!-- --></A><H3>
  3808. getPort</H3>
  3809. <PRE>
  3810. public final int <B>getPort</B>()</PRE>
  3811. <DL>
  3812. <DD>Returns the port number of the last IRC server that the PircBot tried
  3813. to connect to.
  3814. This does not imply that the connection attempt to the server was
  3815. successful (we suggest you look at the onConnect method).
  3816. A value of -1 is returned if the PircBot has never tried to connect
  3817. to a server.
  3818. <P>
  3819. <DD><DL>
  3820. </DL>
  3821. </DD>
  3822. <DD><DL>
  3823. <DT><B>Returns:</B><DD>The port number of the last IRC server we connected to.
  3824. Returns -1 if no connection attempts have ever been made.<DT><B>Since:</B></DT>
  3825. <DD>PircBot 0.9.9</DD>
  3826. </DL>
  3827. </DD>
  3828. </DL>
  3829. <HR>
  3830. <A NAME="getPassword()"><!-- --></A><H3>
  3831. getPassword</H3>
  3832. <PRE>
  3833. public final <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getPassword</B>()</PRE>
  3834. <DL>
  3835. <DD>Returns the last password that we used when connecting to an IRC server.
  3836. This does not imply that the connection attempt to the server was
  3837. successful (we suggest you look at the onConnect method).
  3838. A value of null is returned if the PircBot has never tried to connect
  3839. to a server using a password.
  3840. <P>
  3841. <DD><DL>
  3842. </DL>
  3843. </DD>
  3844. <DD><DL>
  3845. <DT><B>Returns:</B><DD>The last password that we used when connecting to an IRC server.
  3846. Returns null if we have not previously connected using a password.<DT><B>Since:</B></DT>
  3847. <DD>PircBot 0.9.9</DD>
  3848. </DL>
  3849. </DD>
  3850. </DL>
  3851. <HR>
  3852. <A NAME="longToIp(long)"><!-- --></A><H3>
  3853. longToIp</H3>
  3854. <PRE>
  3855. public int[] <B>longToIp</B>(long&nbsp;address)</PRE>
  3856. <DL>
  3857. <DD>A convenient method that accepts an IP address represented as a
  3858. long and returns an integer array of size 4 representing the same
  3859. IP address.
  3860. <P>
  3861. <DD><DL>
  3862. </DL>
  3863. </DD>
  3864. <DD><DL>
  3865. <DT><B>Parameters:</B><DD><CODE>address</CODE> - the long value representing the IP address.
  3866. <DT><B>Returns:</B><DD>An int[] of size 4.<DT><B>Since:</B></DT>
  3867. <DD>PircBot 0.9.4</DD>
  3868. </DL>
  3869. </DD>
  3870. </DL>
  3871. <HR>
  3872. <A NAME="ipToLong(byte[])"><!-- --></A><H3>
  3873. ipToLong</H3>
  3874. <PRE>
  3875. public long <B>ipToLong</B>(byte[]&nbsp;address)</PRE>
  3876. <DL>
  3877. <DD>A convenient method that accepts an IP address represented by a byte[]
  3878. of size 4 and returns this as a long representation of the same IP
  3879. address.
  3880. <P>
  3881. <DD><DL>
  3882. </DL>
  3883. </DD>
  3884. <DD><DL>
  3885. <DT><B>Parameters:</B><DD><CODE>address</CODE> - the byte[] of size 4 representing the IP address.
  3886. <DT><B>Returns:</B><DD>a long representation of the IP address.<DT><B>Since:</B></DT>
  3887. <DD>PircBot 0.9.4</DD>
  3888. </DL>
  3889. </DD>
  3890. </DL>
  3891. <HR>
  3892. <A NAME="setEncoding(java.lang.String)"><!-- --></A><H3>
  3893. setEncoding</H3>
  3894. <PRE>
  3895. public void <B>setEncoding</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;charset)
  3896. throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/UnsupportedEncodingException.html" title="class or interface in java.io">UnsupportedEncodingException</A></PRE>
  3897. <DL>
  3898. <DD>Sets the encoding charset to be used when sending or receiving lines
  3899. from the IRC server. If set to null, then the platform's default
  3900. charset is used. You should only use this method if you are
  3901. trying to send text to an IRC server in a different charset, e.g.
  3902. "GB2312" for Chinese encoding. If a PircBot is currently connected
  3903. to a server, then it must reconnect before this change takes effect.
  3904. <P>
  3905. <DD><DL>
  3906. </DL>
  3907. </DD>
  3908. <DD><DL>
  3909. <DT><B>Parameters:</B><DD><CODE>charset</CODE> - The new encoding charset to be used by PircBot.
  3910. <DT><B>Throws:</B>
  3911. <DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/UnsupportedEncodingException.html" title="class or interface in java.io">UnsupportedEncodingException</A></CODE> - If the named charset is not
  3912. supported.<DT><B>Since:</B></DT>
  3913. <DD>PircBot 1.0.4</DD>
  3914. </DL>
  3915. </DD>
  3916. </DL>
  3917. <HR>
  3918. <A NAME="getEncoding()"><!-- --></A><H3>
  3919. getEncoding</H3>
  3920. <PRE>
  3921. public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getEncoding</B>()</PRE>
  3922. <DL>
  3923. <DD>Returns the encoding used to send and receive lines from
  3924. the IRC server, or null if not set. Use the setEncoding
  3925. method to change the encoding charset.
  3926. <P>
  3927. <DD><DL>
  3928. </DL>
  3929. </DD>
  3930. <DD><DL>
  3931. <DT><B>Returns:</B><DD>The encoding used to send outgoing messages, or
  3932. null if not set.<DT><B>Since:</B></DT>
  3933. <DD>PircBot 1.0.4</DD>
  3934. </DL>
  3935. </DD>
  3936. </DL>
  3937. <HR>
  3938. <A NAME="getInetAddress()"><!-- --></A><H3>
  3939. getInetAddress</H3>
  3940. <PRE>
  3941. public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/net/InetAddress.html" title="class or interface in java.net">InetAddress</A> <B>getInetAddress</B>()</PRE>
  3942. <DL>
  3943. <DD>Returns the InetAddress used by the PircBot.
  3944. This can be used to find the I.P. address from which the PircBot is
  3945. connected to a server.
  3946. <P>
  3947. <DD><DL>
  3948. </DL>
  3949. </DD>
  3950. <DD><DL>
  3951. <DT><B>Returns:</B><DD>The current local InetAddress, or null if never connected.<DT><B>Since:</B></DT>
  3952. <DD>PircBot 1.4.4</DD>
  3953. </DL>
  3954. </DD>
  3955. </DL>
  3956. <HR>
  3957. <A NAME="setDccInetAddress(java.net.InetAddress)"><!-- --></A><H3>
  3958. setDccInetAddress</H3>
  3959. <PRE>
  3960. public void <B>setDccInetAddress</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/net/InetAddress.html" title="class or interface in java.net">InetAddress</A>&nbsp;dccInetAddress)</PRE>
  3961. <DL>
  3962. <DD>Sets the InetAddress to be used when sending DCC chat or file transfers.
  3963. This can be very useful when you are running a bot on a machine which
  3964. is behind a firewall and you need to tell receiving clients to connect
  3965. to a NAT/router, which then forwards the connection.
  3966. <P>
  3967. <DD><DL>
  3968. </DL>
  3969. </DD>
  3970. <DD><DL>
  3971. <DT><B>Parameters:</B><DD><CODE>dccInetAddress</CODE> - The new InetAddress, or null to use the default.<DT><B>Since:</B></DT>
  3972. <DD>PircBot 1.4.4</DD>
  3973. </DL>
  3974. </DD>
  3975. </DL>
  3976. <HR>
  3977. <A NAME="getDccInetAddress()"><!-- --></A><H3>
  3978. getDccInetAddress</H3>
  3979. <PRE>
  3980. public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/net/InetAddress.html" title="class or interface in java.net">InetAddress</A> <B>getDccInetAddress</B>()</PRE>
  3981. <DL>
  3982. <DD>Returns the InetAddress used when sending DCC chat or file transfers.
  3983. If this is null, the default InetAddress will be used.
  3984. <P>
  3985. <DD><DL>
  3986. </DL>
  3987. </DD>
  3988. <DD><DL>
  3989. <DT><B>Returns:</B><DD>The current DCC InetAddress, or null if left as default.<DT><B>Since:</B></DT>
  3990. <DD>PircBot 1.4.4</DD>
  3991. </DL>
  3992. </DD>
  3993. </DL>
  3994. <HR>
  3995. <A NAME="getDccPorts()"><!-- --></A><H3>
  3996. getDccPorts</H3>
  3997. <PRE>
  3998. public int[] <B>getDccPorts</B>()</PRE>
  3999. <DL>
  4000. <DD>Returns the set of port numbers to be used when sending a DCC chat
  4001. or file transfer. This is useful when you are behind a firewall and
  4002. need to set up port forwarding. The array of port numbers is traversed
  4003. in sequence until a free port is found to listen on. A DCC tranfer will
  4004. fail if all ports are already in use.
  4005. If set to null, <i>any</i> free port number will be used.
  4006. <P>
  4007. <DD><DL>
  4008. </DL>
  4009. </DD>
  4010. <DD><DL>
  4011. <DT><B>Returns:</B><DD>An array of port numbers that PircBot can use to send DCC
  4012. transfers, or null if any port is allowed.<DT><B>Since:</B></DT>
  4013. <DD>PircBot 1.4.4</DD>
  4014. </DL>
  4015. </DD>
  4016. </DL>
  4017. <HR>
  4018. <A NAME="setDccPorts(int[])"><!-- --></A><H3>
  4019. setDccPorts</H3>
  4020. <PRE>
  4021. public void <B>setDccPorts</B>(int[]&nbsp;ports)</PRE>
  4022. <DL>
  4023. <DD>Sets the choice of port numbers that can be used when sending a DCC chat
  4024. or file transfer. This is useful when you are behind a firewall and
  4025. need to set up port forwarding. The array of port numbers is traversed
  4026. in sequence until a free port is found to listen on. A DCC tranfer will
  4027. fail if all ports are already in use.
  4028. If set to null, <i>any</i> free port number will be used.
  4029. <P>
  4030. <DD><DL>
  4031. </DL>
  4032. </DD>
  4033. <DD><DL>
  4034. <DT><B>Parameters:</B><DD><CODE>ports</CODE> - The set of port numbers that PircBot may use for DCC
  4035. transfers, or null to let it use any free port (default).<DT><B>Since:</B></DT>
  4036. <DD>PircBot 1.4.4</DD>
  4037. </DL>
  4038. </DD>
  4039. </DL>
  4040. <HR>
  4041. <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
  4042. equals</H3>
  4043. <PRE>
  4044. public boolean <B>equals</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;o)</PRE>
  4045. <DL>
  4046. <DD>Returns true if and only if the object being compared is the exact
  4047. same instance as this PircBot. This may be useful if you are writing
  4048. a multiple server IRC bot that uses more than one instance of PircBot.
  4049. <P>
  4050. <DD><DL>
  4051. </DL>
  4052. </DD>
  4053. <DD><DL>
  4054. <DT><B>Returns:</B><DD>true if and only if Object o is a PircBot and equal to this.<DT><B>Since:</B></DT>
  4055. <DD>PircBot 0.9.9</DD>
  4056. </DL>
  4057. </DD>
  4058. </DL>
  4059. <HR>
  4060. <A NAME="hashCode()"><!-- --></A><H3>
  4061. hashCode</H3>
  4062. <PRE>
  4063. public int <B>hashCode</B>()</PRE>
  4064. <DL>
  4065. <DD>Returns the hashCode of this PircBot. This method can be called by hashed
  4066. collection classes and is useful for managing multiple instances of
  4067. PircBots in such collections.
  4068. <P>
  4069. <DD><DL>
  4070. </DL>
  4071. </DD>
  4072. <DD><DL>
  4073. <DT><B>Returns:</B><DD>the hash code for this instance of PircBot.<DT><B>Since:</B></DT>
  4074. <DD>PircBot 0.9.9</DD>
  4075. </DL>
  4076. </DD>
  4077. </DL>
  4078. <HR>
  4079. <A NAME="toString()"><!-- --></A><H3>
  4080. toString</H3>
  4081. <PRE>
  4082. public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
  4083. <DL>
  4084. <DD>Returns a String representation of this object.
  4085. You may find this useful for debugging purposes, particularly
  4086. if you are using more than one PircBot instance to achieve
  4087. multiple server connectivity. The format of
  4088. this String may change between different versions of PircBot
  4089. but is currently something of the form
  4090. <code>
  4091. Version{PircBot x.y.z Java IRC Bot - www.jibble.org}
  4092. Connected{true}
  4093. Server{irc.dal.net}
  4094. Port{6667}
  4095. Password{}
  4096. </code>
  4097. <P>
  4098. <DD><DL>
  4099. </DL>
  4100. </DD>
  4101. <DD><DL>
  4102. <DT><B>Returns:</B><DD>a String representation of this object.<DT><B>Since:</B></DT>
  4103. <DD>PircBot 0.9.10</DD>
  4104. </DL>
  4105. </DD>
  4106. </DL>
  4107. <HR>
  4108. <A NAME="getUsers(java.lang.String)"><!-- --></A><H3>
  4109. getUsers</H3>
  4110. <PRE>
  4111. public final <A HREF="../../../org/jibble/pircbot/User.html" title="class in org.jibble.pircbot">User</A>[] <B>getUsers</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;channel)</PRE>
  4112. <DL>
  4113. <DD>Returns an array of all users in the specified channel.
  4114. <p>
  4115. There are some important things to note about this method:-
  4116. <ul>
  4117. <li>This method may not return a full list of users if you call it
  4118. before the complete nick list has arrived from the IRC server.
  4119. </li>
  4120. <li>If you wish to find out which users are in a channel as soon
  4121. as you join it, then you should override the onUserList method
  4122. instead of calling this method, as the onUserList method is only
  4123. called as soon as the full user list has been received.
  4124. </li>
  4125. <li>This method will return immediately, as it does not require any
  4126. interaction with the IRC server.
  4127. </li>
  4128. <li>The bot must be in a channel to be able to know which users are
  4129. in it.
  4130. </li>
  4131. </ul>
  4132. <P>
  4133. <DD><DL>
  4134. </DL>
  4135. </DD>
  4136. <DD><DL>
  4137. <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The name of the channel to list.
  4138. <DT><B>Returns:</B><DD>An array of User objects. This array is empty if we are not
  4139. in the channel.<DT><B>Since:</B></DT>
  4140. <DD>PircBot 1.0.0</DD>
  4141. <DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/PircBot.html#onUserList(java.lang.String, org.jibble.pircbot.User[])"><CODE>onUserList</CODE></A></DL>
  4142. </DD>
  4143. </DL>
  4144. <HR>
  4145. <A NAME="getChannels()"><!-- --></A><H3>
  4146. getChannels</H3>
  4147. <PRE>
  4148. public final <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] <B>getChannels</B>()</PRE>
  4149. <DL>
  4150. <DD>Returns an array of all channels that we are in. Note that if you
  4151. call this method immediately after joining a new channel, the new
  4152. channel may not appear in this array as it is not possible to tell
  4153. if the join was successful until a response is received from the
  4154. IRC server.
  4155. <P>
  4156. <DD><DL>
  4157. </DL>
  4158. </DD>
  4159. <DD><DL>
  4160. <DT><B>Returns:</B><DD>A String array containing the names of all channels that we
  4161. are in.<DT><B>Since:</B></DT>
  4162. <DD>PircBot 1.0.0</DD>
  4163. </DL>
  4164. </DD>
  4165. </DL>
  4166. <HR>
  4167. <A NAME="dispose()"><!-- --></A><H3>
  4168. dispose</H3>
  4169. <PRE>
  4170. public void <B>dispose</B>()</PRE>
  4171. <DL>
  4172. <DD>Disposes of all thread resources used by this PircBot. This may be
  4173. useful when writing bots or clients that use multiple servers (and
  4174. therefore multiple PircBot instances) or when integrating a PircBot
  4175. with an existing program.
  4176. <p>
  4177. Each PircBot runs its own threads for dispatching messages from its
  4178. outgoing message queue and receiving messages from the server.
  4179. Calling dispose() ensures that these threads are
  4180. stopped, thus freeing up system resources and allowing the PircBot
  4181. object to be garbage collected if there are no other references to
  4182. it.
  4183. <p>
  4184. Once a PircBot object has been disposed, it should not be used again.
  4185. Attempting to use a PircBot that has been disposed may result in
  4186. unpredictable behaviour.
  4187. <P>
  4188. <DD><DL>
  4189. </DL>
  4190. </DD>
  4191. <DD><DL>
  4192. <DT><B>Since:</B></DT>
  4193. <DD>1.2.2</DD>
  4194. </DL>
  4195. </DD>
  4196. </DL>
  4197. <!-- ========= END OF CLASS DATA ========= -->
  4198. <HR>
  4199. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  4200. <A NAME="navbar_bottom"><!-- --></A>
  4201. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  4202. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  4203. <TR>
  4204. <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  4205. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  4206. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  4207. <TR ALIGN="center" VALIGN="top">
  4208. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  4209. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  4210. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PircBot.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  4211. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  4212. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  4213. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  4214. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  4215. </TR>
  4216. </TABLE>
  4217. </TD>
  4218. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  4219. <b>PircBot Java IRC Bot</b></EM>
  4220. </TD>
  4221. </TR>
  4222. <TR>
  4223. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  4224. &nbsp;<A HREF="../../../org/jibble/pircbot/OutputThread.html" title="class in org.jibble.pircbot"><B>PREV CLASS</B></A>&nbsp;
  4225. &nbsp;<A HREF="../../../org/jibble/pircbot/Queue.html" title="class in org.jibble.pircbot"><B>NEXT CLASS</B></A></FONT></TD>
  4226. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  4227. <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
  4228. &nbsp;<A HREF="PircBot.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  4229. &nbsp;<SCRIPT type="text/javascript">
  4230. <!--
  4231. if(window==top) {
  4232. document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  4233. }
  4234. //-->
  4235. </SCRIPT>
  4236. <NOSCRIPT>
  4237. <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  4238. </NOSCRIPT>
  4239. </FONT></TD>
  4240. </TR>
  4241. <TR>
  4242. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  4243. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  4244. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  4245. DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  4246. </TR>
  4247. </TABLE>
  4248. <A NAME="skip-navbar_bottom"></A>
  4249. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  4250. <HR>
  4251. </BODY>
  4252. </HTML>