this repo has no description
1comlink_channel(3)
2
3# NAME
4
5comlink_channel - a lua type representing an IRC channel
6
7# SYNOPSIS
8
9*local channel = comlink.selected_channel*()
10
11*local name = channel:name*()
12
13*channel:mark_read*()
14
15*channel:send_msg*(_msg_)
16
17# DESCRIPTION
18
19A *channel* represents an IRC channel.
20
21*channel:mark_read*
22 Mark this channel as read. This will update the unread indicator to the
23 position of the last read message.
24
25*channel:send_msg*
26 A method on *channel* which accepts a string (_msg_). _Msg_ is sent to
27 the *channel* using a *PRIVMSG* IRC command. Note that this is a method
28 call, using lua colon syntax.
29
30# RETURN VALUES
31
32*channel:name*
33 Returns a string which is the name of the channel. Note that this is a
34 method call, using lua colon syntax.
35
36# SEE ALSO
37
38*comlink*(1), *comlink*(3)