mirror of
https://github.com/node-red/node-red-nodes.git
synced 2023-10-10 13:36:58 +02:00
68 lines
2.7 KiB
HTML
68 lines
2.7 KiB
HTML
|
|
||
|
|
<script type="text/x-red" data-help-name="irc in">
|
||
|
|
<p>Connects to a channel on an IRC server.</p>
|
||
|
|
<p>You may join multiple channels by comma separating a list - #chan1,#chan2,#etc.</p>
|
||
|
|
<p>Any messages on that channel will appear on the <code>msg.payload</code> at the output,
|
||
|
|
while <code>msg.topic</code> will contain who it is from.
|
||
|
|
<code>msg.to</code> contains either the name of the channel or PRIV in the case of a pm.</p>
|
||
|
|
<p>The second output provides a <code>msg.payload</code> that has any status messages such as joins, parts, kicks etc.</p>
|
||
|
|
<p>The type of the status message is set as <code>msg.payload.type</code>.</p>
|
||
|
|
<p>The possible status types are: <br />
|
||
|
|
<table border="1" cellpadding="1" cellspacing="1">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th scope="col">Type</th>
|
||
|
|
<th scope="col">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>message</td>
|
||
|
|
<td>message is sent into the channel</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>pm</td>
|
||
|
|
<td>private message to the bot</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>join</td>
|
||
|
|
<td>a user joined the channel (also triggered when the bot joins a channel)</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>invite</td>
|
||
|
|
<td>the bot is being invited to a channel</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>part</td>
|
||
|
|
<td>a user leaves a channel</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>quit</td>
|
||
|
|
<td>a user quits a channel</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>kick</td>
|
||
|
|
<td>a user is kicked from a channel</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>topic</td>
|
||
|
|
<td>a topic has been changed on a joined channel</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>names</td>
|
||
|
|
<td>retrieves the list of users when the bot joins a channel</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</p>
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<script type="text/x-red" data-help-name="irc out">
|
||
|
|
<p>Sends messages to a channel on an IRC server</p>
|
||
|
|
<p>You can send just the <code>msg.payload</code>, or the complete <code>msg</code> object to the selected channel,
|
||
|
|
or you can select to use <code>msg.topic</code> to send the <code>msg.payload</code> to a specific user (private message) or channel.</p>
|
||
|
|
<p>If multiple output channels are listed (eg. #chan1,#chan2), then the message will be sent to all of them.</p>
|
||
|
|
<p><b>Note:</b> you can only send to channels you have previously joined so they MUST be specified in the node - even if you then decide to use a subset in msg.topic</p>
|
||
|
|
<p>You may send RAW commands using <code>msg.raw</code> - This must contain an array of parameters - eg. <pre>["privmsg","#nodered","Hello world"]</pre></p>
|
||
|
|
</script>
|