aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZoffix Znet <cpan@zoffix.com>2016-07-29 12:48:13 -0400
committerZoffix Znet <cpan@zoffix.com>2016-07-29 12:48:13 -0400
commit119fda689e9aaf45a742d5e9f3a568f76eb52537 (patch)
treea1d0894eff8fcd4cb451c2548d7c10a44b1c3f91
parent55e5d664753471d6a07a198c590c5102ea66cbfb (diff)
Separate object sections more better
-rw-r--r--docs/03-method-reference.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/03-method-reference.md b/docs/03-method-reference.md
index 92773c2..6a360c4 100644
--- a/docs/03-method-reference.md
+++ b/docs/03-method-reference.md
@@ -62,6 +62,8 @@ with a safe-method-call operator (`.?`):
}
```
+---
+
#### `IRC::Client::Message`
##### `.irc`
@@ -104,23 +106,31 @@ the event.
constructed from `":$!usermask $!command $!args[]"`, but is overriden to
a different value by some message objects.
+---
+
#### `IRC::Client::Message::Join`
##### `.channel`
Contains the channel name of the channel that was joined
+---
+
#### `IRC::Client::Message::Nick`
##### `.new-nick`
Contains the new nick switched to (`.nick` attribute contains the old one).
+---
+
#### `IRC::Client::Message::Numeric`
Does not offer any object-specific methods. Use the `.command` attribute
to find out the actual 3-digit IRC command that triggered the event.
+---
+
#### `IRC::Client::Message::Part`
##### `.channel`
@@ -128,6 +138,8 @@ to find out the actual 3-digit IRC command that triggered the event.
Contains the channel name of the channel that was parted. Use `.args`
attribute to get any potential parting messages.
+---
+
#### `IRC::Client::Message::Ping`
**Included in the docs for completeness only.** Used internally. Not sent
@@ -137,11 +149,15 @@ to any event handlers and `irc-ping` is not a valid event.
Takes no arguments. Replies to the server with appropriate `PONG` IRC command.
+---
+
#### `IRC::Client::Message::Quit`
Does not offer any object-specific methods. Use `.args`
attribute to get any potential quit messages.
+---
+
#### `IRC::Client::Message::Unknown`
##### `.Str`
@@ -149,6 +165,8 @@ attribute to get any potential quit messages.
Overrides the default stringification string to
`"❚⚠❚ :$.usermask $.command $.args[]"`
+---
+
#### `IRC::Client::Message::Mode`
Object is never sent to event handlers and merely provides commonality to
@@ -162,16 +180,22 @@ is the sign of the mode (`+` or `-`) and the value if the mode letter itself.
When modes are set on the client, contains just a list of modes as strings,
without any signs.
+---
+
#### `IRC::Client::Message::Mode::Channel`
##### `.channel`
Contains the channel on which the modes were set.
+---
+
#### `IRC::Client::Message::Mode::Me`
Does not offer any object-specific methods.
+---
+
#### `IRC::Client::Message::Notice`
Object is never sent to event handlers and merely provides commonality to
@@ -192,6 +216,8 @@ the event handler's value must not be used as a reply to the message.
Overrides stringification of the message object to be the value of the
`.text` attribute.
+---
+
#### `IRC::Client::Message::Notice::Channel`
##### `.channel`
@@ -211,6 +237,8 @@ optional `:where` argument specifies a channel or nick
where to send the message and defaults to the channel in which the message
originated.
+---
+
#### `IRC::Client::Message::Notice::Me`
##### `.reply`
@@ -226,6 +254,8 @@ optional `:where` argument specifies a nick or channel
where to send the message and defaults to the nick from which the message
originated.
+---
+
#### `IRC::Client::Message::Privmsg`
Object is never sent to event handlers and merely provides commonality to
@@ -246,6 +276,8 @@ the event handler's value must not be used as a reply to the message.
Overrides stringification of the message object to be the value of the
`.text` attribute.
+---
+
#### `IRC::Client::Message::Privmsg::Channel`
##### `.channel`
@@ -265,6 +297,8 @@ optional `:where` argument specifies a channel or nick
where to send the message and defaults to the channel in which the message
originated.
+---
+
#### `IRC::Client::Message::Privmsg::Me`
##### `.reply`
@@ -280,6 +314,8 @@ optional `:where` argument specifies a nick or channel
where to send the message and defaults to the nick from which the message
originated.
+---
+
## Up Next
Read [the method reference](03-method-reference.md) next.