1
0
mirror of https://github.com/weechat/weechat.git synced 2026-06-27 05:16:38 +02:00

Added new API functions for scripts (list of servers, channels, nicks)

This commit is contained in:
Sebastien Helleu
2006-02-08 11:13:49 +00:00
parent c0a7e4445c
commit 47b7b1d578
4 changed files with 976 additions and 4 deletions
+244 -1
View File
@@ -3899,6 +3899,243 @@ nick = weechat.get_info ("nick", "freenode")
</para>
</section>
<section>
<title>get_server_info</title>
<para>
Perl prototype:
<command>
weechat::get_server_info ( );
</command>
</para>
<para>
Python prototype:
<command>
weechat.get_server_info ( )
</command>
</para>
<para>
Ruby prototype:
<command>
Weechat.get_server_info ( )
</command>
</para>
<para>
Return list of IRC servers (connected or not).
</para>
<para>
Return value: list of servers
(see <xref linkend="secAPI_get_server_info" />).
</para>
<para>
Examples:
<screen>
# perl
my $servers = weechat::get_server_info();
if ($servers)
{
while (my ($srvname, $srvinfos) = each %$servers)
{
while ( my ($key, $value) = each %$srvinfos)
{
weechat::print("$srvname[$key] = '$value'");
}
}
}
else
{
weechat::print("no server");
}
# python
servers = weechat.get_server_info()
if servers != None:
if servers == {}:
weechat.prnt("no server")
else:
for s in servers:
for i in servers[s]:
weechat.prnt("%s[%s] = '%s'" % (s, i, str(servers[s][i])))
else:
weechat.prnt("error while getting servers")
# ruby
servers = Weechat.get_server_info()
if servers != nil
if servers == []
Weechat.print("no server")
else
servers.each do |n, s|
s.each do |key, value|
Weechat.print("#{n}[#{key}] = '#{value}'")
end
end
end
else
Weechat.print("error while getting servers")
end
</screen>
</para>
</section>
<section>
<title>get_channel_info</title>
<para>
Perl prototype:
<command>
weechat::get_channel_info ( server );
</command>
</para>
<para>
Python prototype:
<command>
weechat.get_channel_info ( server )
</command>
</para>
<para>
Ruby prototype:
<command>
Weechat.get_channel_info ( server )
</command>
</para>
<para>
Return list of IRC channels for a server.
</para>
<para>
Return value: list of IRC channels for server
(see <xref linkend="secAPI_get_channel_info" />).
</para>
<para>
Examples:
<screen>
# perl
my $channels = weechat::get_channel_info(weechat::get_info('server'));
if ($channels)
{
while (my ($channame, $chaninfos) = each %$channels)
{
while (my ($key, $value) = each %$chaninfos)
{
weechat::print("$channame[$key] = '$value'");
}
}
}
else
{
weechat::print("no channel");
}
# python
chans = weechat.get_channel_info(weechat.get_info('server'))
if chans != None:
if chans == {}:
weechat.prnt("no channel")
else:
for s in chans:
for i in chans[s]:
weechat.prnt("%s[%s] = '%s'" % (s, i, str(chans[s][i])))
else:
weechat.prnt("error while getting channels")
# ruby
channels = Weechat.get_channel_info(Weechat.get_info('server'))
if channels != nil
if channels == {}
Weechat.print("no channel")
else
channels.each do |n, c|
c.each do |key, value|
Weechat.print("#{n}[#{key}] = '#{value}'")
end
end
end
else
Weechat.print("error while getting channels")
end
</screen>
</para>
</section>
<section>
<title>get_nick_info</title>
<para>
Perl prototype:
<command>
weechat::get_nick_info ( server, channel );
</command>
</para>
<para>
Python prototype:
<command>
weechat.get_nick_info ( server, channel )
</command>
</para>
<para>
Ruby prototype:
<command>
Weechat.get_nick_info ( server, channel )
</command>
</para>
<para>
Return list of nicks for a channel.
</para>
<para>
Return value: list of nicks on channel
(see <xref linkend="secAPI_get_nick_info" />).
</para>
<para>
Examples:
<screen>
# perl
my $nicks = weechat::get_nick_info("freenode", "#weechat");
if ($nicks)
{
while (my ($nickname, $nickinfos) = each %$nicks)
{
while ( my ($key, $value) = each %$nickinfos)
{
weechat::print("$nickname[$key] = '$value'");
}
}
}
else
{
weechat::print("no nick");
}
# python
nicks = weechat.get_nick_info("freenode", "#weechat")
if nicks != None:
if nicks == {}:
weechat.prnt("no nick")
else:
for n in nicks:
for f in nicks[n]:
weechat.prnt("%s[%s] = '%s'" % (n, f, str(nicks[n][f])))
else:
weechat.prnt("error while getting nicks")
# ruby
nicks = Weechat.get_nick_info("freenode", "#weechat")
if nicks != nil
if nicks == {}
Weechat.print("no nick")
else
nicks.each do |nk, nattr|
nattr.each do |key, value|
Weechat.print("#{nk}[#{key}] = '#{value}'")
end
end
end
else
Weechat.print("error while getting nicks")
end
</screen>
</para>
</section>
<section>
<title>get_config</title>
@@ -4181,7 +4418,7 @@ Weechat.set_plugin_config ("my_var", "value")
<listitem>
<para>
<emphasis>Jiri Golembiovsky</emphasis> -
czech translation
czech translation, patches
</para>
</listitem>
<listitem>
@@ -4214,6 +4451,12 @@ Weechat.set_plugin_config ("my_var", "value")
patches
</para>
</listitem>
<listitem>
<para>
<emphasis>voroskoi</emphasis> -
hungarian translation
</para>
</listitem>
</itemizedlist>
</para>
+244 -1
View File
@@ -3965,6 +3965,243 @@ nick = weechat.get_info ("nick", "freenode")
</para>
</section>
<section>
<title>get_server_info</title>
<para>
Prototype Perl :
<command>
weechat::get_server_info ( );
</command>
</para>
<para>
Prototype Python :
<command>
weechat.get_server_info ( )
</command>
</para>
<para>
Prototype Ruby :
<command>
Weechat.get_server_info ( )
</command>
</para>
<para>
Renvoie la liste des serveurs IRC (connectés ou non).
</para>
<para>
Valeur renvoyée : la liste des serveurs IRC (connectés ou non)
(voir <xref linkend="secAPI_get_server_info" />).
</para>
<para>
Exemples :
<screen>
# perl
my $servers = weechat::get_server_info();
if ($servers)
{
while (my ($srvname, $srvinfos) = each %$servers)
{
while ( my ($key, $value) = each %$srvinfos)
{
weechat::print("$srvname[$key] = '$value'");
}
}
}
else
{
weechat::print("pas de serveur");
}
# python
servers = weechat.get_server_info()
if servers != None:
if servers == {}:
weechat.prnt("pas de serveur")
else:
for s in servers:
for i in servers[s]:
weechat.prnt("%s[%s] = '%s'" % (s, i, str(servers[s][i])))
else:
weechat.prnt("erreur de lecture des serveurs")
# ruby
servers = Weechat.get_server_info()
if servers != nil
if servers == []
Weechat.print("pas de serveur")
else
servers.each do |n, s|
s.each do |key, value|
Weechat.print("#{n}[#{key}] = '#{value}'")
end
end
end
else
Weechat.print("erreur de lecture des serveurs")
end
</screen>
</para>
</section>
<section>
<title>get_channel_info</title>
<para>
Prototype Perl :
<command>
weechat::get_channel_info ( serveur );
</command>
</para>
<para>
Prototype Python :
<command>
weechat.get_channel_info ( serveur )
</command>
</para>
<para>
Prototype Ruby :
<command>
Weechat.get_channel_info ( serveur )
</command>
</para>
<para>
Renvoie la liste des canaux IRC pour un serveur.
</para>
<para>
Valeur renvoyée : la liste des canaux IRC du serveur
(voir <xref linkend="secAPI_get_channel_info" />).
</para>
<para>
Exemples :
<screen>
# perl
my $channels = weechat::get_channel_info(weechat::get_info('server'));
if ($channels)
{
while (my ($channame, $chaninfos) = each %$channels)
{
while (my ($key, $value) = each %$chaninfos)
{
weechat::print("$channame[$key] = '$value'");
}
}
}
else
{
weechat::print("pas de canal");
}
# python
chans = weechat.get_channel_info(weechat.get_info('server'))
if chans != None:
if chans == {}:
weechat.prnt("pas de canal")
else:
for s in chans:
for i in chans[s]:
weechat.prnt("%s[%s] = '%s'" % (s, i, str(chans[s][i])))
else:
weechat.prnt("erreur de lecture des canaux")
# ruby
channels = Weechat.get_channel_info(Weechat.get_info('server'))
if channels != nil
if channels == {}
Weechat.print("pas de canal")
else
channels.each do |n, c|
c.each do |key, value|
Weechat.print("#{n}[#{key}] = '#{value}'")
end
end
end
else
Weechat.print("erreur de lecture des canaux")
end
</screen>
</para>
</section>
<section>
<title>get_nick_info</title>
<para>
Prototype Perl :
<command>
weechat::get_nick_info ( server, canal );
</command>
</para>
<para>
Prototype Python :
<command>
weechat.get_nick_info ( serveur, canal )
</command>
</para>
<para>
Prototype Ruby :
<command>
Weechat.get_nick_info ( serveur, canal )
</command>
</para>
<para>
Renvoie la liste des pseudos pour un canal.
</para>
<para>
Valeur renvoyée : la liste des pseudos présents sur le canal
(voir <xref linkend="secAPI_get_nick_info" />).
</para>
<para>
Exemples :
<screen>
# perl
my $nicks = weechat::get_nick_info("freenode", "#weechat");
if ($nicks)
{
while (my ($nickname, $nickinfos) = each %$nicks)
{
while ( my ($key, $value) = each %$nickinfos)
{
weechat::print("$nickname[$key] = '$value'");
}
}
}
else
{
weechat::print("pas de pseudo");
}
# python
nicks = weechat.get_nick_info("freenode", "#weechat")
if nicks != None:
if nicks == {}:
weechat.prnt("pas de pseudo")
else:
for n in nicks:
for f in nicks[n]:
weechat.prnt("%s[%s] = '%s'" % (n, f, str(nicks[n][f])))
else:
weechat.prnt("erreur de lecture des pseudos")
# ruby
nicks = Weechat.get_nick_info("freenode", "#weechat")
if nicks != nil
if nicks == {}
Weechat.print("pas de pseudo")
else
nicks.each do |nk, nattr|
nattr.each do |key, value|
Weechat.print("#{nk}[#{key}] = '#{value}'")
end
end
end
else
Weechat.print("erreur de lecture des pseudos")
end
</screen>
</para>
</section>
<section>
<title>get_config</title>
@@ -4257,7 +4494,7 @@ Weechat.set_plugin_config ("ma_variable", "valeur")
<listitem>
<para>
<emphasis>Jiri Golembiovsky</emphasis> -
traduction tchèque
traduction en tchèque, patchs
</para>
</listitem>
<listitem>
@@ -4290,6 +4527,12 @@ Weechat.set_plugin_config ("ma_variable", "valeur")
patchs
</para>
</listitem>
<listitem>
<para>
<emphasis>voroskoi</emphasis> -
traduction en hongrois
</para>
</listitem>
</itemizedlist>
</para>
+244 -1
View File
@@ -3899,6 +3899,243 @@ nick = weechat.get_info ("nick", "freenode")
</para>
</section>
<section>
<title>get_server_info</title>
<para>
Perl prototype:
<command>
weechat::get_server_info ( );
</command>
</para>
<para>
Python prototype:
<command>
weechat.get_server_info ( )
</command>
</para>
<para>
Ruby prototype:
<command>
Weechat.get_server_info ( )
</command>
</para>
<para>
Return list of IRC servers (connected or not).
</para>
<para>
Return value: list of servers
(see <xref linkend="secAPI_get_server_info" />).
</para>
<para>
Examples:
<screen>
# perl
my $servers = weechat::get_server_info();
if ($servers)
{
while (my ($srvname, $srvinfos) = each %$servers)
{
while ( my ($key, $value) = each %$srvinfos)
{
weechat::print("$srvname[$key] = '$value'");
}
}
}
else
{
weechat::print("no server");
}
# python
servers = weechat.get_server_info()
if servers != None:
if servers == {}:
weechat.prnt("no server")
else:
for s in servers:
for i in servers[s]:
weechat.prnt("%s[%s] = '%s'" % (s, i, str(servers[s][i])))
else:
weechat.prnt("error while getting servers")
# ruby
servers = Weechat.get_server_info()
if servers != nil
if servers == []
Weechat.print("no server")
else
servers.each do |n, s|
s.each do |key, value|
Weechat.print("#{n}[#{key}] = '#{value}'")
end
end
end
else
Weechat.print("error while getting servers")
end
</screen>
</para>
</section>
<section>
<title>get_channel_info</title>
<para>
Perl prototype:
<command>
weechat::get_channel_info ( server );
</command>
</para>
<para>
Python prototype:
<command>
weechat.get_channel_info ( server )
</command>
</para>
<para>
Ruby prototype:
<command>
Weechat.get_channel_info ( server )
</command>
</para>
<para>
Return list of IRC channels for a server.
</para>
<para>
Return value: list of IRC channels for server
(see <xref linkend="secAPI_get_channel_info" />).
</para>
<para>
Examples:
<screen>
# perl
my $channels = weechat::get_channel_info(weechat::get_info('server'));
if ($channels)
{
while (my ($channame, $chaninfos) = each %$channels)
{
while (my ($key, $value) = each %$chaninfos)
{
weechat::print("$channame[$key] = '$value'");
}
}
}
else
{
weechat::print("no channel");
}
# python
chans = weechat.get_channel_info(weechat.get_info('server'))
if chans != None:
if chans == {}:
weechat.prnt("no channel")
else:
for s in chans:
for i in chans[s]:
weechat.prnt("%s[%s] = '%s'" % (s, i, str(chans[s][i])))
else:
weechat.prnt("error while getting channels")
# ruby
channels = Weechat.get_channel_info(Weechat.get_info('server'))
if channels != nil
if channels == {}
Weechat.print("no channel")
else
channels.each do |n, c|
c.each do |key, value|
Weechat.print("#{n}[#{key}] = '#{value}'")
end
end
end
else
Weechat.print("error while getting channels")
end
</screen>
</para>
</section>
<section>
<title>get_nick_info</title>
<para>
Perl prototype:
<command>
weechat::get_nick_info ( server, channel );
</command>
</para>
<para>
Python prototype:
<command>
weechat.get_nick_info ( server, channel )
</command>
</para>
<para>
Ruby prototype:
<command>
Weechat.get_nick_info ( server, channel )
</command>
</para>
<para>
Return list of nicks for a channel.
</para>
<para>
Return value: list of nicks on channel
(see <xref linkend="secAPI_get_nick_info" />).
</para>
<para>
Examples:
<screen>
# perl
my $nicks = weechat::get_nick_info("freenode", "#weechat");
if ($nicks)
{
while (my ($nickname, $nickinfos) = each %$nicks)
{
while ( my ($key, $value) = each %$nickinfos)
{
weechat::print("$nickname[$key] = '$value'");
}
}
}
else
{
weechat::print("no nick");
}
# python
nicks = weechat.get_nick_info("freenode", "#weechat")
if nicks != None:
if nicks == {}:
weechat.prnt("no nick")
else:
for n in nicks:
for f in nicks[n]:
weechat.prnt("%s[%s] = '%s'" % (n, f, str(nicks[n][f])))
else:
weechat.prnt("error while getting nicks")
# ruby
nicks = Weechat.get_nick_info("freenode", "#weechat")
if nicks != nil
if nicks == {}
Weechat.print("no nick")
else
nicks.each do |nk, nattr|
nattr.each do |key, value|
Weechat.print("#{nk}[#{key}] = '#{value}'")
end
end
end
else
Weechat.print("error while getting nicks")
end
</screen>
</para>
</section>
<section>
<title>get_config</title>
@@ -4181,7 +4418,7 @@ Weechat.set_plugin_config ("my_var", "value")
<listitem>
<para>
<emphasis>Jiri Golembiovsky</emphasis> -
czech translation
czech translation, patches
</para>
</listitem>
<listitem>
@@ -4214,6 +4451,12 @@ Weechat.set_plugin_config ("my_var", "value")
patches
</para>
</listitem>
<listitem>
<para>
<emphasis>voroskoi</emphasis> -
hungarian translation
</para>
</listitem>
</itemizedlist>
</para>
+244 -1
View File
@@ -3965,6 +3965,243 @@ nick = weechat.get_info ("nick", "freenode")
</para>
</section>
<section>
<title>get_server_info</title>
<para>
Prototype Perl :
<command>
weechat::get_server_info ( );
</command>
</para>
<para>
Prototype Python :
<command>
weechat.get_server_info ( )
</command>
</para>
<para>
Prototype Ruby :
<command>
Weechat.get_server_info ( )
</command>
</para>
<para>
Renvoie la liste des serveurs IRC (connectés ou non).
</para>
<para>
Valeur renvoyée : la liste des serveurs IRC (connectés ou non)
(voir <xref linkend="secAPI_get_server_info" />).
</para>
<para>
Exemples :
<screen>
# perl
my $servers = weechat::get_server_info();
if ($servers)
{
while (my ($srvname, $srvinfos) = each %$servers)
{
while ( my ($key, $value) = each %$srvinfos)
{
weechat::print("$srvname[$key] = '$value'");
}
}
}
else
{
weechat::print("pas de serveur");
}
# python
servers = weechat.get_server_info()
if servers != None:
if servers == {}:
weechat.prnt("pas de serveur")
else:
for s in servers:
for i in servers[s]:
weechat.prnt("%s[%s] = '%s'" % (s, i, str(servers[s][i])))
else:
weechat.prnt("erreur de lecture des serveurs")
# ruby
servers = Weechat.get_server_info()
if servers != nil
if servers == []
Weechat.print("pas de serveur")
else
servers.each do |n, s|
s.each do |key, value|
Weechat.print("#{n}[#{key}] = '#{value}'")
end
end
end
else
Weechat.print("erreur de lecture des serveurs")
end
</screen>
</para>
</section>
<section>
<title>get_channel_info</title>
<para>
Prototype Perl :
<command>
weechat::get_channel_info ( serveur );
</command>
</para>
<para>
Prototype Python :
<command>
weechat.get_channel_info ( serveur )
</command>
</para>
<para>
Prototype Ruby :
<command>
Weechat.get_channel_info ( serveur )
</command>
</para>
<para>
Renvoie la liste des canaux IRC pour un serveur.
</para>
<para>
Valeur renvoyée : la liste des canaux IRC du serveur
(voir <xref linkend="secAPI_get_channel_info" />).
</para>
<para>
Exemples :
<screen>
# perl
my $channels = weechat::get_channel_info(weechat::get_info('server'));
if ($channels)
{
while (my ($channame, $chaninfos) = each %$channels)
{
while (my ($key, $value) = each %$chaninfos)
{
weechat::print("$channame[$key] = '$value'");
}
}
}
else
{
weechat::print("pas de canal");
}
# python
chans = weechat.get_channel_info(weechat.get_info('server'))
if chans != None:
if chans == {}:
weechat.prnt("pas de canal")
else:
for s in chans:
for i in chans[s]:
weechat.prnt("%s[%s] = '%s'" % (s, i, str(chans[s][i])))
else:
weechat.prnt("erreur de lecture des canaux")
# ruby
channels = Weechat.get_channel_info(Weechat.get_info('server'))
if channels != nil
if channels == {}
Weechat.print("pas de canal")
else
channels.each do |n, c|
c.each do |key, value|
Weechat.print("#{n}[#{key}] = '#{value}'")
end
end
end
else
Weechat.print("erreur de lecture des canaux")
end
</screen>
</para>
</section>
<section>
<title>get_nick_info</title>
<para>
Prototype Perl :
<command>
weechat::get_nick_info ( server, canal );
</command>
</para>
<para>
Prototype Python :
<command>
weechat.get_nick_info ( serveur, canal )
</command>
</para>
<para>
Prototype Ruby :
<command>
Weechat.get_nick_info ( serveur, canal )
</command>
</para>
<para>
Renvoie la liste des pseudos pour un canal.
</para>
<para>
Valeur renvoyée : la liste des pseudos présents sur le canal
(voir <xref linkend="secAPI_get_nick_info" />).
</para>
<para>
Exemples :
<screen>
# perl
my $nicks = weechat::get_nick_info("freenode", "#weechat");
if ($nicks)
{
while (my ($nickname, $nickinfos) = each %$nicks)
{
while ( my ($key, $value) = each %$nickinfos)
{
weechat::print("$nickname[$key] = '$value'");
}
}
}
else
{
weechat::print("pas de pseudo");
}
# python
nicks = weechat.get_nick_info("freenode", "#weechat")
if nicks != None:
if nicks == {}:
weechat.prnt("pas de pseudo")
else:
for n in nicks:
for f in nicks[n]:
weechat.prnt("%s[%s] = '%s'" % (n, f, str(nicks[n][f])))
else:
weechat.prnt("erreur de lecture des pseudos")
# ruby
nicks = Weechat.get_nick_info("freenode", "#weechat")
if nicks != nil
if nicks == {}
Weechat.print("pas de pseudo")
else
nicks.each do |nk, nattr|
nattr.each do |key, value|
Weechat.print("#{nk}[#{key}] = '#{value}'")
end
end
end
else
Weechat.print("erreur de lecture des pseudos")
end
</screen>
</para>
</section>
<section>
<title>get_config</title>
@@ -4257,7 +4494,7 @@ Weechat.set_plugin_config ("ma_variable", "valeur")
<listitem>
<para>
<emphasis>Jiri Golembiovsky</emphasis> -
traduction tchèque
traduction en tchèque, patchs
</para>
</listitem>
<listitem>
@@ -4290,6 +4527,12 @@ Weechat.set_plugin_config ("ma_variable", "valeur")
patchs
</para>
</listitem>
<listitem>
<para>
<emphasis>voroskoi</emphasis> -
traduction en hongrois
</para>
</listitem>
</itemizedlist>
</para>