Mercurial > irccd

annotate doc/html/api/module/Irccd.Server/method/info.md @ 254:93a227277786

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Irccd: various fixes for further cross-compilation
author David Demelier <markand@malikania.fr>
date Mon, 05 Sep 2016 12:53:13 +0200
parents 392778b6d3c9
children 904ee87bc808
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 method: info
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 summary: "Get server information."
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 synopsis: "info = Server.prototype.info()"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 returns: "The server information."
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 The returned object has the following fields:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9
24
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
10 - **name**: (string) the server unique name,
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
11 - **host**: (string) the host name,
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
12 - **port**: (int) the port number,
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
13 - **ssl**: (bool) true if using ssl,
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
14 - **sslVerify**: (bool) true if ssl was verified,
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
15 - **channels**: (string list) an array of all channels,
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
16 - **realname**: (string) the current real name,
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
17 - **username**: (string) the user name,
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
18 - **nickname**: (string) the current nickname.