aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Irssi/Channel.pod
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/Irssi/Channel.pod79
1 files changed, 79 insertions, 0 deletions
diff --git a/docs/Irssi/Channel.pod b/docs/Irssi/Channel.pod
new file mode 100644
index 0000000..bb6789d
--- /dev/null
+++ b/docs/Irssi/Channel.pod
@@ -0,0 +1,79 @@
+__END__
+
+=head1 NAME
+
+Irssi::Channel
+
+=head1 FIELDS
+
+Channel->{}
+ type - "CHANNEL" text
+ chat_type - String ID of chat protocol, for example "IRC"
+
+ (..contains all the same data as Windowitem above..)
+
+ topic - Channel topic
+ topic_by - Nick who set the topic
+ topic_time - Timestamp when the topic was set
+
+ no_modes - Channel is modeless
+ mode - Channel mode
+ limit - Max. users in channel (+l mode)
+ key - Channel key (password)
+
+ chanop - You are channel operator
+ names_got - /NAMES list has been received
+ wholist - /WHO list has been received
+ synced - Channel is fully synchronized
+
+ joined - JOIN event for this channel has been received
+ left - You just left the channel (for "channel destroyed" event)
+ kicked - You was just kicked out of the channel (for
+ "channel destroyed" event)
+
+=head1 METHODS
+
+
+
+Server::channels_join(channels, automatic)
+ Join to channels in server. `channels' may also contain keys for
+ channels just like with /JOIN command. `automatic' specifies if this
+ channel was joined "automatically" or if it was joined because join
+ was requested by user. If channel join is "automatic", irssi doesn't
+ jump to the window where the channel was joined.
+
+
+Channel::destroy()
+ Destroy channel.
+
+
+Channel::bans()
+ Return a list of bans in channel.
+
+Channel::ban_get_mask(nick)
+ Get ban mask for `nick'.
+
+Channel::banlist_add(ban, nick, time)
+ Add a new ban to channel.
+
+Channel::banlist_remove(ban)
+ Remove a ban from channel.
+
+
+Nick
+Channel::nick_insert(nick, op, voice, send_massjoin)
+ Add nick to nicklist.
+
+Channel::nick_remove(nick)
+ Remove nick from nicklist.
+
+Nick
+Channel::nick_find(nick)
+ Find nick from nicklist.
+
+Nick
+Channel::nick_find_mask(mask)
+ Find nick mask from nicklist, wildcards allowed.
+
+Channel::nicks()
+ Return a list of all nicks in channel.