diff options
Diffstat (limited to 'docs/03-method-reference.md')
| -rw-r--r-- | docs/03-method-reference.md | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/docs/03-method-reference.md b/docs/03-method-reference.md index 6963d64..25893b6 100644 --- a/docs/03-method-reference.md +++ b/docs/03-method-reference.md @@ -1,5 +1,98 @@ [[back to doc map]](README.md) +# TABLE OF CONTENTS +- [Method Reference](#method-reference) + - [Message Objects (`IRC::Client::Message` and subclasses)](#message-objects-ircclientmessage-and-subclasses) + - [Message Object Hierarchy](#message-object-hierarchy) + - [Methods and Attributes](#methods-and-attributes) + - [`IRC::Client::Message`](#ircclientmessage) + - [`.irc`](#irc) + - [`.nick`](#nick) + - [`.username`](#username) + - [`.host`](#host) + - [`.usermask`](#usermask) + - [`.command`](#command) + - [`.server`](#server) + - [`.args`](#args) + - [`.Str`](#str) + - [`IRC::Client::Message::Join`](#ircclientmessagejoin) + - [`.channel`](#channel) + - [`IRC::Client::Message::Nick`](#ircclientmessagenick) + - [`.new-nick`](#new-nick) + - [`IRC::Client::Message::Numeric`](#ircclientmessagenumeric) + - [`IRC::Client::Message::Part`](#ircclientmessagepart) + - [`.channel`](#channel-1) + - [`IRC::Client::Message::Ping`](#ircclientmessageping) + - [`.reply`](#reply) + - [`IRC::Client::Message::Quit`](#ircclientmessagequit) + - [`IRC::Client::Message::Unknown`](#ircclientmessageunknown) + - [`.Str`](#str-1) + - [`IRC::Client::Message::Mode`](#ircclientmessagemode) + - [`.modes`](#modes) + - [`IRC::Client::Message::Mode::Channel`](#ircclientmessagemodechannel) + - [`.channel`](#channel-2) + - [`IRC::Client::Message::Mode::Me`](#ircclientmessagemodeme) + - [`IRC::Client::Message::Notice`](#ircclientmessagenotice) + - [`.text`](#text) + - [`.replied`](#replied) + - [`.Str`](#str-2) + - [`IRC::Client::Message::Notice::Channel`](#ircclientmessagenoticechannel) + - [`.channel`](#channel-3) + - [`.reply`](#reply-1) + - [`IRC::Client::Message::Notice::Me`](#ircclientmessagenoticeme) + - [`.reply`](#reply-2) + - [`IRC::Client::Message::Privmsg`](#ircclientmessageprivmsg) + - [`.text`](#text-1) + - [`.replied`](#replied-1) + - [`.Str`](#str-3) + - [`IRC::Client::Message::Privmsg::Channel`](#ircclientmessageprivmsgchannel) + - [`.channel`](#channel-4) + - [`.reply`](#reply-3) + - [`IRC::Client::Message::Privmsg::Me`](#ircclientmessageprivmsgme) + - [`.reply`](#reply-4) + - [Server Object (`IRC::Client::Server`)](#server-object-ircclientserver) + - [Labels](#labels) + - [Methods and Attributes](#methods-and-attributes-1) + - [`.label`](#label) + - [`.channels`](#channels) + - [`.nick`](#nick-1) + - [`.alias`](#alias) + - [`.host`](#host-1) + - [`.port`](#port) + - [`.password`](#password) + - [`.username`](#username-1) + - [`.userhost`](#userhost) + - [`.userreal`](#userreal) + - [`.Str`](#str-4) + - [Writable Non-Writable Attributes](#writable-non-writable-attributes) + - [`.current-nick`](#current-nick) + - [`.is-connected`](#is-connected) + - [`.has-quit`](#has-quit) + - [`.has-quit`](#has-quit-1) + - [Client Object (`IRC::Client`)](#client-object-ircclient) + - [Methods and Attributes](#methods-and-attributes-2) + - [`.join`](#join) + - [`.new`](#new) + - [`:channels`](#channels-1) + - [`:debug`](#debug) + - [`:filters`](#filters) + - [`:host`](#host-2) + - [`:nick`](#nick-2) + - [`:alias`](#alias-1) + - [`:password`](#password-1) + - [`:plugins`](#plugins) + - [`:port`](#port-1) + - [`:servers`](#servers) + - [`:username`](#username-2) + - [`:userhost`](#userhost-1) + - [`:userreal`](#userreal-1) + - [`.nick`](#nick-3) + - [`.part`](#part) + - [`.quit`](#quit) + - [`.run`](#run) + - [`.send`](#send) + - [Up Next](#up-next) + # Method Reference This document describes events available on various objects in use when working |