Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Network.IRC.IrcNetworkManager.html

eric6/Documentation/Source/eric6.Network.IRC.IrcNetworkManager.html

changeset 7989
a21d673a8f99
parent 7273
391d6b7b1eff
child 8215
fc5d68a6889e
equal deleted inserted replaced
7988:c4c17121eff8 7989:a21d673a8f99
143 143
144 <p> 144 <p>
145 Public method to check the auto join status. 145 Public method to check the auto join status.
146 </p> 146 </p>
147 <dl> 147 <dl>
148 <dt>Returns:</dt> 148 <dt>Return:</dt>
149 <dd> 149 <dd>
150 flag indicating if the channel should be 150 flag indicating if the channel should be
151 joined automatically (boolean) 151 joined automatically (boolean)
152 </dd> 152 </dd>
153 </dl> 153 </dl>
157 157
158 <p> 158 <p>
159 Public method to get the channel key. 159 Public method to get the channel key.
160 </p> 160 </p>
161 <dl> 161 <dl>
162 <dt>Returns:</dt> 162 <dt>Return:</dt>
163 <dd> 163 <dd>
164 channel key (string) 164 channel key (string)
165 </dd> 165 </dd>
166 </dl> 166 </dl>
167 <a NAME="IrcChannel.getName" ID="IrcChannel.getName"></a> 167 <a NAME="IrcChannel.getName" ID="IrcChannel.getName"></a>
170 170
171 <p> 171 <p>
172 Public method to get the channel name. 172 Public method to get the channel name.
173 </p> 173 </p>
174 <dl> 174 <dl>
175 <dt>Returns:</dt> 175 <dt>Return:</dt>
176 <dd> 176 <dd>
177 channel name (string) 177 channel name (string)
178 </dd> 178 </dd>
179 </dl> 179 </dl>
180 <a NAME="IrcChannel.load" ID="IrcChannel.load"></a> 180 <a NAME="IrcChannel.load" ID="IrcChannel.load"></a>
368 368
369 <p> 369 <p>
370 Class method to create the default identity. 370 Class method to create the default identity.
371 </p> 371 </p>
372 <dl> 372 <dl>
373 <dt>Returns:</dt> 373 <dt>Return:</dt>
374 <dd> 374 <dd>
375 default identity (IrcIdentity) 375 default identity (IrcIdentity)
376 </dd> 376 </dd>
377 </dl> 377 </dl>
378 <a NAME="IrcIdentity.__init__" ID="IrcIdentity.__init__"></a> 378 <a NAME="IrcIdentity.__init__" ID="IrcIdentity.__init__"></a>
395 395
396 <p> 396 <p>
397 Public method to get the AWAY message. 397 Public method to get the AWAY message.
398 </p> 398 </p>
399 <dl> 399 <dl>
400 <dt>Returns:</dt> 400 <dt>Return:</dt>
401 <dd> 401 <dd>
402 AWAY message (string) 402 AWAY message (string)
403 </dd> 403 </dd>
404 </dl> 404 </dl>
405 <a NAME="IrcIdentity.getIdent" ID="IrcIdentity.getIdent"></a> 405 <a NAME="IrcIdentity.getIdent" ID="IrcIdentity.getIdent"></a>
408 408
409 <p> 409 <p>
410 Public method to get the real identity name. 410 Public method to get the real identity name.
411 </p> 411 </p>
412 <dl> 412 <dl>
413 <dt>Returns:</dt> 413 <dt>Return:</dt>
414 <dd> 414 <dd>
415 real identity name (string) 415 real identity name (string)
416 </dd> 416 </dd>
417 </dl> 417 </dl>
418 <a NAME="IrcIdentity.getName" ID="IrcIdentity.getName"></a> 418 <a NAME="IrcIdentity.getName" ID="IrcIdentity.getName"></a>
421 421
422 <p> 422 <p>
423 Public method to get the identity name. 423 Public method to get the identity name.
424 </p> 424 </p>
425 <dl> 425 <dl>
426 <dt>Returns:</dt> 426 <dt>Return:</dt>
427 <dd> 427 <dd>
428 identity name (string) 428 identity name (string)
429 </dd> 429 </dd>
430 </dl> 430 </dl>
431 <a NAME="IrcIdentity.getNickNames" ID="IrcIdentity.getNickNames"></a> 431 <a NAME="IrcIdentity.getNickNames" ID="IrcIdentity.getNickNames"></a>
434 434
435 <p> 435 <p>
436 Public method to get the nick names. 436 Public method to get the nick names.
437 </p> 437 </p>
438 <dl> 438 <dl>
439 <dt>Returns:</dt> 439 <dt>Return:</dt>
440 <dd> 440 <dd>
441 nick names (list of string) 441 nick names (list of string)
442 </dd> 442 </dd>
443 </dl> 443 </dl>
444 <a NAME="IrcIdentity.getPartMessage" ID="IrcIdentity.getPartMessage"></a> 444 <a NAME="IrcIdentity.getPartMessage" ID="IrcIdentity.getPartMessage"></a>
447 447
448 <p> 448 <p>
449 Public method to get the PART message. 449 Public method to get the PART message.
450 </p> 450 </p>
451 <dl> 451 <dl>
452 <dt>Returns:</dt> 452 <dt>Return:</dt>
453 <dd> 453 <dd>
454 PART message (string) 454 PART message (string)
455 </dd> 455 </dd>
456 </dl> 456 </dl>
457 <a NAME="IrcIdentity.getPassword" ID="IrcIdentity.getPassword"></a> 457 <a NAME="IrcIdentity.getPassword" ID="IrcIdentity.getPassword"></a>
460 460
461 <p> 461 <p>
462 Public method to get the password. 462 Public method to get the password.
463 </p> 463 </p>
464 <dl> 464 <dl>
465 <dt>Returns:</dt> 465 <dt>Return:</dt>
466 <dd> 466 <dd>
467 password (string) 467 password (string)
468 </dd> 468 </dd>
469 </dl> 469 </dl>
470 <a NAME="IrcIdentity.getQuitMessage" ID="IrcIdentity.getQuitMessage"></a> 470 <a NAME="IrcIdentity.getQuitMessage" ID="IrcIdentity.getQuitMessage"></a>
473 473
474 <p> 474 <p>
475 Public method to get the QUIT message. 475 Public method to get the QUIT message.
476 </p> 476 </p>
477 <dl> 477 <dl>
478 <dt>Returns:</dt> 478 <dt>Return:</dt>
479 <dd> 479 <dd>
480 QUIT message (string) 480 QUIT message (string)
481 </dd> 481 </dd>
482 </dl> 482 </dl>
483 <a NAME="IrcIdentity.getRealName" ID="IrcIdentity.getRealName"></a> 483 <a NAME="IrcIdentity.getRealName" ID="IrcIdentity.getRealName"></a>
486 486
487 <p> 487 <p>
488 Public method to get the real name. 488 Public method to get the real name.
489 </p> 489 </p>
490 <dl> 490 <dl>
491 <dt>Returns:</dt> 491 <dt>Return:</dt>
492 <dd> 492 <dd>
493 real name (string) 493 real name (string)
494 </dd> 494 </dd>
495 </dl> 495 </dl>
496 <a NAME="IrcIdentity.getServiceName" ID="IrcIdentity.getServiceName"></a> 496 <a NAME="IrcIdentity.getServiceName" ID="IrcIdentity.getServiceName"></a>
500 <p> 500 <p>
501 Public method to get the service name of the identity used for 501 Public method to get the service name of the identity used for
502 identification. 502 identification.
503 </p> 503 </p>
504 <dl> 504 <dl>
505 <dt>Returns:</dt> 505 <dt>Return:</dt>
506 <dd> 506 <dd>
507 service name (string) 507 service name (string)
508 </dd> 508 </dd>
509 </dl> 509 </dl>
510 <a NAME="IrcIdentity.load" ID="IrcIdentity.load"></a> 510 <a NAME="IrcIdentity.load" ID="IrcIdentity.load"></a>
528 <p> 528 <p>
529 Public method to get a flag indicating to remember the chat position 529 Public method to get a flag indicating to remember the chat position
530 upon AWAY. 530 upon AWAY.
531 </p> 531 </p>
532 <dl> 532 <dl>
533 <dt>Returns:</dt> 533 <dt>Return:</dt>
534 <dd> 534 <dd>
535 flag indicating to remember the chat position (boolean) 535 flag indicating to remember the chat position (boolean)
536 </dd> 536 </dd>
537 </dl> 537 </dl>
538 <a NAME="IrcIdentity.save" ID="IrcIdentity.save"></a> 538 <a NAME="IrcIdentity.save" ID="IrcIdentity.save"></a>
816 flag indicating to create a SSL network configuration 816 flag indicating to create a SSL network configuration
817 (boolean) 817 (boolean)
818 </dd> 818 </dd>
819 </dl> 819 </dl>
820 <dl> 820 <dl>
821 <dt>Returns:</dt> 821 <dt>Return:</dt>
822 <dd> 822 <dd>
823 default network object (IrcNetwork) 823 default network object (IrcNetwork)
824 </dd> 824 </dd>
825 </dl> 825 </dl>
826 <a NAME="IrcNetwork.__init__" ID="IrcNetwork.__init__"></a> 826 <a NAME="IrcNetwork.__init__" ID="IrcNetwork.__init__"></a>
858 <p> 858 <p>
859 Public method to check, if the network should be connected to at 859 Public method to check, if the network should be connected to at
860 start-up. 860 start-up.
861 </p> 861 </p>
862 <dl> 862 <dl>
863 <dt>Returns:</dt> 863 <dt>Return:</dt>
864 <dd> 864 <dd>
865 flag indicating an auto connect (boolean) 865 flag indicating an auto connect (boolean)
866 </dd> 866 </dd>
867 </dl> 867 </dl>
868 <a NAME="IrcNetwork.deleteChannel" ID="IrcNetwork.deleteChannel"></a> 868 <a NAME="IrcNetwork.deleteChannel" ID="IrcNetwork.deleteChannel"></a>
892 <dd> 892 <dd>
893 name of the channel to retrieve (string) 893 name of the channel to retrieve (string)
894 </dd> 894 </dd>
895 </dl> 895 </dl>
896 <dl> 896 <dl>
897 <dt>Returns:</dt> 897 <dt>Return:</dt>
898 <dd> 898 <dd>
899 reference to the channel (IrcChannel) 899 reference to the channel (IrcChannel)
900 </dd> 900 </dd>
901 </dl> 901 </dl>
902 <a NAME="IrcNetwork.getChannelNames" ID="IrcNetwork.getChannelNames"></a> 902 <a NAME="IrcNetwork.getChannelNames" ID="IrcNetwork.getChannelNames"></a>
905 905
906 <p> 906 <p>
907 Public method to get the list of channels. 907 Public method to get the list of channels.
908 </p> 908 </p>
909 <dl> 909 <dl>
910 <dt>Returns:</dt> 910 <dt>Return:</dt>
911 <dd> 911 <dd>
912 list of channel names (list of string) 912 list of channel names (list of string)
913 </dd> 913 </dd>
914 </dl> 914 </dl>
915 <a NAME="IrcNetwork.getChannels" ID="IrcNetwork.getChannels"></a> 915 <a NAME="IrcNetwork.getChannels" ID="IrcNetwork.getChannels"></a>
918 918
919 <p> 919 <p>
920 Public method to get the channels. 920 Public method to get the channels.
921 </p> 921 </p>
922 <dl> 922 <dl>
923 <dt>Returns:</dt> 923 <dt>Return:</dt>
924 <dd> 924 <dd>
925 list of channels for the network (list of IrcChannel) 925 list of channels for the network (list of IrcChannel)
926 </dd> 926 </dd>
927 </dl> 927 </dl>
928 <a NAME="IrcNetwork.getIdentityName" ID="IrcNetwork.getIdentityName"></a> 928 <a NAME="IrcNetwork.getIdentityName" ID="IrcNetwork.getIdentityName"></a>
931 931
932 <p> 932 <p>
933 Public method to get the name of the identity. 933 Public method to get the name of the identity.
934 </p> 934 </p>
935 <dl> 935 <dl>
936 <dt>Returns:</dt> 936 <dt>Return:</dt>
937 <dd> 937 <dd>
938 identity name (string) 938 identity name (string)
939 </dd> 939 </dd>
940 </dl> 940 </dl>
941 <a NAME="IrcNetwork.getName" ID="IrcNetwork.getName"></a> 941 <a NAME="IrcNetwork.getName" ID="IrcNetwork.getName"></a>
944 944
945 <p> 945 <p>
946 Public method to get the network name. 946 Public method to get the network name.
947 </p> 947 </p>
948 <dl> 948 <dl>
949 <dt>Returns:</dt> 949 <dt>Return:</dt>
950 <dd> 950 <dd>
951 network name (string) 951 network name (string)
952 </dd> 952 </dd>
953 </dl> 953 </dl>
954 <a NAME="IrcNetwork.getServer" ID="IrcNetwork.getServer"></a> 954 <a NAME="IrcNetwork.getServer" ID="IrcNetwork.getServer"></a>
957 957
958 <p> 958 <p>
959 Public method to get the server object. 959 Public method to get the server object.
960 </p> 960 </p>
961 <dl> 961 <dl>
962 <dt>Returns:</dt> 962 <dt>Return:</dt>
963 <dd> 963 <dd>
964 reference to the server (IrcServer) 964 reference to the server (IrcServer)
965 </dd> 965 </dd>
966 </dl> 966 </dl>
967 <a NAME="IrcNetwork.getServerName" ID="IrcNetwork.getServerName"></a> 967 <a NAME="IrcNetwork.getServerName" ID="IrcNetwork.getServerName"></a>
970 970
971 <p> 971 <p>
972 Public method to get the server name. 972 Public method to get the server name.
973 </p> 973 </p>
974 <dl> 974 <dl>
975 <dt>Returns:</dt> 975 <dt>Return:</dt>
976 <dd> 976 <dd>
977 server name (string) 977 server name (string)
978 </dd> 978 </dd>
979 </dl> 979 </dl>
980 <a NAME="IrcNetwork.load" ID="IrcNetwork.load"></a> 980 <a NAME="IrcNetwork.load" ID="IrcNetwork.load"></a>
1318 1318
1319 <p> 1319 <p>
1320 Public method to get a copy of all identities. 1320 Public method to get a copy of all identities.
1321 </p> 1321 </p>
1322 <dl> 1322 <dl>
1323 <dt>Returns:</dt> 1323 <dt>Return:</dt>
1324 <dd> 1324 <dd>
1325 dictionary of all identities (dict of IrcIdentity) 1325 dictionary of all identities (dict of IrcIdentity)
1326 </dd> 1326 </dd>
1327 </dl> 1327 </dl>
1328 <a NAME="IrcNetworkManager.getIdentity" ID="IrcNetworkManager.getIdentity"></a> 1328 <a NAME="IrcNetworkManager.getIdentity" ID="IrcNetworkManager.getIdentity"></a>
1343 flag indicating to create a new object, 1343 flag indicating to create a new object,
1344 if none exists (boolean) 1344 if none exists (boolean)
1345 </dd> 1345 </dd>
1346 </dl> 1346 </dl>
1347 <dl> 1347 <dl>
1348 <dt>Returns:</dt> 1348 <dt>Return:</dt>
1349 <dd> 1349 <dd>
1350 reference to the identity (IrcIdentity) 1350 reference to the identity (IrcIdentity)
1351 </dd> 1351 </dd>
1352 </dl> 1352 </dl>
1353 <a NAME="IrcNetworkManager.getIdentityNames" ID="IrcNetworkManager.getIdentityNames"></a> 1353 <a NAME="IrcNetworkManager.getIdentityNames" ID="IrcNetworkManager.getIdentityNames"></a>
1356 1356
1357 <p> 1357 <p>
1358 Public method to get the names of all identities. 1358 Public method to get the names of all identities.
1359 </p> 1359 </p>
1360 <dl> 1360 <dl>
1361 <dt>Returns:</dt> 1361 <dt>Return:</dt>
1362 <dd> 1362 <dd>
1363 names of all identities (list of string) 1363 names of all identities (list of string)
1364 </dd> 1364 </dd>
1365 </dl> 1365 </dl>
1366 <a NAME="IrcNetworkManager.getNetwork" ID="IrcNetworkManager.getNetwork"></a> 1366 <a NAME="IrcNetworkManager.getNetwork" ID="IrcNetworkManager.getNetwork"></a>
1376 <dd> 1376 <dd>
1377 name of the network (string) 1377 name of the network (string)
1378 </dd> 1378 </dd>
1379 </dl> 1379 </dl>
1380 <dl> 1380 <dl>
1381 <dt>Returns:</dt> 1381 <dt>Return:</dt>
1382 <dd> 1382 <dd>
1383 reference to the network object (IrcNetwork) 1383 reference to the network object (IrcNetwork)
1384 </dd> 1384 </dd>
1385 </dl> 1385 </dl>
1386 <a NAME="IrcNetworkManager.getNetworkNames" ID="IrcNetworkManager.getNetworkNames"></a> 1386 <a NAME="IrcNetworkManager.getNetworkNames" ID="IrcNetworkManager.getNetworkNames"></a>
1389 1389
1390 <p> 1390 <p>
1391 Public method to get a list of all known network names. 1391 Public method to get a list of all known network names.
1392 </p> 1392 </p>
1393 <dl> 1393 <dl>
1394 <dt>Returns:</dt> 1394 <dt>Return:</dt>
1395 <dd> 1395 <dd>
1396 list of network names (list of string) 1396 list of network names (list of string)
1397 </dd> 1397 </dd>
1398 </dl> 1398 </dl>
1399 <a NAME="IrcNetworkManager.identityChanged" ID="IrcNetworkManager.identityChanged"></a> 1399 <a NAME="IrcNetworkManager.identityChanged" ID="IrcNetworkManager.identityChanged"></a>
1563 1563
1564 <p> 1564 <p>
1565 Public method to get the server name. 1565 Public method to get the server name.
1566 </p> 1566 </p>
1567 <dl> 1567 <dl>
1568 <dt>Returns:</dt> 1568 <dt>Return:</dt>
1569 <dd> 1569 <dd>
1570 server name (string) 1570 server name (string)
1571 </dd> 1571 </dd>
1572 </dl> 1572 </dl>
1573 <a NAME="IrcServer.getPassword" ID="IrcServer.getPassword"></a> 1573 <a NAME="IrcServer.getPassword" ID="IrcServer.getPassword"></a>
1576 1576
1577 <p> 1577 <p>
1578 Public method to get the password. 1578 Public method to get the password.
1579 </p> 1579 </p>
1580 <dl> 1580 <dl>
1581 <dt>Returns:</dt> 1581 <dt>Return:</dt>
1582 <dd> 1582 <dd>
1583 password (string) 1583 password (string)
1584 </dd> 1584 </dd>
1585 </dl> 1585 </dl>
1586 <a NAME="IrcServer.getPort" ID="IrcServer.getPort"></a> 1586 <a NAME="IrcServer.getPort" ID="IrcServer.getPort"></a>
1589 1589
1590 <p> 1590 <p>
1591 Public method to get the server port number. 1591 Public method to get the server port number.
1592 </p> 1592 </p>
1593 <dl> 1593 <dl>
1594 <dt>Returns:</dt> 1594 <dt>Return:</dt>
1595 <dd> 1595 <dd>
1596 port number (integer) 1596 port number (integer)
1597 </dd> 1597 </dd>
1598 </dl> 1598 </dl>
1599 <a NAME="IrcServer.load" ID="IrcServer.load"></a> 1599 <a NAME="IrcServer.load" ID="IrcServer.load"></a>
1686 1686
1687 <p> 1687 <p>
1688 Public method to check for SSL usage. 1688 Public method to check for SSL usage.
1689 </p> 1689 </p>
1690 <dl> 1690 <dl>
1691 <dt>Returns:</dt> 1691 <dt>Return:</dt>
1692 <dd> 1692 <dd>
1693 flag indicating SSL usage (boolean) 1693 flag indicating SSL usage (boolean)
1694 </dd> 1694 </dd>
1695 </dl> 1695 </dl>
1696 <div align="right"><a href="#top">Up</a></div> 1696 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial