UNPKG

node-red-contrib-filemaker

Version:

Node-RED FileMaker nodes. These nodes use the FileMaker Data API to connect with a FileMaker database.

89 lines (82 loc) 2.97 kB
<script type="text/javascript"> RED.nodes.registerType("dapi-layouts", { category: "FileMaker", defaults: { name: { value: null, required: false }, client: { value: "", type: "dapi-client" }, output: { value: "payload", required: true } }, inputs: 1, outputs: 1, icon: "layouts.png", color: "#39D1C0", label: function() { return this.name || "Database Layouts"; }, paletteLabel: "Layouts", oneditprepare: function() { $("#node-input-output").typedInput({ default: "msg", types: ["msg"] }); } }); </script> <script type="text/x-red" data-template-name="dapi-layouts"> <div class="form-row"> <label for="node-input-name"><i class="fa fa-tag" aria-hidden="true"></i> <span>Name</span></label> <input type="text" id="node-input-name" placeholder="Specific Node"> </div> <hr> <div class="form-row"> <label for="node-input-client"><i class="fa fa-cogs" aria-hidden="true"></i> <span>Client</span></label> <input type="text" id="node-input-client"> </div> <hr> <div class="form-row"> <label for="node-input-output"><i class="fa fa-arrow-circle-o-right" aria-hidden="true"></i> <span>Output</span></label> <input type="hidden" id="node-input-outputType"> <input type="text" id="node-input-output"> </div> </script> <script type="text/x-red" data-help-name="dapi-layouts"> <p> This node gets the available layouts and layout folders for the client's database. </p> <h3>Inputs</h3> <dl class="message-properties"> <dt>payload <span class="property-type">Any</span> <dd>This node accepts any payload.</dd> </dt> </dl> <h3>Outputs</h3> <ol class="node-ports"> <li>Standard Output <dl class="message-properties"> <dt>layouts<span class="property-type">Array</span> <dd>An array of layout and layout folder objects.</dd> </dt> </dl> </li> <li>Standard Error <dl class="message-properties"> <dt>message <span class="property-type">String</span> <dd>The FileMaker or client error message.</dd> </dt> </dl> </li> </ol> <h3>Details</h3> <p> This node gets database layout and layout folders. This node will list layout metadata for the client's configured database.<br/><br/> The default output of this node is <code>msg.payload</code>. This node can also be configured to merge its output with any property on the <code>msg</code> object. </p> <h3>References</h3> <ul> <li><a href="https://github.com/Luidog/fms-api-client#get-layouts">Get Layouts Method</a> - Base Client Method Documentation</li> <li><a href="https://github.com/Luidog/node-red-contrib-filemaker">Node-RED FileMaker</a> - The Node's Github Repository</li> <li><a href="https://github.com/Luidog/fms-api-client">Data API Client</a> - Data API Client Github Repository</li> </ul> </script>