mirror of https://github.com/matrix-org/go-neb.git
Kegan Dougal
8 years ago
13 changed files with 1005 additions and 419 deletions
-
23pkg/github.com/index.html
-
10pkg/github.com/matrix-org/go-neb/clients/index.html
-
23pkg/github.com/matrix-org/go-neb/index.html
-
314pkg/github.com/matrix-org/go-neb/plugin/index.html
-
67pkg/github.com/matrix-org/go-neb/services/echo/index.html
-
77pkg/github.com/matrix-org/go-neb/services/giphy/index.html
-
287pkg/github.com/matrix-org/go-neb/services/github/index.html
-
76pkg/github.com/matrix-org/go-neb/services/guggy/index.html
-
12pkg/github.com/matrix-org/go-neb/services/index.html
-
167pkg/github.com/matrix-org/go-neb/services/jira/index.html
-
134pkg/github.com/matrix-org/go-neb/services/rssbot/index.html
-
211pkg/github.com/matrix-org/go-neb/types/index.html
-
23pkg/github.com/matrix-org/index.html
@ -1,314 +0,0 @@ |
|||
<!DOCTYPE html> |
|||
<html> |
|||
<head> |
|||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
|||
<meta name="viewport" content="width=device-width, initial-scale=1"> |
|||
<meta name="theme-color" content="#375EAB"> |
|||
|
|||
<title>plugin - The Go Programming Language</title> |
|||
|
|||
<link type="text/css" rel="stylesheet" href="../../../../../lib/godoc/style.css"> |
|||
|
|||
<link rel="stylesheet" href="../../../../../lib/godoc/jquery.treeview.css"> |
|||
<script type="text/javascript">window.initFuncs = [];</script> |
|||
</head> |
|||
<body> |
|||
|
|||
<div id='lowframe' style="position: fixed; bottom: 0; left: 0; height: 0; width: 100%; border-top: thin solid grey; background-color: white; overflow: auto;"> |
|||
... |
|||
</div><!-- #lowframe --> |
|||
|
|||
<div id="topbar" class="wide"><div class="container"> |
|||
<div class="top-heading" id="heading-wide"><a href="http://localhost:6060/">The Go Programming Language</a></div> |
|||
<div class="top-heading" id="heading-narrow"><a href="http://localhost:6060/">Go</a></div> |
|||
<a href="index.html#" id="menu-button"><span id="menu-button-arrow">▽</span></a> |
|||
<form method="GET" action="http://localhost:6060/search"> |
|||
<div id="menu"> |
|||
<a href="http://localhost:6060/doc/">Documents</a> |
|||
<a href="http://localhost:6060/pkg/">Packages</a> |
|||
<a href="http://localhost:6060/project/">The Project</a> |
|||
<a href="http://localhost:6060/help/">Help</a> |
|||
<a href="http://localhost:6060/blog/">Blog</a> |
|||
|
|||
<input type="text" id="search" name="q" class="inactive" value="Search" placeholder="Search"> |
|||
</div> |
|||
</form> |
|||
|
|||
</div></div> |
|||
|
|||
|
|||
|
|||
<div id="page" class="wide"> |
|||
<div class="container"> |
|||
|
|||
|
|||
<h1>Package plugin</h1> |
|||
|
|||
|
|||
|
|||
|
|||
<div id="nav"></div> |
|||
|
|||
|
|||
<!-- |
|||
Copyright 2009 The Go Authors. All rights reserved. |
|||
Use of this source code is governed by a BSD-style |
|||
license that can be found in the LICENSE file. |
|||
--> |
|||
<!-- |
|||
Note: Static (i.e., not template-generated) href and id |
|||
attributes start with "pkg-" to make it impossible for |
|||
them to conflict with generated attributes (some of which |
|||
correspond to Go identifiers). |
|||
--> |
|||
|
|||
<script type='text/javascript'> |
|||
document.ANALYSIS_DATA = null; |
|||
document.CALLGRAPH = null; |
|||
</script> |
|||
|
|||
|
|||
|
|||
<div id="short-nav"> |
|||
<dl> |
|||
<dd><code>import "github.com/matrix-org/go-neb/plugin"</code></dd> |
|||
</dl> |
|||
<dl> |
|||
<dd><a href="index.html#pkg-overview" class="overviewLink">Overview</a></dd> |
|||
<dd><a href="index.html#pkg-index" class="indexLink">Index</a></dd> |
|||
|
|||
|
|||
</dl> |
|||
</div> |
|||
<!-- The package's Name is printed as title by the top-level template --> |
|||
<div id="pkg-overview" class="toggleVisible"> |
|||
<div class="collapsed"> |
|||
<h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2> |
|||
</div> |
|||
<div class="expanded"> |
|||
<h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2> |
|||
|
|||
</div> |
|||
</div> |
|||
|
|||
|
|||
<div id="pkg-index" class="toggleVisible"> |
|||
<div class="collapsed"> |
|||
<h2 class="toggleButton" title="Click to show Index section">Index ▹</h2> |
|||
</div> |
|||
<div class="expanded"> |
|||
<h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2> |
|||
|
|||
<!-- Table of contents for API; must be named manual-nav to turn off auto nav. --> |
|||
<div id="manual-nav"> |
|||
<dl> |
|||
|
|||
|
|||
|
|||
|
|||
<dd><a href="index.html#OnMessage">func OnMessage(plugins []Plugin, client *matrix.Client, event *matrix.Event)</a></dd> |
|||
|
|||
|
|||
|
|||
<dd><a href="index.html#Command">type Command</a></dd> |
|||
|
|||
|
|||
|
|||
|
|||
<dd><a href="index.html#Expansion">type Expansion</a></dd> |
|||
|
|||
|
|||
|
|||
|
|||
<dd><a href="index.html#Plugin">type Plugin</a></dd> |
|||
|
|||
|
|||
|
|||
|
|||
</dl> |
|||
</div><!-- #manual-nav --> |
|||
|
|||
|
|||
|
|||
|
|||
<h4>Package files</h4> |
|||
<p> |
|||
<span style="font-size:90%"> |
|||
|
|||
<a href="http://localhost:6060/src/github.com/matrix-org/go-neb/plugin/plugin.go">plugin.go</a> |
|||
|
|||
</span> |
|||
</p> |
|||
|
|||
</div><!-- .expanded --> |
|||
</div><!-- #pkg-index --> |
|||
|
|||
<div id="pkg-callgraph" class="toggle" style="display: none"> |
|||
<div class="collapsed"> |
|||
<h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2> |
|||
</div> <!-- .expanded --> |
|||
<div class="expanded"> |
|||
<h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2> |
|||
<p> |
|||
In the call graph viewer below, each node |
|||
is a function belonging to this package |
|||
and its children are the functions it |
|||
calls—perhaps dynamically. |
|||
</p> |
|||
<p> |
|||
The root nodes are the entry points of the |
|||
package: functions that may be called from |
|||
outside the package. |
|||
There may be non-exported or anonymous |
|||
functions among them if they are called |
|||
dynamically from another package. |
|||
</p> |
|||
<p> |
|||
Click a node to visit that function's source code. |
|||
From there you can visit its callers by |
|||
clicking its declaring <code>func</code> |
|||
token. |
|||
</p> |
|||
<p> |
|||
Functions may be omitted if they were |
|||
determined to be unreachable in the |
|||
particular programs or tests that were |
|||
analyzed. |
|||
</p> |
|||
<!-- Zero means show all package entry points. --> |
|||
<ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul> |
|||
</div> |
|||
</div> <!-- #pkg-callgraph --> |
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
<h2 id="OnMessage">func <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/plugin/plugin.go?s=5228:5304#L155">OnMessage</a></h2> |
|||
<pre>func OnMessage(plugins []<a href="index.html#Plugin">Plugin</a>, client *<a href="../matrix/index.html">matrix</a>.<a href="../matrix/index.html#Client">Client</a>, event *<a href="../matrix/index.html">matrix</a>.<a href="../matrix/index.html#Event">Event</a>)</pre> |
|||
<p> |
|||
OnMessage checks the message event to see whether it contains any commands |
|||
or expansions from the listed plugins and processes those commands or |
|||
expansions. |
|||
</p> |
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
<h2 id="Command">type <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/plugin/plugin.go?s=644:817#L12">Command</a></h2> |
|||
<pre>type Command struct { |
|||
Path []<a href="../../../../builtin/index.html#string">string</a> |
|||
Arguments []<a href="../../../../builtin/index.html#string">string</a> |
|||
Help <a href="../../../../builtin/index.html#string">string</a> |
|||
Command func(roomID, userID <a href="../../../../builtin/index.html#string">string</a>, arguments []<a href="../../../../builtin/index.html#string">string</a>) (content interface{}, err <a href="../../../../builtin/index.html#error">error</a>) |
|||
}</pre> |
|||
<p> |
|||
A Command is something that a user invokes by sending a message starting with '!' |
|||
followed by a list of strings that name the command, followed by a list of argument |
|||
strings. The argument strings may be quoted using '\"' and '\” in the same way |
|||
that they are quoted in the unix shell. |
|||
</p> |
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
<h2 id="Expansion">type <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/plugin/plugin.go?s=1073:1194#L23">Expansion</a></h2> |
|||
<pre>type Expansion struct { |
|||
Regexp *<a href="../../../../regexp/index.html">regexp</a>.<a href="../../../../regexp/index.html#Regexp">Regexp</a> |
|||
Expand func(roomID, userID <a href="../../../../builtin/index.html#string">string</a>, matchingGroups []<a href="../../../../builtin/index.html#string">string</a>) interface{} |
|||
}</pre> |
|||
<p> |
|||
An Expansion is something that actives when the user sends any message |
|||
containing a string matching a given pattern. For example an RFC expansion |
|||
might expand "RFC 6214" into "Adaptation of RFC 1149 for IPv6" and link to |
|||
the appropriate RFC. |
|||
</p> |
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
<h2 id="Plugin">type <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/plugin/plugin.go?s=276:344#L3">Plugin</a></h2> |
|||
<pre>type Plugin struct { |
|||
Commands []<a href="index.html#Command">Command</a> |
|||
Expansions []<a href="index.html#Expansion">Expansion</a> |
|||
}</pre> |
|||
<p> |
|||
A Plugin is a list of commands and expansions to apply to incoming messages. |
|||
</p> |
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
<div id="footer"> |
|||
Build version go1.6.<br> |
|||
Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>, |
|||
the content of this page is licensed under the |
|||
Creative Commons Attribution 3.0 License, |
|||
and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br> |
|||
<a href="http://localhost:6060/doc/tos.html">Terms of Service</a> | |
|||
<a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a> |
|||
</div> |
|||
|
|||
</div><!-- .container --> |
|||
</div><!-- #page --> |
|||
|
|||
<!-- TODO(adonovan): load these from <head> using "defer" attribute? --> |
|||
<script type="text/javascript" src="../../../../../lib/godoc/jquery.js"></script> |
|||
<script type="text/javascript" src="../../../../../lib/godoc/jquery.treeview.js"></script> |
|||
<script type="text/javascript" src="../../../../../lib/godoc/jquery.treeview.edit.js"></script> |
|||
|
|||
|
|||
<script type="text/javascript" src="../../../../../lib/godoc/godocs.js"></script> |
|||
|
|||
</body> |
|||
</html> |
|||
|
|||
Write
Preview
Loading…
Cancel
Save
Reference in new issue