4bd2dce434
- Fixed some nodes not matching how their docs describe how they function (such as node configuration should always take precedence over inputs)
101 lines
4.2 KiB
HTML
101 lines
4.2 KiB
HTML
<script type="text/javascript">
|
|
RED.nodes.registerType('matrix-send-file',{
|
|
category: 'matrix',
|
|
color: '#00b7ca',
|
|
icon: "matrix.png",
|
|
outputLabels: ["success", "error"],
|
|
inputs:1,
|
|
outputs:2,
|
|
defaults: {
|
|
name: { value: null },
|
|
server: { value: "", type: "matrix-server-config" },
|
|
roomId: { value: null },
|
|
contentType: { value: null }
|
|
},
|
|
label: function() {
|
|
return this.name || "Send File";
|
|
},
|
|
paletteLabel: 'Send File'
|
|
});
|
|
</script>
|
|
|
|
<script type="text/html" data-template-name="matrix-send-file">
|
|
<div class="form-row">
|
|
<label for="node-input-name"><i class="icon-tag"></i> Name</label>
|
|
<input type="text" id="node-input-name" placeholder="Name">
|
|
</div>
|
|
<div class="form-row">
|
|
<label for="node-input-server"><i class="fa fa-user"></i> Matrix Server Config</label>
|
|
<input type="text" id="node-input-server">
|
|
</div>
|
|
<div class="form-row">
|
|
<label for="node-input-roomId"><i class="fa fa-user"></i> Room ID</label>
|
|
<input type="text" id="node-input-roomId" placeholder="msg.topic">
|
|
</div>
|
|
<div class="form-row">
|
|
<label for="node-input-contentType"><i class="fa fa-user"></i> Content-Type</label>
|
|
<input type="text" id="node-input-contentType" placeholder="msg.contentType">
|
|
</div>
|
|
<div class="form-tips">
|
|
Must be a valid <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types" target="_blank">MIME Type</a> (ex: application/pdf) or left empty
|
|
</div>
|
|
</script>
|
|
|
|
<script type="text/html" data-help-name="matrix-send-file">
|
|
<h3>Details</h3>
|
|
<p>This node will send a file to a Matrix chat room. Supports direct linking to a File In node.</p>
|
|
|
|
<h3>Inputs</h3>
|
|
<dl class="message-properties">
|
|
<dt>msg.payload
|
|
<span class="property-type">File | string | Buffer | ReadStream | Blob</span>
|
|
</dt>
|
|
<dd> the contents of the file to upload. </dd>
|
|
|
|
<dt>msg.topic
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd> Room ID to send file to. Ignored if configured on the node, otherwise required.</dd>
|
|
|
|
<dt class="optional">msg.filename
|
|
<span class="property-type">string | null</span>
|
|
</dt>
|
|
<dd> name of the file to upload (optional). Note: If this is not defined the file will receive a randomly generated name (without an extension).</dd>
|
|
|
|
<dt class="optional">msg.body
|
|
<span class="property-type">string | null</span>
|
|
</dt>
|
|
<dd> this will be the display name the client will see when rendered in their chat client. If this is left empty it will just display as "Attachment".</dd>
|
|
|
|
<dt class="optional">msg.contentType
|
|
<span class="property-type">string | null</span>
|
|
</dt>
|
|
<dd> Content <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types" target="_blank">MIME Type</a>. Optional but highly recommended (so the client receiving knows what type of file it is).</dd>
|
|
|
|
<dt class="optional">msg.content
|
|
<span class="property-type">object | null</span>
|
|
</dt>
|
|
<dd> craft your own msg.content to send to the server. If defined then <code>msg.filename</code>, <code>msg.contentType</code>, <code>msg.body</code>, and <code>msg.payload</code> aren't required since the file already exists.</dd>
|
|
</dl>
|
|
|
|
<h3>Outputs</h3>
|
|
<ol class="node-ports">
|
|
<li>Success
|
|
<dl class="message-properties">
|
|
<dt>msg.eventId <span class="property-type">string</span></dt>
|
|
<dd>the eventId from the posted message.</dd>
|
|
</dl>
|
|
</li>
|
|
<li>Error
|
|
<dl class="message-properties">
|
|
<dt>msg.error <span class="property-type">string</span></dt>
|
|
<dd>the error that occurred.</dd>
|
|
</dl>
|
|
</li>
|
|
</ol>
|
|
|
|
<h3>References</h3>
|
|
<ul>
|
|
<li><a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types">MIME Types</a> - description of <code>msg.contentType</code> format</li>
|
|
</ul>
|
|
</script> |