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:insert_text*()
14
15*channel:mark_read*()
16
17*channel:send_msg*(_msg_)
18
19# DESCRIPTION
20
21A *channel* represents an IRC channel.
22
23*channel:insert_text*
24 Insert text into the text input at the cursor position
25
26*channel:mark_read*
27 Mark this channel as read. This will update the unread indicator to the
28 position of the last read message.
29
30*channel:send_msg*
31 A method on *channel* which accepts a string (_msg_). _Msg_ is sent to
32 the *channel* using a *PRIVMSG* IRC command. Note that this is a method
33 call, using lua colon syntax.
34
35# RETURN VALUES
36
37*channel:name*
38 Returns a string which is the name of the channel. Note that this is a
39 method call, using lua colon syntax.
40
41# SEE ALSO
42
43*comlink*(1), *comlink*(3)