ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-06 22:05:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
07f36e127f76b72df57e8101979f014d9d221353
xahau.js/docs/interfaces/AccountSetFlagsInterface.html
ledhed2222 7d6d119e4c correctly document stuff (#1878)
2021-12-17 19:03:54 -05:00

6 lines
13 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AccountSetFlagsInterface | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="AccountSetFlagsInterface.html">AccountSetFlagsInterface</a></li></ul><h1>Interface AccountSetFlagsInterface</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Map of flags to boolean values representing <a href="AccountSet.html">AccountSet</a> transaction
flags.</p>
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-typescript"><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">accountSetTx</span><span class="hl-1">: </span><span class="hl-9">AccountSet</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-4">TransactionType:</span><span class="hl-1"> </span><span class="hl-7">&#39;AccountSet&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">Account:</span><span class="hl-1"> </span><span class="hl-7">&#39;rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">Flags:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">tfOptionalDestTag:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">tfRequireAuth:</span><span class="hl-1"> </span><span class="hl-0">true</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-5">// Autofill the tx to see how flags actually look compared to the interface usage.</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">autofilledTx</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">client</span><span class="hl-1">.</span><span class="hl-3">autofill</span><span class="hl-1">(</span><span class="hl-4">accountSetTx</span><span class="hl-1">)</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">autofilledTx</span><span class="hl-1">)</span><br/><span class="hl-5">// {</span><br/><span class="hl-5">// TransactionType: &#39;AccountSet&#39;,</span><br/><span class="hl-5">// Account: &#39;rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn&#39;,</span><br/><span class="hl-5">// Flags: 393216,</span><br/><span class="hl-5">// Sequence: 1,</span><br/><span class="hl-5">// Fee: &#39;12&#39;,</span><br/><span class="hl-5">// LastLedgerSequence: 21971793</span><br/><span class="hl-5">// }</span>
</code></pre>
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">AccountSetFlagsInterface</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSetFlagsInterface.html#tfAllowXRP" class="tsd-kind-icon">tf<wbr/>AllowXRP</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSetFlagsInterface.html#tfDisallowXRP" class="tsd-kind-icon">tf<wbr/>DisallowXRP</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSetFlagsInterface.html#tfOptionalAuth" class="tsd-kind-icon">tf<wbr/>Optional<wbr/>Auth</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSetFlagsInterface.html#tfOptionalDestTag" class="tsd-kind-icon">tf<wbr/>Optional<wbr/>Dest<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSetFlagsInterface.html#tfRequireAuth" class="tsd-kind-icon">tf<wbr/>Require<wbr/>Auth</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSetFlagsInterface.html#tfRequireDestTag" class="tsd-kind-icon">tf<wbr/>Require<wbr/>Dest<wbr/>Tag</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tfAllowXRP" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>AllowXRP</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>AllowXRP<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/46a8adca/packages/xrpl/src/models/transactions/accountSet.ts#L105">packages/xrpl/src/models/transactions/accountSet.ts:105</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tfDisallowXRP" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>DisallowXRP</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>DisallowXRP<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/46a8adca/packages/xrpl/src/models/transactions/accountSet.ts#L104">packages/xrpl/src/models/transactions/accountSet.ts:104</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tfOptionalAuth" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>Optional<wbr/>Auth</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Optional<wbr/>Auth<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/46a8adca/packages/xrpl/src/models/transactions/accountSet.ts#L103">packages/xrpl/src/models/transactions/accountSet.ts:103</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tfOptionalDestTag" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>Optional<wbr/>Dest<wbr/>Tag</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Optional<wbr/>Dest<wbr/>Tag<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/46a8adca/packages/xrpl/src/models/transactions/accountSet.ts#L101">packages/xrpl/src/models/transactions/accountSet.ts:101</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tfRequireAuth" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>Require<wbr/>Auth</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Require<wbr/>Auth<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/46a8adca/packages/xrpl/src/models/transactions/accountSet.ts#L102">packages/xrpl/src/models/transactions/accountSet.ts:102</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tfRequireDestTag" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>Require<wbr/>Dest<wbr/>Tag</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Require<wbr/>Dest<wbr/>Tag<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/46a8adca/packages/xrpl/src/models/transactions/accountSet.ts#L100">packages/xrpl/src/models/transactions/accountSet.ts:100</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="AccountSetFlagsInterface.html" class="tsd-kind-icon">Account<wbr/>Set<wbr/>Flags<wbr/>Interface</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSetFlagsInterface.html#tfAllowXRP" class="tsd-kind-icon">tf<wbr/>AllowXRP</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSetFlagsInterface.html#tfDisallowXRP" class="tsd-kind-icon">tf<wbr/>DisallowXRP</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSetFlagsInterface.html#tfOptionalAuth" class="tsd-kind-icon">tf<wbr/>Optional<wbr/>Auth</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSetFlagsInterface.html#tfOptionalDestTag" class="tsd-kind-icon">tf<wbr/>Optional<wbr/>Dest<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSetFlagsInterface.html#tfRequireAuth" class="tsd-kind-icon">tf<wbr/>Require<wbr/>Auth</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSetFlagsInterface.html#tfRequireDestTag" class="tsd-kind-icon">tf<wbr/>Require<wbr/>Dest<wbr/>Tag</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink