aboutsummaryrefslogblamecommitdiffstats
path: root/docs/Irssi/Channel.pod
blob: baeff6c271e37f35f8cc6aa7a9b983ee2f36e5d1 (plain) (tree)
1
2
3
4
5
6
7
8
9
10







              

                  



























                                                                  






















                                                                    
 
                             
 
                          

 
                                                        
 
                                               
 
                           
 
                          
 
                         
 
                                                
 
                              
 
                                                                        
 
               
 
                                      
__END__

=head1 NAME

Irssi::Channel

=head1 FIELDS

C<Channel-E<gt>{}>

  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



=head2 C<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.

=head2 C<destroy>

Destroy channel.

=head2 C<bans>

Return a list of bans in channel.

=head2 C<ban_get_mask $nick>

Get ban mask for `nick'.

=head2 C<banlist_add $ban, $nick, $time>

Add a new ban to channel.

=head2 C<banlist_remove $ban>

Remove a ban from channel.


=head2 C<nick_insert $nick, $op, $voice, $send_massjoin>

Add nick to nicklist. Returns a L<Irssi::Nick>.

=head2 C<nick_remove $nick>

Remove nick from nicklist.

=head2 C<nick_find $nick>

Find nick from nicklist. Returns L<Irssi::Nick>.

=head2 C<nick_find_mask $mask>

Find nick mask from nicklist, wildcards allowed. Returns L<Irssi::Nick>.

=head2 C<nicks>

Return a list of all nicks in channel.