123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560 |
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!--NewPage-->
- <HTML>
- <HEAD>
- <!-- Generated by javadoc (build 1.4.2) on Mon Dec 14 20:07:23 GMT 2009 -->
- <TITLE>
- PircBot (PircBot 1.5.0 - Java IRC API Bot Framework)
- </TITLE>
- <META NAME="keywords" CONTENT="org.jibble.pircbot.PircBot class">
- <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../pircbot-style.css" TITLE="Style">
- <SCRIPT type="text/javascript">
- function windowTitle()
- {
- parent.document.title="PircBot (PircBot 1.5.0 - Java IRC API Bot Framework)";
- }
- </SCRIPT>
- </HEAD>
- <BODY BGCOLOR="white" onload="windowTitle();">
- <!-- ========= START OF TOP NAVBAR ======= -->
- <A NAME="navbar_top"><!-- --></A>
- <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
- <TR>
- <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_top_firstrow"><!-- --></A>
- <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PircBot.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- <b>PircBot Java IRC Bot</b></EM>
- </TD>
- </TR>
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../org/jibble/pircbot/OutputThread.html" title="class in org.jibble.pircbot"><B>PREV CLASS</B></A>
- <A HREF="../../../org/jibble/pircbot/Queue.html" title="class in org.jibble.pircbot"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>
- <A HREF="PircBot.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
- if(window==top) {
- document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
- }
- //-->
- </SCRIPT>
- <NOSCRIPT>
- <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_top"></A>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <HR>
- <!-- ======== START OF CLASS DATA ======== -->
- <H2>
- <FONT SIZE="-1">
- org.jibble.pircbot</FONT>
- <BR>
- Class PircBot</H2>
- <PRE>
- <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>
- <IMG SRC="../../../resources/inherit.gif" ALT="extended by"><B>org.jibble.pircbot.PircBot</B>
- </PRE>
- <DL>
- <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../org/jibble/pircbot/ReplyConstants.html" title="interface in org.jibble.pircbot">ReplyConstants</A></DD>
- </DL>
- <HR>
- <DL>
- <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>
- <P>
- PircBot is a Java framework for writing IRC bots quickly and easily.
- <p>
- It provides an event-driven architecture to handle common IRC
- events, flood protection, DCC support, ident support, and more.
- The comprehensive logfile format is suitable for use with pisg to generate
- channel statistics.
- <p>
- Methods of the PircBot class can be called to send events to the IRC server
- that it connects to. For example, calling the sendMessage method will
- send a message to a channel or user on the IRC server. Multiple servers
- can be supported using multiple instances of PircBot.
- <p>
- To perform an action when the PircBot receives a normal message from the IRC
- server, you would override the onMessage method defined in the PircBot
- class. All on<i>XYZ</i> methods in the PircBot class are automatically called
- when the event <i>XYZ</i> happens, so you would override these if you wish
- to do something when it does happen.
- <p>
- Some event methods, such as onPing, should only really perform a specific
- function (i.e. respond to a PING from the server). For your convenience, such
- methods are already correctly implemented in the PircBot and should not
- normally need to be overridden. Please read the full documentation for each
- method to see which ones are already implemented by the PircBot class.
- <p>
- Please visit the PircBot homepage at
- <a href="http://www.jibble.org/pircbot.php">http://www.jibble.org/pircbot.php</a>
- for full revision history, a beginners guide to creating your first PircBot
- and a list of some existing Java IRC bots and clients that use the PircBot
- framework.
- <P>
- <P>
- <DL>
- <DT><B>Version:</B></DT>
- <DD>1.5.0 (Build time: Mon Dec 14 20:07:17 2009)</DD>
- <DT><B>Author:</B></DT>
- <DD>Paul James Mutton,
- <a href="http://www.jibble.org/">http://www.jibble.org/</a></DD>
- </DL>
- <HR>
- <P>
- <!-- ======== NESTED CLASS SUMMARY ======== -->
- <!-- =========== FIELD SUMMARY =========== -->
- <A NAME="field_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TD COLSPAN=2><FONT SIZE="+2">
- <B>Field Summary</B></FONT></TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static <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>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#VERSION">VERSION</A></B></CODE>
- <BR>
- The definitive version number of this release of PircBot.</TD>
- </TR>
- </TABLE>
- <A NAME="fields_inherited_from_class_org.jibble.pircbot.ReplyConstants"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
- <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>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <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>
- </TR>
- </TABLE>
-
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
- <A NAME="constructor_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TD COLSPAN=2><FONT SIZE="+2">
- <B>Constructor Summary</B></FONT></TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#PircBot()">PircBot</A></B>()</CODE>
- <BR>
- Constructs a PircBot with the default settings.</TD>
- </TR>
- </TABLE>
-
- <!-- ========== METHOD SUMMARY =========== -->
- <A NAME="method_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TD COLSPAN=2><FONT SIZE="+2">
- <B>Method Summary</B></FONT></TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostmask)</CODE>
- <BR>
- Bans a user from a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> newNick)</CODE>
- <BR>
- Attempt to change the current nick (nickname) of the bot when it
- is connected to an IRC server.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> hostname)</CODE>
- <BR>
- Attempt to connect to the specified IRC server.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> hostname,
- int port)</CODE>
- <BR>
- Attempt to connect to the specified IRC server and port number.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> hostname,
- int port,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> password)</CODE>
- <BR>
- Attempt to connect to the specified IRC server using the supplied
- password.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected <A HREF="../../../org/jibble/pircbot/DccChat.html" title="class in org.jibble.pircbot">DccChat</A></CODE></FONT></TD>
- <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> sourceNick,
- long address,
- int port)</CODE>
- <BR>
- <B>Deprecated.</B> <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>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> file,
- long address,
- int port,
- int size)</CODE>
- <BR>
- <B>Deprecated.</B> <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>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <A HREF="../../../org/jibble/pircbot/DccChat.html" title="class in org.jibble.pircbot">DccChat</A></CODE></FONT></TD>
- <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> nick,
- int timeout)</CODE>
- <BR>
- Attempts to establish a DCC CHAT session with a client.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <A HREF="../../../org/jibble/pircbot/DccFileTransfer.html" title="class in org.jibble.pircbot">DccFileTransfer</A></CODE></FONT></TD>
- <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> file,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> nick,
- int timeout)</CODE>
- <BR>
- Sends a file to another user.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> nick)</CODE>
- <BR>
- Removes operator privilidges from a user on a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> nick)</CODE>
- <BR>
- Removes voice privilidges from a user on a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#disconnect()">disconnect</A></B>()</CODE>
- <BR>
- This method disconnects from the server cleanly by calling the
- quitServer() method.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#dispose()">dispose</A></B>()</CODE>
- <BR>
- Disposes of all thread resources used by this PircBot.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <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> o)</CODE>
- <BR>
- Returns true if and only if the object being compared is the exact
- same instance as this PircBot.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <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>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getChannels()">getChannels</A></B>()</CODE>
- <BR>
- Returns an array of all channels that we are in.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <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>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getDccInetAddress()">getDccInetAddress</A></B>()</CODE>
- <BR>
- Returns the InetAddress used when sending DCC chat or file transfers.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> int[]</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getDccPorts()">getDccPorts</A></B>()</CODE>
- <BR>
- Returns the set of port numbers to be used when sending a DCC chat
- or file transfer.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <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>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getEncoding()">getEncoding</A></B>()</CODE>
- <BR>
- Returns the encoding used to send and receive lines from
- the IRC server, or null if not set.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <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>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getFinger()">getFinger</A></B>()</CODE>
- <BR>
- Gets the internal finger message of the PircBot.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <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>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getInetAddress()">getInetAddress</A></B>()</CODE>
- <BR>
- Returns the InetAddress used by the PircBot.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <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>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getLogin()">getLogin</A></B>()</CODE>
- <BR>
- Gets the internal login of the PircBot.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getMaxLineLength()">getMaxLineLength</A></B>()</CODE>
- <BR>
- Gets the maximum length of any line that is sent via the IRC protocol.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> long</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getMessageDelay()">getMessageDelay</A></B>()</CODE>
- <BR>
- Returns the number of milliseconds that will be used to separate
- consecutive messages to the server from the outgoing message queue.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <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>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getName()">getName</A></B>()</CODE>
- <BR>
- Gets the name of the PircBot.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <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>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getNick()">getNick</A></B>()</CODE>
- <BR>
- Returns the current nick of the bot.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getOutgoingQueueSize()">getOutgoingQueueSize</A></B>()</CODE>
- <BR>
- Gets the number of lines currently waiting in the outgoing message Queue.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <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>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getPassword()">getPassword</A></B>()</CODE>
- <BR>
- Returns the last password that we used when connecting to an IRC server.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getPort()">getPort</A></B>()</CODE>
- <BR>
- Returns the port number of the last IRC server that the PircBot tried
- to connect to.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <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>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getServer()">getServer</A></B>()</CODE>
- <BR>
- Returns the name of the last IRC server the PircBot tried to connect to.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <A HREF="../../../org/jibble/pircbot/User.html" title="class in org.jibble.pircbot">User</A>[]</CODE></FONT></TD>
- <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> channel)</CODE>
- <BR>
- Returns an array of all users in the specified channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <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>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#getVersion()">getVersion</A></B>()</CODE>
- <BR>
- Gets the internal version of the PircBot.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> line)</CODE>
- <BR>
- This method handles events when any line of text arrives from the server,
- then calling the appropriate method in the PircBot.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#hashCode()">hashCode</A></B>()</CODE>
- <BR>
- Returns the hashCode of this PircBot.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> password)</CODE>
- <BR>
- Identify the bot with NickServ, supplying the appropriate password.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> long</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#ipToLong(byte[])">ipToLong</A></B>(byte[] address)</CODE>
- <BR>
- A convenient method that accepts an IP address represented by a byte[]
- of size 4 and returns this as a long representation of the same IP
- address.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#isConnected()">isConnected</A></B>()</CODE>
- <BR>
- Returns whether or not the PircBot is currently connected to a server.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> channel)</CODE>
- <BR>
- Joins a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> key)</CODE>
- <BR>
- Joins a channel with a key.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> nick)</CODE>
- <BR>
- Kicks a user from a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> nick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> reason)</CODE>
- <BR>
- Kicks a user from a channel, giving a reason.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#listChannels()">listChannels</A></B>()</CODE>
- <BR>
- Issues a request for a list of all channels on the IRC server.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> parameters)</CODE>
- <BR>
- Issues a request for a list of all channels on the IRC server.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> line)</CODE>
- <BR>
- Adds a line to the log.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> int[]</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#longToIp(long)">longToIp</A></B>(long address)</CODE>
- <BR>
- A convenient method that accepts an IP address represented as a
- long and returns an integer array of size 4 representing the same
- IP address.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> sender,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> login,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> target,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> action)</CODE>
- <BR>
- This method is called whenever an ACTION is sent from a user.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- int userCount,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> topic)</CODE>
- <BR>
- After calling the listChannels() method in PircBot, the server
- will start to send us information about each channel on the
- server.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onConnect()">onConnect</A></B>()</CODE>
- <BR>
- This method is called once the PircBot has successfully connected to
- the IRC server.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- long address,
- int port)</CODE>
- <BR>
- <B>Deprecated.</B> <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>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> filename,
- long address,
- int port,
- int size)</CODE>
- <BR>
- <B>Deprecated.</B> <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>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> recipient)</CODE>
- <BR>
- Called when a user (possibly us) gets operator status taken away.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> recipient)</CODE>
- <BR>
- Called when a user (possibly us) gets voice status removed.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onDisconnect()">onDisconnect</A></B>()</CODE>
- <BR>
- This method carries out the actions to be performed when the PircBot
- gets disconnected.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> transfer,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A> e)</CODE>
- <BR>
- This method gets called when a DccFileTransfer has finished.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> target)</CODE>
- <BR>
- This method is called whenever we receive a FINGER request.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> chat)</CODE>
- <BR>
- This method will be called whenever a DCC Chat request is received.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> transfer)</CODE>
- <BR>
- This method is called whenever a DCC SEND request is sent to the PircBot.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> targetNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> channel)</CODE>
- <BR>
- Called when we are invited to a channel by a user.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sender,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> login,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostname)</CODE>
- <BR>
- This method is called whenever someone (possibly us) joins a channel
- which we are on.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> kickerNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> kickerLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> kickerHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> recipientNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> reason)</CODE>
- <BR>
- This method is called whenever someone (possibly us) is kicked from
- any of the channels that we are in.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sender,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> login,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> message)</CODE>
- <BR>
- This method is called whenever a message is sent to a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> mode)</CODE>
- <BR>
- Called when the mode of a channel is set.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> oldNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> login,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> newNick)</CODE>
- <BR>
- This method is called whenever someone (possibly us) changes nick on any
- of the channels that we are on.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> target,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> notice)</CODE>
- <BR>
- This method is called whenever we receive a notice.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> recipient)</CODE>
- <BR>
- Called when a user (possibly us) gets granted operator status for a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sender,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> login,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostname)</CODE>
- <BR>
- This method is called whenever someone (possibly us) parts a channel
- which we are on.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> target,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> pingValue)</CODE>
- <BR>
- This method is called whenever we receive a PING request from another
- user.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> sender,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> login,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> message)</CODE>
- <BR>
- This method is called whenever a private message is sent to the PircBot.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> reason)</CODE>
- <BR>
- This method is called whenever someone (possibly us) quits from the
- server.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostmask)</CODE>
- <BR>
- Called when a hostmask ban is removed from a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> key)</CODE>
- <BR>
- Called when a channel key is removed.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</CODE>
- <BR>
- Called when the user limit is removed for a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</CODE>
- <BR>
- Called when a channel has 'invite only' removed.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</CODE>
- <BR>
- Called when a channel has moderated mode removed.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</CODE>
- <BR>
- Called when a channel is set to allow messages from any user, even
- if they are not actually in the channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</CODE>
- <BR>
- Called when a channel is marked as not being in private mode.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</CODE>
- <BR>
- Called when a channel has 'secret' mode removed.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</CODE>
- <BR>
- Called when topic protection is removed for a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> response)</CODE>
- <BR>
- The actions to perform when a PING request comes from the server.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#onServerResponse(int, java.lang.String)">onServerResponse</A></B>(int code,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> response)</CODE>
- <BR>
- This method is called when we receive a numeric response from the
- IRC server.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostmask)</CODE>
- <BR>
- Called when a user (possibly us) gets banned from a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> key)</CODE>
- <BR>
- Called when a channel key is set.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- int limit)</CODE>
- <BR>
- Called when a user limit is set for a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</CODE>
- <BR>
- Called when a channel is set to 'invite only' mode.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</CODE>
- <BR>
- Called when a channel is set to 'moderated' mode.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</CODE>
- <BR>
- Called when a channel is set to only allow messages from users that
- are in the channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</CODE>
- <BR>
- Called when a channel is marked as being in private mode.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</CODE>
- <BR>
- Called when a channel is set to be in 'secret' mode.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</CODE>
- <BR>
- Called when topic protection is enabled for a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> target)</CODE>
- <BR>
- This method is called whenever we receive a TIME request.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> topic)</CODE>
- <BR>
- <B>Deprecated.</B> <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>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> topic,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> setBy,
- long date,
- boolean changed)</CODE>
- <BR>
- This method is called whenever a user sets the topic, or when
- PircBot joins a new channel and discovers its topic.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> line)</CODE>
- <BR>
- This method is called whenever we receive a line from the server that
- the PircBot has not been programmed to recognise.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="../../../org/jibble/pircbot/User.html" title="class in org.jibble.pircbot">User</A>[] users)</CODE>
- <BR>
- This method is called when we receive a user list from the server
- after joining a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> targetNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> mode)</CODE>
- <BR>
- Called when the mode of a user is set.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> target)</CODE>
- <BR>
- This method is called whenever we receive a VERSION request.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> recipient)</CODE>
- <BR>
- Called when a user (possibly us) gets voice status granted in a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> nick)</CODE>
- <BR>
- Grants operator privilidges to a user on a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> channel)</CODE>
- <BR>
- Parts a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> reason)</CODE>
- <BR>
- Parts a channel, giving a reason.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#quitServer()">quitServer</A></B>()</CODE>
- <BR>
- Quits from the IRC server.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> reason)</CODE>
- <BR>
- Quits from the IRC server with a reason.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#reconnect()">reconnect</A></B>()</CODE>
- <BR>
- Reconnects to the IRC server that we were previously connected to.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> target,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> action)</CODE>
- <BR>
- Sends an action to the channel or to a user.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> target,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> command)</CODE>
- <BR>
- Sends a CTCP command to a channel or user.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> nick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> channel)</CODE>
- <BR>
- Sends an invitation to join a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> target,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> message)</CODE>
- <BR>
- Sends a message to a channel or a private message to a user.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> target,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> notice)</CODE>
- <BR>
- Sends a notice to the channel or to a user.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> line)</CODE>
- <BR>
- Sends a raw line to the IRC server as soon as possible, bypassing the
- outgoing message queue.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> line)</CODE>
- <BR>
- Sends a raw line through the outgoing message queue.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#setAutoNickChange(boolean)">setAutoNickChange</A></B>(boolean autoNickChange)</CODE>
- <BR>
- When you connect to a server and your nick is already in use and
- this is set to true, a new nick will be automatically chosen.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> dccInetAddress)</CODE>
- <BR>
- Sets the InetAddress to be used when sending DCC chat or file transfers.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#setDccPorts(int[])">setDccPorts</A></B>(int[] ports)</CODE>
- <BR>
- Sets the choice of port numbers that can be used when sending a DCC chat
- or file transfer.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> charset)</CODE>
- <BR>
- Sets the encoding charset to be used when sending or receiving lines
- from the IRC server.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> finger)</CODE>
- <BR>
- Sets the interal finger message.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> login)</CODE>
- <BR>
- Sets the internal login of the Bot.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#setMessageDelay(long)">setMessageDelay</A></B>(long delay)</CODE>
- <BR>
- Sets the number of milliseconds to delay between consecutive
- messages when there are multiple messages waiting in the
- outgoing message queue.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> mode)</CODE>
- <BR>
- Set the mode of a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> name)</CODE>
- <BR>
- Sets the name of the bot, which will be used as its nick when it
- tries to join an IRC server.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> topic)</CODE>
- <BR>
- Set the topic for a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#setVerbose(boolean)">setVerbose</A></B>(boolean verbose)</CODE>
- <BR>
- Sets the verbose mode.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> version)</CODE>
- <BR>
- Sets the internal version of the Bot.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#startIdentServer()">startIdentServer</A></B>()</CODE>
- <BR>
- Starts an ident server (Identification Protocol Server, RFC 1413).</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <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>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/PircBot.html#toString()">toString</A></B>()</CODE>
- <BR>
- Returns a String representation of this object.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostmask)</CODE>
- <BR>
- Unbans a user from a channel.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> nick)</CODE>
- <BR>
- Grants voice privilidges to a user on a channel.</TD>
- </TR>
- </TABLE>
- <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
- <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>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <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>
- </TR>
- </TABLE>
-
- <P>
- <!-- ============ FIELD DETAIL =========== -->
- <A NAME="field_detail"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TD COLSPAN=1><FONT SIZE="+2">
- <B>Field Detail</B></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="VERSION"><!-- --></A><H3>
- VERSION</H3>
- <PRE>
- 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>
- <DL>
- <DD>The definitive version number of this release of PircBot.
- (Note: Change this before automatically building releases)
- <P>
- <DL>
- <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.jibble.pircbot.PircBot.VERSION">Constant Field Values</A></DL>
- </DL>
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <A NAME="constructor_detail"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TD COLSPAN=1><FONT SIZE="+2">
- <B>Constructor Detail</B></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="PircBot()"><!-- --></A><H3>
- PircBot</H3>
- <PRE>
- public <B>PircBot</B>()</PRE>
- <DL>
- <DD>Constructs a PircBot with the default settings. Your own constructors
- in classes which extend the PircBot abstract class should be responsible
- for changing the default settings if required.
- <P>
- </DL>
- <!-- ============ METHOD DETAIL ========== -->
- <A NAME="method_detail"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TD COLSPAN=1><FONT SIZE="+2">
- <B>Method Detail</B></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="connect(java.lang.String)"><!-- --></A><H3>
- connect</H3>
- <PRE>
- 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> hostname)
- 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>,
- <A HREF="../../../org/jibble/pircbot/IrcException.html" title="class in org.jibble.pircbot">IrcException</A>,
- <A HREF="../../../org/jibble/pircbot/NickAlreadyInUseException.html" title="class in org.jibble.pircbot">NickAlreadyInUseException</A></PRE>
- <DL>
- <DD>Attempt to connect to the specified IRC server.
- The onConnect method is called upon success.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>hostname</CODE> - The hostname of the server to connect to.
- <DT><B>Throws:</B>
- <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.
- <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.
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="connect(java.lang.String, int)"><!-- --></A><H3>
- connect</H3>
- <PRE>
- 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> hostname,
- int port)
- 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>,
- <A HREF="../../../org/jibble/pircbot/IrcException.html" title="class in org.jibble.pircbot">IrcException</A>,
- <A HREF="../../../org/jibble/pircbot/NickAlreadyInUseException.html" title="class in org.jibble.pircbot">NickAlreadyInUseException</A></PRE>
- <DL>
- <DD>Attempt to connect to the specified IRC server and port number.
- The onConnect method is called upon success.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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.
- <DT><B>Throws:</B>
- <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.
- <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.
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="connect(java.lang.String, int, java.lang.String)"><!-- --></A><H3>
- connect</H3>
- <PRE>
- 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> hostname,
- int port,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> password)
- 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>,
- <A HREF="../../../org/jibble/pircbot/IrcException.html" title="class in org.jibble.pircbot">IrcException</A>,
- <A HREF="../../../org/jibble/pircbot/NickAlreadyInUseException.html" title="class in org.jibble.pircbot">NickAlreadyInUseException</A></PRE>
- <DL>
- <DD>Attempt to connect to the specified IRC server using the supplied
- password.
- The onConnect method is called upon success.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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.
- <DT><B>Throws:</B>
- <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.
- <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.
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="reconnect()"><!-- --></A><H3>
- reconnect</H3>
- <PRE>
- public final void <B>reconnect</B>()
- 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>,
- <A HREF="../../../org/jibble/pircbot/IrcException.html" title="class in org.jibble.pircbot">IrcException</A>,
- <A HREF="../../../org/jibble/pircbot/NickAlreadyInUseException.html" title="class in org.jibble.pircbot">NickAlreadyInUseException</A></PRE>
- <DL>
- <DD>Reconnects to the IRC server that we were previously connected to.
- If necessary, the appropriate port number and password will be used.
- This method will throw an IrcException if we have never connected
- to an IRC server previously.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Throws:</B>
- <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.
- <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.
- <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>
- <DD>PircBot 0.9.9</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="disconnect()"><!-- --></A><H3>
- disconnect</H3>
- <PRE>
- public final void <B>disconnect</B>()</PRE>
- <DL>
- <DD>This method disconnects from the server cleanly by calling the
- quitServer() method. Providing the PircBot was connected to an
- IRC server, the onDisconnect() will be called as soon as the
- disconnection is made by the server.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/PircBot.html#quitServer()"><CODE>quitServer</CODE></A>,
- <A HREF="../../../org/jibble/pircbot/PircBot.html#quitServer(java.lang.String)"><CODE>quitServer</CODE></A></DL>
- </DD>
- </DL>
- <HR>
- <A NAME="setAutoNickChange(boolean)"><!-- --></A><H3>
- setAutoNickChange</H3>
- <PRE>
- public void <B>setAutoNickChange</B>(boolean autoNickChange)</PRE>
- <DL>
- <DD>When you connect to a server and your nick is already in use and
- this is set to true, a new nick will be automatically chosen.
- This is done by adding numbers to the end of the nick until an
- available nick is found.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>autoNickChange</CODE> - Set to true if you want automatic nick changes
- during connection.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="startIdentServer()"><!-- --></A><H3>
- startIdentServer</H3>
- <PRE>
- public final void <B>startIdentServer</B>()</PRE>
- <DL>
- <DD>Starts an ident server (Identification Protocol Server, RFC 1413).
- <p>
- Most IRC servers attempt to contact the ident server on connecting
- hosts in order to determine the user's identity. A few IRC servers
- will not allow you to connect unless this information is provided.
- <p>
- So when a PircBot is run on a machine that does not run an ident server,
- it may be necessary to call this method to start one up.
- <p>
- Calling this method starts up an ident server which will respond with
- the login provided by calling getLogin() and then shut down immediately.
- It will also be shut down if it has not been contacted within 60 seconds
- of creation.
- <p>
- If you require an ident response, then the correct procedure is to start
- the ident server and then connect to the IRC server. The IRC server may
- then contact the ident server to get the information it needs.
- <p>
- The ident server will fail to start if there is already an ident server
- running on port 113, or if you are running as an unprivileged user who
- is unable to create a server socket on that port number.
- <p>
- If it is essential for you to use an ident server when connecting to an
- IRC server, then make sure that port 113 on your machine is visible to
- the IRC server so that it may contact the ident server.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>PircBot 0.9c</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="joinChannel(java.lang.String)"><!-- --></A><H3>
- joinChannel</H3>
- <PRE>
- 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> channel)</PRE>
- <DL>
- <DD>Joins a channel.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The name of the channel to join (eg "#cs").</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="joinChannel(java.lang.String, java.lang.String)"><!-- --></A><H3>
- joinChannel</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> key)</PRE>
- <DL>
- <DD>Joins a channel with a key.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="partChannel(java.lang.String)"><!-- --></A><H3>
- partChannel</H3>
- <PRE>
- 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> channel)</PRE>
- <DL>
- <DD>Parts a channel.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The name of the channel to leave.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="partChannel(java.lang.String, java.lang.String)"><!-- --></A><H3>
- partChannel</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> reason)</PRE>
- <DL>
- <DD>Parts a channel, giving a reason.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="quitServer()"><!-- --></A><H3>
- quitServer</H3>
- <PRE>
- public final void <B>quitServer</B>()</PRE>
- <DL>
- <DD>Quits from the IRC server.
- Providing we are actually connected to an IRC server, the
- onDisconnect() method will be called as soon as the IRC server
- disconnects us.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="quitServer(java.lang.String)"><!-- --></A><H3>
- quitServer</H3>
- <PRE>
- 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> reason)</PRE>
- <DL>
- <DD>Quits from the IRC server with a reason.
- Providing we are actually connected to an IRC server, the
- onDisconnect() method will be called as soon as the IRC server
- disconnects us.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>reason</CODE> - The reason for quitting the server.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="sendRawLine(java.lang.String)"><!-- --></A><H3>
- sendRawLine</H3>
- <PRE>
- 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> line)</PRE>
- <DL>
- <DD>Sends a raw line to the IRC server as soon as possible, bypassing the
- outgoing message queue.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>line</CODE> - The raw line to send to the IRC server.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="sendRawLineViaQueue(java.lang.String)"><!-- --></A><H3>
- sendRawLineViaQueue</H3>
- <PRE>
- 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> line)</PRE>
- <DL>
- <DD>Sends a raw line through the outgoing message queue.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>line</CODE> - The raw line to send to the IRC server.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="sendMessage(java.lang.String, java.lang.String)"><!-- --></A><H3>
- sendMessage</H3>
- <PRE>
- 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> target,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> message)</PRE>
- <DL>
- <DD>Sends a message to a channel or a private message to a user. These
- messages are added to the outgoing message queue and sent at the
- earliest possible opportunity.
- <p>
- Some examples: -
- <pre> // Send the message "Hello!" to the channel #cs.
- sendMessage("#cs", "Hello!");
-
- // Send a private message to Paul that says "Hi".
- sendMessage("Paul", "Hi");</pre>
-
- You may optionally apply colours, boldness, underlining, etc to
- the message by using the <code>Colors</code> class.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="sendAction(java.lang.String, java.lang.String)"><!-- --></A><H3>
- sendAction</H3>
- <PRE>
- 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> target,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> action)</PRE>
- <DL>
- <DD>Sends an action to the channel or to a user.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="sendNotice(java.lang.String, java.lang.String)"><!-- --></A><H3>
- sendNotice</H3>
- <PRE>
- 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> target,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> notice)</PRE>
- <DL>
- <DD>Sends a notice to the channel or to a user.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="sendCTCPCommand(java.lang.String, java.lang.String)"><!-- --></A><H3>
- sendCTCPCommand</H3>
- <PRE>
- 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> target,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> command)</PRE>
- <DL>
- <DD>Sends a CTCP command to a channel or user. (Client to client protocol).
- Examples of such commands are "PING <number>", "FINGER", "VERSION", etc.
- For example, if you wish to request the version of a user called "Dave",
- then you would call <code>sendCTCPCommand("Dave", "VERSION");</code>.
- The type of response to such commands is largely dependant on the target
- client software.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="changeNick(java.lang.String)"><!-- --></A><H3>
- changeNick</H3>
- <PRE>
- 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> newNick)</PRE>
- <DL>
- <DD>Attempt to change the current nick (nickname) of the bot when it
- is connected to an IRC server.
- After confirmation of a successful nick change, the getNick method
- will return the new nick.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>newNick</CODE> - The new nick to use.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="identify(java.lang.String)"><!-- --></A><H3>
- identify</H3>
- <PRE>
- 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> password)</PRE>
- <DL>
- <DD>Identify the bot with NickServ, supplying the appropriate password.
- Some IRC Networks (such as freenode) require users to <i>register</i> and
- <i>identify</i> with NickServ before they are able to send private messages
- to other users, thus reducing the amount of spam. If you are using
- an IRC network where this kind of policy is enforced, you will need
- to make your bot <i>identify</i> itself to NickServ before you can send
- private messages. Assuming you have already registered your bot's
- nick with NickServ, this method can be used to <i>identify</i> with
- the supplied password. It usually makes sense to identify with NickServ
- immediately after connecting to a server.
- <p>
- This method issues a raw NICKSERV command to the server, and is therefore
- safer than the alternative approach of sending a private message to
- NickServ. The latter approach is considered dangerous, as it may cause
- you to inadvertently transmit your password to an untrusted party if you
- connect to a network which does not run a NickServ service and where the
- untrusted party has assumed the nick "NickServ". However, if your IRC
- network is only compatible with the private message approach, you may
- typically identify like so:
- <pre>sendMessage("NickServ", "identify PASSWORD");</pre>
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>password</CODE> - The password which will be used to identify with NickServ.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="setMode(java.lang.String, java.lang.String)"><!-- --></A><H3>
- setMode</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> mode)</PRE>
- <DL>
- <DD>Set the mode of a channel.
- This method attempts to set the mode of a channel. This
- may require the bot to have operator status on the channel.
- For example, if the bot has operator status, we can grant
- operator status to "Dave" on the #cs channel
- by calling setMode("#cs", "+o Dave");
- An alternative way of doing this would be to use the op method.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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
- 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>
- </DD>
- </DL>
- <HR>
- <A NAME="sendInvite(java.lang.String, java.lang.String)"><!-- --></A><H3>
- sendInvite</H3>
- <PRE>
- 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> nick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> channel)</PRE>
- <DL>
- <DD>Sends an invitation to join a channel. Some channels can be marked
- as "invite-only", so it may be useful to allow a bot to invite people
- into it.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="ban(java.lang.String, java.lang.String)"><!-- --></A><H3>
- ban</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostmask)</PRE>
- <DL>
- <DD>Bans a user from a channel. An example of a valid hostmask is
- "*!*compu@*.18hp.net". This may be used in conjunction with the
- kick method to permanently remove a user from a channel.
- Successful use of this method may require the bot to have operator
- status itself.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="unBan(java.lang.String, java.lang.String)"><!-- --></A><H3>
- unBan</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostmask)</PRE>
- <DL>
- <DD>Unbans a user from a channel. An example of a valid hostmask is
- "*!*compu@*.18hp.net".
- Successful use of this method may require the bot to have operator
- status itself.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="op(java.lang.String, java.lang.String)"><!-- --></A><H3>
- op</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> nick)</PRE>
- <DL>
- <DD>Grants operator privilidges to a user on a channel.
- Successful use of this method may require the bot to have operator
- status itself.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="deOp(java.lang.String, java.lang.String)"><!-- --></A><H3>
- deOp</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> nick)</PRE>
- <DL>
- <DD>Removes operator privilidges from a user on a channel.
- Successful use of this method may require the bot to have operator
- status itself.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="voice(java.lang.String, java.lang.String)"><!-- --></A><H3>
- voice</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> nick)</PRE>
- <DL>
- <DD>Grants voice privilidges to a user on a channel.
- Successful use of this method may require the bot to have operator
- status itself.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="deVoice(java.lang.String, java.lang.String)"><!-- --></A><H3>
- deVoice</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> nick)</PRE>
- <DL>
- <DD>Removes voice privilidges from a user on a channel.
- Successful use of this method may require the bot to have operator
- status itself.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="setTopic(java.lang.String, java.lang.String)"><!-- --></A><H3>
- setTopic</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> topic)</PRE>
- <DL>
- <DD>Set the topic for a channel.
- This method attempts to set the topic of a channel. This
- may require the bot to have operator status if the topic
- is protected.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="kick(java.lang.String, java.lang.String)"><!-- --></A><H3>
- kick</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> nick)</PRE>
- <DL>
- <DD>Kicks a user from a channel.
- This method attempts to kick a user from a channel and
- may require the bot to have operator status in the channel.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="kick(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- kick</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> nick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> reason)</PRE>
- <DL>
- <DD>Kicks a user from a channel, giving a reason.
- This method attempts to kick a user from a channel and
- may require the bot to have operator status in the channel.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="listChannels()"><!-- --></A><H3>
- listChannels</H3>
- <PRE>
- public final void <B>listChannels</B>()</PRE>
- <DL>
- <DD>Issues a request for a list of all channels on the IRC server.
- When the PircBot receives information for each channel, it will
- call the onChannelInfo method, which you will need to override
- if you want it to do anything useful.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="listChannels(java.lang.String)"><!-- --></A><H3>
- listChannels</H3>
- <PRE>
- 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> parameters)</PRE>
- <DL>
- <DD>Issues a request for a list of all channels on the IRC server.
- When the PircBot receives information for each channel, it will
- call the onChannelInfo method, which you will need to override
- if you want it to do anything useful.
- <p>
- Some IRC servers support certain parameters for LIST requests.
- One example is a parameter of ">10" to list only those channels
- that have more than 10 users in them. Whether these parameters
- are supported or not will depend on the IRC server software.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>parameters</CODE> - The parameters to supply when requesting the
- 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>
- </DD>
- </DL>
- <HR>
- <A NAME="dccSendFile(java.io.File, java.lang.String, int)"><!-- --></A><H3>
- dccSendFile</H3>
- <PRE>
- 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> file,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> nick,
- int timeout)</PRE>
- <DL>
- <DD>Sends a file to another user. Resuming is supported.
- The other user must be able to connect directly to your bot to be
- able to receive the file.
- <p>
- You may throttle the speed of this file transfer by calling the
- setPacketDelay method on the DccFileTransfer that is returned.
- <p>
- This method may not be overridden.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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
- acccept the file (we recommend about 120000).
- <DT><B>Returns:</B><DD>The DccFileTransfer that can be used to monitor this transfer.<DT><B>Since:</B></DT>
- <DD>0.9c</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/DccFileTransfer.html" title="class in org.jibble.pircbot"><CODE>DccFileTransfer</CODE></A></DL>
- </DD>
- </DL>
- <HR>
- <A NAME="dccReceiveFile(java.io.File, long, int, int)"><!-- --></A><H3>
- dccReceiveFile</H3>
- <PRE>
- 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> file,
- long address,
- int port,
- int size)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <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>
- <P>
- <DD>Receives a file that is being sent to us by a DCC SEND request.
- Please use the onIncomingFileTransfer method to receive files.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="dccSendChatRequest(java.lang.String, int)"><!-- --></A><H3>
- dccSendChatRequest</H3>
- <PRE>
- 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> nick,
- int timeout)</PRE>
- <DL>
- <DD>Attempts to establish a DCC CHAT session with a client. This method
- issues the connection request to the client and then waits for the
- client to respond. If the connection is successfully made, then a
- DccChat object is returned by this method. If the connection is not
- made within the time limit specified by the timeout value, then null
- is returned.
- <p>
- It is <b>strongly recommended</b> that you call this method within a new
- Thread, as it may take a long time to return.
- <p>
- This method may not be overridden.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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
- accept the chat connection (we recommend about 120000).
- <DT><B>Returns:</B><DD>a DccChat object that can be used to send and recieve lines of
- text. Returns <b>null</b> if the connection could not be made.<DT><B>Since:</B></DT>
- <DD>PircBot 0.9.8</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/DccChat.html" title="class in org.jibble.pircbot"><CODE>DccChat</CODE></A></DL>
- </DD>
- </DL>
- <HR>
- <A NAME="dccAcceptChatRequest(java.lang.String, long, int)"><!-- --></A><H3>
- dccAcceptChatRequest</H3>
- <PRE>
- 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> sourceNick,
- long address,
- int port)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <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>
- <P>
- <DD>Attempts to accept a DCC CHAT request by a client.
- Please use the onIncomingChatRequest method to receive files.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="log(java.lang.String)"><!-- --></A><H3>
- log</H3>
- <PRE>
- 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> line)</PRE>
- <DL>
- <DD>Adds a line to the log. This log is currently output to the standard
- output and is in the correct format for use by tools such as pisg, the
- Perl IRC Statistics Generator. You may override this method if you wish
- to do something else with log entries.
- Each line in the log begins with a number which
- represents the logging time (as the number of milliseconds since the
- epoch). This timestamp and the following log entry are separated by
- a single space character, " ". Outgoing messages are distinguishable
- by a log entry that has ">>>" immediately following the space character
- after the timestamp. DCC events use "+++" and warnings about unhandled
- Exceptions and Errors use "###".
- <p>
- This implementation of the method will only cause log entries to be
- output if the PircBot has had its verbose mode turned on by calling
- setVerbose(true);
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>line</CODE> - The line to add to the log.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="handleLine(java.lang.String)"><!-- --></A><H3>
- handleLine</H3>
- <PRE>
- 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> line)</PRE>
- <DL>
- <DD>This method handles events when any line of text arrives from the server,
- then calling the appropriate method in the PircBot. This method is
- protected and only called by the InputThread for this instance.
- <p>
- This method may not be overridden!
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>line</CODE> - The raw line of text from the server.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onConnect()"><!-- --></A><H3>
- onConnect</H3>
- <PRE>
- protected void <B>onConnect</B>()</PRE>
- <DL>
- <DD>This method is called once the PircBot has successfully connected to
- the IRC server.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>PircBot 0.9.6</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onDisconnect()"><!-- --></A><H3>
- onDisconnect</H3>
- <PRE>
- protected void <B>onDisconnect</B>()</PRE>
- <DL>
- <DD>This method carries out the actions to be performed when the PircBot
- gets disconnected. This may happen if the PircBot quits from the
- server, or if the connection is unexpectedly lost.
- <p>
- Disconnection from the IRC server is detected immediately if either
- we or the server close the connection normally. If the connection to
- the server is lost, but neither we nor the server have explicitly closed
- the connection, then it may take a few minutes to detect (this is
- commonly referred to as a "ping timeout").
- <p>
- If you wish to get your IRC bot to automatically rejoin a server after
- the connection has been lost, then this is probably the ideal method to
- override to implement such functionality.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onServerResponse(int, java.lang.String)"><!-- --></A><H3>
- onServerResponse</H3>
- <PRE>
- protected void <B>onServerResponse</B>(int code,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> response)</PRE>
- <DL>
- <DD>This method is called when we receive a numeric response from the
- IRC server.
- <p>
- Numerics in the range from 001 to 099 are used for client-server
- connections only and should never travel between servers. Replies
- generated in response to commands are found in the range from 200
- to 399. Error replies are found in the range from 400 to 599.
- <p>
- For example, we can use this method to discover the topic of a
- channel when we join it. If we join the channel #test which
- has a topic of "I am King of Test" then the response
- will be "<code>PircBot #test :I Am King of Test</code>"
- with a code of 332 to signify that this is a topic.
- (This is just an example - note that overriding the
- <code>onTopic</code> method is an easier way of finding the
- topic for a channel). Check the IRC RFC for the full list of other
- command response codes.
- <p>
- PircBot implements the interface ReplyConstants, which contains
- contstants that you may find useful here.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="onUserList(java.lang.String, org.jibble.pircbot.User[])"><!-- --></A><H3>
- onUserList</H3>
- <PRE>
- 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> channel,
- <A HREF="../../../org/jibble/pircbot/User.html" title="class in org.jibble.pircbot">User</A>[] users)</PRE>
- <DL>
- <DD>This method is called when we receive a user list from the server
- after joining a channel.
- <p>
- Shortly after joining a channel, the IRC server sends a list of all
- users in that channel. The PircBot collects this information and
- calls this method as soon as it has the full list.
- <p>
- To obtain the nick of each user in the channel, call the getNick()
- method on each User object in the array.
- <p>
- At a later time, you may call the getUsers method to obtain an
- up to date list of the users in the channel.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 1.0.0</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/User.html" title="class in org.jibble.pircbot"><CODE>User</CODE></A></DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onMessage(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onMessage</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sender,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> login,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> message)</PRE>
- <DL>
- <DD>This method is called whenever a message is sent to a channel.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="onPrivateMessage(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onPrivateMessage</H3>
- <PRE>
- 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> sender,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> login,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> message)</PRE>
- <DL>
- <DD>This method is called whenever a private message is sent to the PircBot.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="onAction(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onAction</H3>
- <PRE>
- 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> sender,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> login,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> target,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> action)</PRE>
- <DL>
- <DD>This method is called whenever an ACTION is sent from a user. E.g.
- such events generated by typing "/me goes shopping" in most IRC clients.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="onNotice(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onNotice</H3>
- <PRE>
- 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> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> target,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> notice)</PRE>
- <DL>
- <DD>This method is called whenever we receive a notice.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="onJoin(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onJoin</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sender,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> login,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostname)</PRE>
- <DL>
- <DD>This method is called whenever someone (possibly us) joins a channel
- which we are on.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="onPart(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onPart</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sender,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> login,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostname)</PRE>
- <DL>
- <DD>This method is called whenever someone (possibly us) parts a channel
- which we are on.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="onNickChange(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onNickChange</H3>
- <PRE>
- 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> oldNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> login,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> newNick)</PRE>
- <DL>
- <DD>This method is called whenever someone (possibly us) changes nick on any
- of the channels that we are on.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="onKick(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onKick</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> kickerNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> kickerLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> kickerHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> recipientNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> reason)</PRE>
- <DL>
- <DD>This method is called whenever someone (possibly us) is kicked from
- any of the channels that we are in.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="onQuit(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onQuit</H3>
- <PRE>
- 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> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> reason)</PRE>
- <DL>
- <DD>This method is called whenever someone (possibly us) quits from the
- server. We will only observe this if the user was in one of the
- channels to which we are connected.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="onTopic(java.lang.String, java.lang.String)"><!-- --></A><H3>
- onTopic</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> topic)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <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>
- <P>
- <DD>This method is called whenever a user sets the topic, or when
- PircBot joins a new channel and discovers its topic.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="onTopic(java.lang.String, java.lang.String, java.lang.String, long, boolean)"><!-- --></A><H3>
- onTopic</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> topic,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> setBy,
- long date,
- boolean changed)</PRE>
- <DL>
- <DD>This method is called whenever a user sets the topic, or when
- PircBot joins a new channel and discovers its topic.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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
- the topic was already there.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onChannelInfo(java.lang.String, int, java.lang.String)"><!-- --></A><H3>
- onChannelInfo</H3>
- <PRE>
- 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> channel,
- int userCount,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> topic)</PRE>
- <DL>
- <DD>After calling the listChannels() method in PircBot, the server
- will start to send us information about each channel on the
- server. You may override this method in order to receive the
- information about each channel as soon as it is received.
- <p>
- Note that certain channels, such as those marked as hidden,
- may not appear in channel listings.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="onMode(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onMode</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> mode)</PRE>
- <DL>
- <DD>Called when the mode of a channel is set.
- <p>
- You may find it more convenient to decode the meaning of the mode
- string by overriding the onOp, onDeOp, onVoice, onDeVoice,
- onChannelKey, onDeChannelKey, onChannelLimit, onDeChannelLimit,
- onChannelBan or onDeChannelBan methods as appropriate.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="onUserMode(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onUserMode</H3>
- <PRE>
- 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> targetNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> mode)</PRE>
- <DL>
- <DD>Called when the mode of a user is set.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 1.2.0</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onOp(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onOp</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> recipient)</PRE>
- <DL>
- <DD>Called when a user (possibly us) gets granted operator status for a channel.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onDeop(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onDeop</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> recipient)</PRE>
- <DL>
- <DD>Called when a user (possibly us) gets operator status taken away.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onVoice(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onVoice</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> recipient)</PRE>
- <DL>
- <DD>Called when a user (possibly us) gets voice status granted in a channel.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onDeVoice(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onDeVoice</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> recipient)</PRE>
- <DL>
- <DD>Called when a user (possibly us) gets voice status removed.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onSetChannelKey(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onSetChannelKey</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> key)</PRE>
- <DL>
- <DD>Called when a channel key is set. When the channel key has been set,
- other users may only join that channel if they know the key. Channel keys
- are sometimes referred to as passwords.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onRemoveChannelKey(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onRemoveChannelKey</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> key)</PRE>
- <DL>
- <DD>Called when a channel key is removed.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onSetChannelLimit(java.lang.String, java.lang.String, java.lang.String, java.lang.String, int)"><!-- --></A><H3>
- onSetChannelLimit</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- int limit)</PRE>
- <DL>
- <DD>Called when a user limit is set for a channel. The number of users in
- the channel cannot exceed this limit.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onRemoveChannelLimit(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onRemoveChannelLimit</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</PRE>
- <DL>
- <DD>Called when the user limit is removed for a channel.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onSetChannelBan(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onSetChannelBan</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostmask)</PRE>
- <DL>
- <DD>Called when a user (possibly us) gets banned from a channel. Being
- banned from a channel prevents any user with a matching hostmask from
- joining the channel. For this reason, most bans are usually directly
- followed by the user being kicked :-)
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onRemoveChannelBan(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onRemoveChannelBan</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> hostmask)</PRE>
- <DL>
- <DD>Called when a hostmask ban is removed from a channel.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onSetTopicProtection(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onSetTopicProtection</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</PRE>
- <DL>
- <DD>Called when topic protection is enabled for a channel. Topic protection
- means that only operators in a channel may change the topic.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onRemoveTopicProtection(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onRemoveTopicProtection</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</PRE>
- <DL>
- <DD>Called when topic protection is removed for a channel.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onSetNoExternalMessages(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onSetNoExternalMessages</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</PRE>
- <DL>
- <DD>Called when a channel is set to only allow messages from users that
- are in the channel.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onRemoveNoExternalMessages(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onRemoveNoExternalMessages</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</PRE>
- <DL>
- <DD>Called when a channel is set to allow messages from any user, even
- if they are not actually in the channel.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onSetInviteOnly(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onSetInviteOnly</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</PRE>
- <DL>
- <DD>Called when a channel is set to 'invite only' mode. A user may only
- join the channel if they are invited by someone who is already in the
- channel.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onRemoveInviteOnly(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onRemoveInviteOnly</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</PRE>
- <DL>
- <DD>Called when a channel has 'invite only' removed.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onSetModerated(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onSetModerated</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</PRE>
- <DL>
- <DD>Called when a channel is set to 'moderated' mode. If a channel is
- moderated, then only users who have been 'voiced' or 'opped' may speak
- or change their nicks.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onRemoveModerated(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onRemoveModerated</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</PRE>
- <DL>
- <DD>Called when a channel has moderated mode removed.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onSetPrivate(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onSetPrivate</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</PRE>
- <DL>
- <DD>Called when a channel is marked as being in private mode.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onRemovePrivate(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onRemovePrivate</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</PRE>
- <DL>
- <DD>Called when a channel is marked as not being in private mode.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onSetSecret(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onSetSecret</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</PRE>
- <DL>
- <DD>Called when a channel is set to be in 'secret' mode. Such channels
- typically do not appear on a server's channel listing.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onRemoveSecret(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onRemoveSecret</H3>
- <PRE>
- 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> channel,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname)</PRE>
- <DL>
- <DD>Called when a channel has 'secret' mode removed.
- <p>
- This is a type of mode change and is also passed to the onMode
- method in the PircBot class.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onInvite(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onInvite</H3>
- <PRE>
- 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> targetNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> channel)</PRE>
- <DL>
- <DD>Called when we are invited to a channel by a user.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- <DD>PircBot 0.9.5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onDccSendRequest(java.lang.String, java.lang.String, java.lang.String, java.lang.String, long, int, int)"><!-- --></A><H3>
- onDccSendRequest</H3>
- <PRE>
- 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> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> filename,
- long address,
- int port,
- int size)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <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>
- <P>
- <DD>This method used to be called when a DCC SEND request was sent to the PircBot.
- Please use the onIncomingFileTransfer method to receive files, as it
- has better functionality and supports resuming.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onDccChatRequest(java.lang.String, java.lang.String, java.lang.String, long, int)"><!-- --></A><H3>
- onDccChatRequest</H3>
- <PRE>
- 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> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- long address,
- int port)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <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>
- <P>
- <DD>This method used to be called when a DCC CHAT request was sent to the PircBot.
- Please use the onIncomingChatRequest method to accept chats, as it
- has better functionality.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onIncomingFileTransfer(org.jibble.pircbot.DccFileTransfer)"><!-- --></A><H3>
- onIncomingFileTransfer</H3>
- <PRE>
- protected void <B>onIncomingFileTransfer</B>(<A HREF="../../../org/jibble/pircbot/DccFileTransfer.html" title="class in org.jibble.pircbot">DccFileTransfer</A> transfer)</PRE>
- <DL>
- <DD>This method is called whenever a DCC SEND request is sent to the PircBot.
- This means that a client has requested to send a file to us.
- This abstract implementation performs no action, which means that all
- DCC SEND requests will be ignored by default. If you wish to receive
- the file, then you may override this method and call the receive method
- on the DccFileTransfer object, which connects to the sender and downloads
- the file.
- <p>
- Example:
- <pre> public void onIncomingFileTransfer(DccFileTransfer transfer) {
- // Use the suggested file name.
- File file = transfer.getFile();
- // Receive the transfer and save it to the file, allowing resuming.
- transfer.receive(file, true);
- }</pre>
- <p>
- <b>Warning:</b> Receiving an incoming file transfer will cause a file
- to be written to disk. Please ensure that you make adequate security
- checks so that this file does not overwrite anything important!
- <p>
- Each time a file is received, it happens within a new Thread
- in order to allow multiple files to be downloaded by the PircBot
- at the same time.
- <p>
- If you allow resuming and the file already partly exists, it will
- be appended to instead of overwritten. If resuming is not enabled,
- the file will be overwritten if it already exists.
- <p>
- You can throttle the speed of the transfer by calling the setPacketDelay
- method on the DccFileTransfer object, either before you receive the
- file or at any moment during the transfer.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>transfer</CODE> - The DcccFileTransfer that you may accept.<DT><B>Since:</B></DT>
- <DD>PircBot 1.2.0</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/DccFileTransfer.html" title="class in org.jibble.pircbot"><CODE>DccFileTransfer</CODE></A></DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onFileTransferFinished(org.jibble.pircbot.DccFileTransfer, java.lang.Exception)"><!-- --></A><H3>
- onFileTransferFinished</H3>
- <PRE>
- protected void <B>onFileTransferFinished</B>(<A HREF="../../../org/jibble/pircbot/DccFileTransfer.html" title="class in org.jibble.pircbot">DccFileTransfer</A> transfer,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A> e)</PRE>
- <DL>
- <DD>This method gets called when a DccFileTransfer has finished.
- If there was a problem, the Exception will say what went wrong.
- If the file was sent successfully, the Exception will be null.
- <p>
- Both incoming and outgoing file transfers are passed to this method.
- You can determine the type by calling the isIncoming or isOutgoing
- methods on the DccFileTransfer object.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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
- will report what went wrong.<DT><B>Since:</B></DT>
- <DD>PircBot 1.2.0</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/DccFileTransfer.html" title="class in org.jibble.pircbot"><CODE>DccFileTransfer</CODE></A></DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onIncomingChatRequest(org.jibble.pircbot.DccChat)"><!-- --></A><H3>
- onIncomingChatRequest</H3>
- <PRE>
- protected void <B>onIncomingChatRequest</B>(<A HREF="../../../org/jibble/pircbot/DccChat.html" title="class in org.jibble.pircbot">DccChat</A> chat)</PRE>
- <DL>
- <DD>This method will be called whenever a DCC Chat request is received.
- This means that a client has requested to chat to us directly rather
- than via the IRC server. This is useful for sending many lines of text
- to and from the bot without having to worry about flooding the server
- or any operators of the server being able to "spy" on what is being
- said. This abstract implementation performs no action, which means
- that all DCC CHAT requests will be ignored by default.
- <p>
- If you wish to accept the connection, then you may override this
- method and call the accept() method on the DccChat object, which
- connects to the sender of the chat request and allows lines to be
- sent to and from the bot.
- <p>
- Your bot must be able to connect directly to the user that sent the
- request.
- <p>
- Example:
- <pre> public void onIncomingChatRequest(DccChat chat) {
- try {
- // Accept all chat, whoever it's from.
- chat.accept();
- chat.sendLine("Hello");
- String response = chat.readLine();
- chat.close();
- }
- catch (IOException e) {}
- }</pre>
-
- Each time this method is called, it is called from within a new Thread
- so that multiple DCC CHAT sessions can run concurrently.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>chat</CODE> - A DccChat object that represents the incoming chat request.<DT><B>Since:</B></DT>
- <DD>PircBot 1.2.0</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../org/jibble/pircbot/DccChat.html" title="class in org.jibble.pircbot"><CODE>DccChat</CODE></A></DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onVersion(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onVersion</H3>
- <PRE>
- 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> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> target)</PRE>
- <DL>
- <DD>This method is called whenever we receive a VERSION request.
- This abstract implementation responds with the PircBot's _version string,
- so if you override this method, be sure to either mimic its functionality
- or to call super.onVersion(...);
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="onPing(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onPing</H3>
- <PRE>
- 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> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> target,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> pingValue)</PRE>
- <DL>
- <DD>This method is called whenever we receive a PING request from another
- user.
- <p>
- This abstract implementation responds correctly, so if you override this
- method, be sure to either mimic its functionality or to call
- super.onPing(...);
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="onServerPing(java.lang.String)"><!-- --></A><H3>
- onServerPing</H3>
- <PRE>
- 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> response)</PRE>
- <DL>
- <DD>The actions to perform when a PING request comes from the server.
- <p>
- This sends back a correct response, so if you override this method,
- be sure to either mimic its functionality or to call
- super.onServerPing(response);
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>response</CODE> - The response that should be given back in your PONG.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="onTime(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onTime</H3>
- <PRE>
- 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> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> target)</PRE>
- <DL>
- <DD>This method is called whenever we receive a TIME request.
- <p>
- This abstract implementation responds correctly, so if you override this
- method, be sure to either mimic its functionality or to call
- super.onTime(...);
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="onFinger(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
- onFinger</H3>
- <PRE>
- 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> sourceNick,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceLogin,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sourceHostname,
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> target)</PRE>
- <DL>
- <DD>This method is called whenever we receive a FINGER request.
- <p>
- This abstract implementation responds correctly, so if you override this
- method, be sure to either mimic its functionality or to call
- super.onFinger(...);
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="onUnknown(java.lang.String)"><!-- --></A><H3>
- onUnknown</H3>
- <PRE>
- 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> line)</PRE>
- <DL>
- <DD>This method is called whenever we receive a line from the server that
- the PircBot has not been programmed to recognise.
- <p>
- The implementation of this method in the PircBot abstract class
- performs no actions and may be overridden as required.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>line</CODE> - The raw line that was received from the server.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="setVerbose(boolean)"><!-- --></A><H3>
- setVerbose</H3>
- <PRE>
- public final void <B>setVerbose</B>(boolean verbose)</PRE>
- <DL>
- <DD>Sets the verbose mode. If verbose mode is set to true, then log entries
- will be printed to the standard output. The default value is false and
- will result in no output. For general development, we strongly recommend
- setting the verbose mode to true.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>verbose</CODE> - true if verbose mode is to be used. Default is false.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="setName(java.lang.String)"><!-- --></A><H3>
- setName</H3>
- <PRE>
- 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> name)</PRE>
- <DL>
- <DD>Sets the name of the bot, which will be used as its nick when it
- tries to join an IRC server. This should be set before joining
- any servers, otherwise the default nick will be used. You would
- typically call this method from the constructor of the class that
- extends PircBot.
- <p>
- The changeNick method should be used if you wish to change your nick
- when you are connected to a server.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>name</CODE> - The new name of the Bot.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="setLogin(java.lang.String)"><!-- --></A><H3>
- setLogin</H3>
- <PRE>
- 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> login)</PRE>
- <DL>
- <DD>Sets the internal login of the Bot. This should be set before joining
- any servers.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>login</CODE> - The new login of the Bot.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="setVersion(java.lang.String)"><!-- --></A><H3>
- setVersion</H3>
- <PRE>
- 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> version)</PRE>
- <DL>
- <DD>Sets the internal version of the Bot. This should be set before joining
- any servers.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>version</CODE> - The new version of the Bot.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="setFinger(java.lang.String)"><!-- --></A><H3>
- setFinger</H3>
- <PRE>
- 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> finger)</PRE>
- <DL>
- <DD>Sets the interal finger message. This should be set before joining
- any servers.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>finger</CODE> - The new finger message for the Bot.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getName()"><!-- --></A><H3>
- getName</H3>
- <PRE>
- 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>
- <DL>
- <DD>Gets the name of the PircBot. This is the name that will be used as
- as a nick when we try to join servers.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>The name of the PircBot.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getNick()"><!-- --></A><H3>
- getNick</H3>
- <PRE>
- 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>
- <DL>
- <DD>Returns the current nick of the bot. Note that if you have just changed
- your nick, this method will still return the old nick until confirmation
- of the nick change is received from the server.
- <p>
- The nick returned by this method is maintained only by the PircBot
- class and is guaranteed to be correct in the context of the IRC server.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>The current nick of the bot.<DT><B>Since:</B></DT>
- <DD>PircBot 1.0.0</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getLogin()"><!-- --></A><H3>
- getLogin</H3>
- <PRE>
- 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>
- <DL>
- <DD>Gets the internal login of the PircBot.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>The login of the PircBot.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getVersion()"><!-- --></A><H3>
- getVersion</H3>
- <PRE>
- 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>
- <DL>
- <DD>Gets the internal version of the PircBot.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>The version of the PircBot.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getFinger()"><!-- --></A><H3>
- getFinger</H3>
- <PRE>
- 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>
- <DL>
- <DD>Gets the internal finger message of the PircBot.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>The finger message of the PircBot.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="isConnected()"><!-- --></A><H3>
- isConnected</H3>
- <PRE>
- public final boolean <B>isConnected</B>()</PRE>
- <DL>
- <DD>Returns whether or not the PircBot is currently connected to a server.
- The result of this method should only act as a rough guide,
- as the result may not be valid by the time you act upon it.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>True if and only if the PircBot is currently connected to a server.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="setMessageDelay(long)"><!-- --></A><H3>
- setMessageDelay</H3>
- <PRE>
- public final void <B>setMessageDelay</B>(long delay)</PRE>
- <DL>
- <DD>Sets the number of milliseconds to delay between consecutive
- messages when there are multiple messages waiting in the
- outgoing message queue. This has a default value of 1000ms.
- It is a good idea to stick to this default value, as it will
- prevent your bot from spamming servers and facing the subsequent
- wrath! However, if you do need to change this delay value (<b>not
- recommended</b>), then this is the method to use.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>delay</CODE> - The number of milliseconds between each outgoing message.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getMessageDelay()"><!-- --></A><H3>
- getMessageDelay</H3>
- <PRE>
- public final long <B>getMessageDelay</B>()</PRE>
- <DL>
- <DD>Returns the number of milliseconds that will be used to separate
- consecutive messages to the server from the outgoing message queue.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>Number of milliseconds.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getMaxLineLength()"><!-- --></A><H3>
- getMaxLineLength</H3>
- <PRE>
- public final int <B>getMaxLineLength</B>()</PRE>
- <DL>
- <DD>Gets the maximum length of any line that is sent via the IRC protocol.
- The IRC RFC specifies that line lengths, including the trailing \r\n
- must not exceed 512 bytes. Hence, there is currently no option to
- change this value in PircBot. All lines greater than this length
- will be truncated before being sent to the IRC server.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>The maximum line length (currently fixed at 512)</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getOutgoingQueueSize()"><!-- --></A><H3>
- getOutgoingQueueSize</H3>
- <PRE>
- public final int <B>getOutgoingQueueSize</B>()</PRE>
- <DL>
- <DD>Gets the number of lines currently waiting in the outgoing message Queue.
- If this returns 0, then the Queue is empty and any new message is likely
- to be sent to the IRC server immediately.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>The number of lines in the outgoing message Queue.<DT><B>Since:</B></DT>
- <DD>PircBot 0.9.9</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getServer()"><!-- --></A><H3>
- getServer</H3>
- <PRE>
- 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>
- <DL>
- <DD>Returns the name of the last IRC server the PircBot tried to connect to.
- This does not imply that the connection attempt to the server was
- successful (we suggest you look at the onConnect method).
- A value of null is returned if the PircBot has never tried to connect
- to a server.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>The name of the last machine we tried to connect to. Returns
- null if no connection attempts have ever been made.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getPort()"><!-- --></A><H3>
- getPort</H3>
- <PRE>
- public final int <B>getPort</B>()</PRE>
- <DL>
- <DD>Returns the port number of the last IRC server that the PircBot tried
- to connect to.
- This does not imply that the connection attempt to the server was
- successful (we suggest you look at the onConnect method).
- A value of -1 is returned if the PircBot has never tried to connect
- to a server.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>The port number of the last IRC server we connected to.
- Returns -1 if no connection attempts have ever been made.<DT><B>Since:</B></DT>
- <DD>PircBot 0.9.9</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getPassword()"><!-- --></A><H3>
- getPassword</H3>
- <PRE>
- 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>
- <DL>
- <DD>Returns the last password that we used when connecting to an IRC server.
- This does not imply that the connection attempt to the server was
- successful (we suggest you look at the onConnect method).
- A value of null is returned if the PircBot has never tried to connect
- to a server using a password.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>The last password that we used when connecting to an IRC server.
- Returns null if we have not previously connected using a password.<DT><B>Since:</B></DT>
- <DD>PircBot 0.9.9</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="longToIp(long)"><!-- --></A><H3>
- longToIp</H3>
- <PRE>
- public int[] <B>longToIp</B>(long address)</PRE>
- <DL>
- <DD>A convenient method that accepts an IP address represented as a
- long and returns an integer array of size 4 representing the same
- IP address.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>address</CODE> - the long value representing the IP address.
- <DT><B>Returns:</B><DD>An int[] of size 4.<DT><B>Since:</B></DT>
- <DD>PircBot 0.9.4</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="ipToLong(byte[])"><!-- --></A><H3>
- ipToLong</H3>
- <PRE>
- public long <B>ipToLong</B>(byte[] address)</PRE>
- <DL>
- <DD>A convenient method that accepts an IP address represented by a byte[]
- of size 4 and returns this as a long representation of the same IP
- address.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>address</CODE> - the byte[] of size 4 representing the IP address.
- <DT><B>Returns:</B><DD>a long representation of the IP address.<DT><B>Since:</B></DT>
- <DD>PircBot 0.9.4</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="setEncoding(java.lang.String)"><!-- --></A><H3>
- setEncoding</H3>
- <PRE>
- 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> charset)
- 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>
- <DL>
- <DD>Sets the encoding charset to be used when sending or receiving lines
- from the IRC server. If set to null, then the platform's default
- charset is used. You should only use this method if you are
- trying to send text to an IRC server in a different charset, e.g.
- "GB2312" for Chinese encoding. If a PircBot is currently connected
- to a server, then it must reconnect before this change takes effect.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>charset</CODE> - The new encoding charset to be used by PircBot.
- <DT><B>Throws:</B>
- <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
- supported.<DT><B>Since:</B></DT>
- <DD>PircBot 1.0.4</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getEncoding()"><!-- --></A><H3>
- getEncoding</H3>
- <PRE>
- 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>
- <DL>
- <DD>Returns the encoding used to send and receive lines from
- the IRC server, or null if not set. Use the setEncoding
- method to change the encoding charset.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>The encoding used to send outgoing messages, or
- null if not set.<DT><B>Since:</B></DT>
- <DD>PircBot 1.0.4</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getInetAddress()"><!-- --></A><H3>
- getInetAddress</H3>
- <PRE>
- 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>
- <DL>
- <DD>Returns the InetAddress used by the PircBot.
- This can be used to find the I.P. address from which the PircBot is
- connected to a server.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>The current local InetAddress, or null if never connected.<DT><B>Since:</B></DT>
- <DD>PircBot 1.4.4</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="setDccInetAddress(java.net.InetAddress)"><!-- --></A><H3>
- setDccInetAddress</H3>
- <PRE>
- 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> dccInetAddress)</PRE>
- <DL>
- <DD>Sets the InetAddress to be used when sending DCC chat or file transfers.
- This can be very useful when you are running a bot on a machine which
- is behind a firewall and you need to tell receiving clients to connect
- to a NAT/router, which then forwards the connection.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>dccInetAddress</CODE> - The new InetAddress, or null to use the default.<DT><B>Since:</B></DT>
- <DD>PircBot 1.4.4</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getDccInetAddress()"><!-- --></A><H3>
- getDccInetAddress</H3>
- <PRE>
- 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>
- <DL>
- <DD>Returns the InetAddress used when sending DCC chat or file transfers.
- If this is null, the default InetAddress will be used.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>The current DCC InetAddress, or null if left as default.<DT><B>Since:</B></DT>
- <DD>PircBot 1.4.4</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getDccPorts()"><!-- --></A><H3>
- getDccPorts</H3>
- <PRE>
- public int[] <B>getDccPorts</B>()</PRE>
- <DL>
- <DD>Returns the set of port numbers to be used when sending a DCC chat
- or file transfer. This is useful when you are behind a firewall and
- need to set up port forwarding. The array of port numbers is traversed
- in sequence until a free port is found to listen on. A DCC tranfer will
- fail if all ports are already in use.
- If set to null, <i>any</i> free port number will be used.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>An array of port numbers that PircBot can use to send DCC
- transfers, or null if any port is allowed.<DT><B>Since:</B></DT>
- <DD>PircBot 1.4.4</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="setDccPorts(int[])"><!-- --></A><H3>
- setDccPorts</H3>
- <PRE>
- public void <B>setDccPorts</B>(int[] ports)</PRE>
- <DL>
- <DD>Sets the choice of port numbers that can be used when sending a DCC chat
- or file transfer. This is useful when you are behind a firewall and
- need to set up port forwarding. The array of port numbers is traversed
- in sequence until a free port is found to listen on. A DCC tranfer will
- fail if all ports are already in use.
- If set to null, <i>any</i> free port number will be used.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>ports</CODE> - The set of port numbers that PircBot may use for DCC
- transfers, or null to let it use any free port (default).<DT><B>Since:</B></DT>
- <DD>PircBot 1.4.4</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
- equals</H3>
- <PRE>
- 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> o)</PRE>
- <DL>
- <DD>Returns true if and only if the object being compared is the exact
- same instance as this PircBot. This may be useful if you are writing
- a multiple server IRC bot that uses more than one instance of PircBot.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>true if and only if Object o is a PircBot and equal to this.<DT><B>Since:</B></DT>
- <DD>PircBot 0.9.9</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="hashCode()"><!-- --></A><H3>
- hashCode</H3>
- <PRE>
- public int <B>hashCode</B>()</PRE>
- <DL>
- <DD>Returns the hashCode of this PircBot. This method can be called by hashed
- collection classes and is useful for managing multiple instances of
- PircBots in such collections.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>the hash code for this instance of PircBot.<DT><B>Since:</B></DT>
- <DD>PircBot 0.9.9</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="toString()"><!-- --></A><H3>
- toString</H3>
- <PRE>
- 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>
- <DL>
- <DD>Returns a String representation of this object.
- You may find this useful for debugging purposes, particularly
- if you are using more than one PircBot instance to achieve
- multiple server connectivity. The format of
- this String may change between different versions of PircBot
- but is currently something of the form
- <code>
- Version{PircBot x.y.z Java IRC Bot - www.jibble.org}
- Connected{true}
- Server{irc.dal.net}
- Port{6667}
- Password{}
- </code>
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>a String representation of this object.<DT><B>Since:</B></DT>
- <DD>PircBot 0.9.10</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getUsers(java.lang.String)"><!-- --></A><H3>
- getUsers</H3>
- <PRE>
- 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> channel)</PRE>
- <DL>
- <DD>Returns an array of all users in the specified channel.
- <p>
- There are some important things to note about this method:-
- <ul>
- <li>This method may not return a full list of users if you call it
- before the complete nick list has arrived from the IRC server.
- </li>
- <li>If you wish to find out which users are in a channel as soon
- as you join it, then you should override the onUserList method
- instead of calling this method, as the onUserList method is only
- called as soon as the full user list has been received.
- </li>
- <li>This method will return immediately, as it does not require any
- interaction with the IRC server.
- </li>
- <li>The bot must be in a channel to be able to know which users are
- in it.
- </li>
- </ul>
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>channel</CODE> - The name of the channel to list.
- <DT><B>Returns:</B><DD>An array of User objects. This array is empty if we are not
- in the channel.<DT><B>Since:</B></DT>
- <DD>PircBot 1.0.0</DD>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="getChannels()"><!-- --></A><H3>
- getChannels</H3>
- <PRE>
- 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>
- <DL>
- <DD>Returns an array of all channels that we are in. Note that if you
- call this method immediately after joining a new channel, the new
- channel may not appear in this array as it is not possible to tell
- if the join was successful until a response is received from the
- IRC server.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Returns:</B><DD>A String array containing the names of all channels that we
- are in.<DT><B>Since:</B></DT>
- <DD>PircBot 1.0.0</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="dispose()"><!-- --></A><H3>
- dispose</H3>
- <PRE>
- public void <B>dispose</B>()</PRE>
- <DL>
- <DD>Disposes of all thread resources used by this PircBot. This may be
- useful when writing bots or clients that use multiple servers (and
- therefore multiple PircBot instances) or when integrating a PircBot
- with an existing program.
- <p>
- Each PircBot runs its own threads for dispatching messages from its
- outgoing message queue and receiving messages from the server.
- Calling dispose() ensures that these threads are
- stopped, thus freeing up system resources and allowing the PircBot
- object to be garbage collected if there are no other references to
- it.
- <p>
- Once a PircBot object has been disposed, it should not be used again.
- Attempting to use a PircBot that has been disposed may result in
- unpredictable behaviour.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>1.2.2</DD>
- </DL>
- </DD>
- </DL>
- <!-- ========= END OF CLASS DATA ========= -->
- <HR>
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <A NAME="navbar_bottom"><!-- --></A>
- <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
- <TR>
- <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_bottom_firstrow"><!-- --></A>
- <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PircBot.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- <b>PircBot Java IRC Bot</b></EM>
- </TD>
- </TR>
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../org/jibble/pircbot/OutputThread.html" title="class in org.jibble.pircbot"><B>PREV CLASS</B></A>
- <A HREF="../../../org/jibble/pircbot/Queue.html" title="class in org.jibble.pircbot"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>
- <A HREF="PircBot.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
- if(window==top) {
- document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
- }
- //-->
- </SCRIPT>
- <NOSCRIPT>
- <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_bottom"></A>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- <HR>
- </BODY>
- </HTML>
|