mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-05 05:15:48 +00:00
3e55066b70
* rename: branch develop -> main; master -> old-master * Update all references to `master` and `develop` * Update the GitHub pages docs Co-authored-by: Jackson Mills <jmills@ripple.com>, Elliot Lee <intelliot@ripple.com>
27 lines
17 KiB
HTML
27 lines
17 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AccountObjectsResponse | 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="AccountObjectsResponse.html">AccountObjectsResponse</a></li></ul><h1>Interface AccountObjectsResponse</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>Response expected from an <a href="AccountObjectsRequest.html">AccountObjectsRequest</a>.</p>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseResponse</span><ul class="tsd-hierarchy"><li><span class="target">AccountObjectsResponse</span></li></ul></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 tsd-is-inherited"><a href="AccountObjectsResponse.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountObjectsResponse.html#result" class="tsd-kind-icon">result</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#status" class="tsd-kind-icon">status</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#warning" class="tsd-kind-icon">warning</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#warnings" class="tsd-kind-icon">warnings</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 tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version</h3><div class="tsd-signature tsd-kind-icon">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseResponse.api_version</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L31">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="forwarded" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3><div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from BaseResponse.forwarded</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L30">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:30</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3>id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseResponse.id</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L24">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="result" class="tsd-anchor"></a><h3>result</h3><div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>account_objects<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AccountObject</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>ledger_current_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>marker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><p>Overrides BaseResponse.result</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountObjects.ts#L77">ripple-lib/packages/xrpl/src/models/methods/accountObjects.ts:77</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Unique Address of the account this request corresponds to.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5>account_<wbr/>objects<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AccountObject</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Array of objects owned by this account. Each object is in its raw
|
|
ledger format.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>current_<wbr/>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The ledger index of the current in-progress ledger version, which was
|
|
used to generate this response.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The identifying hash of the ledger that was used to generate this
|
|
response.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The ledger index of the ledger version that was used to generate this
|
|
response.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The limit that was used in this request, if any.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> marker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Server-defined value indicating the response is paginated. Pass this to
|
|
the next call to resume where this call left off. Omitted when there are
|
|
no additional pages after this one.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>If included and set to true, the information in this response comes from
|
|
a validated ledger version. Otherwise, the information is subject to
|
|
change.</p>
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="status" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3><div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseResponse.status</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L25">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseResponse.type</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L26">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="warning" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3><div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"load"</span></div><aside class="tsd-sources"><p>Inherited from BaseResponse.warning</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L28">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="warnings" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3><div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseResponse.warnings</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L29">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:29</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="AccountObjectsResponse.html" class="tsd-kind-icon">Account<wbr/>Objects<wbr/>Response</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountObjectsResponse.html#result" class="tsd-kind-icon">result</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#status" class="tsd-kind-icon">status</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#warning" class="tsd-kind-icon">warning</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#warnings" class="tsd-kind-icon">warnings</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> |