Untitled Git - bitcoindevkit.org/blob

   1 <!DOCTYPE html>
   2 <html class="no-js">
   3 <head>
   4     <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
   5     <title>DescriptorPublicKeyInterface</title>
   6     <link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
   7     <script>var pathToRoot = "../../../";</script>
   8     <script>document.documentElement.classList.replace("no-js","js");</script>
   9     <script>const storage = localStorage.getItem("dokka-dark-mode")
  10     if (storage == null) {
  11         const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
  12         if (osDarkSchemePreferred === true) {
  13             document.getElementsByTagName("html")[0].classList.add("theme-dark")
  14         }
  15     } else {
  16         const savedDarkMode = JSON.parse(storage)
  17         if(savedDarkMode === true) {
  18             document.getElementsByTagName("html")[0].classList.add("theme-dark")
  19         }
  20     }
  21     </script>
  22 <script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
  23 <script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
  24 <link href="../../../styles/style.css" rel="Stylesheet">
  25 <link href="../../../styles/main.css" rel="Stylesheet">
  26 <link href="../../../styles/prism.css" rel="Stylesheet">
  27 <link href="../../../styles/logo-styles.css" rel="Stylesheet">
  28 <link href="../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
  29 <link href="../../../ui-kit/ui-kit.min.css" rel="Stylesheet">
  30 <script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
  31 <script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
  32 <script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
  33 <script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
  34 <script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
  35 <script type="text/javascript" src="../../../ui-kit/ui-kit.min.js" defer="defer"></script>
  36 <script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
  37 </head>
  38 <body>
  39     <div class="root">
  40     <nav class="navigation theme-dark" id="navigation-wrapper">
  41             <a class="library-name--link" href="../../../index.html">
  42                     bdk-android
  43             </a>
  44         <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle"
  45                 type="button">Toggle table of contents
  46         </button>
  47         <div class="navigation-controls--break ui-kit_mobile-only"></div>
  48         <div class="library-version" id="library-version">
  49 1.1.0        </div>
  50         <div class="navigation-controls">
  51         <div class="filter-section filter-section_loading" id="filter-section">
  52                 <button class="platform-tag platform-selector jvm-like" data-active=""
  53                         data-filter=":lib/release">androidJvm</button>
  54             <div class="dropdown filter-section--dropdown" data-role="dropdown" id="filter-section-dropdown">
  55                 <button class="button button_dropdown filter-section--dropdown-toggle" role="combobox"
  56                         data-role="dropdown-toggle"
  57                         aria-controls="platform-tags-listbox"
  58                         aria-haspopup="listbox"
  59                         aria-expanded="false"
  60                         aria-label="Toggle source sets"
  61                 ></button>
  62                 <ul role="listbox" id="platform-tags-listbox" class="dropdown--list" data-role="dropdown-listbox">
  63                     <div class="dropdown--header"><span>Platform filter</span>
  64                         <button class="button" data-role="dropdown-toggle" aria-label="Close platform filter">
  65                             <i class="ui-kit-icon ui-kit-icon_cross"></i>
  66                         </button>
  67                     </div>
  68                         <li role="option" class="dropdown--option platform-selector-option jvm-like" tabindex="0">
  69                             <label class="checkbox">
  70                                 <input type="checkbox" class="checkbox--input" id=":lib/release"
  71                                        data-filter=":lib/release"/>
  72                                 <span class="checkbox--icon"></span>
  73                                 androidJvm
  74                             </label>
  75                         </li>
  76                 </ul>
  77                 <div class="dropdown--overlay"></div>
  78             </div>
  79         </div>
  80             <button class="navigation-controls--btn navigation-controls--btn_theme" id="theme-toggle-button"
  81                     type="button">Switch theme
  82             </button>
  83             <div class="navigation-controls--btn navigation-controls--btn_search" id="searchBar" role="button">Search in
  84                 API
  85             </div>
  86         </div>
  87     </nav>
  88         <div id="container">
  89             <div class="sidebar" id="leftColumn">
  90                 <div class="dropdown theme-dark_mobile" data-role="dropdown" id="toc-dropdown">
  91                     <ul role="listbox" id="toc-listbox" class="dropdown--list dropdown--list_toc-list"
  92                         data-role="dropdown-listbox">
  93                         <div class="dropdown--header">
  94                             <span>
  95                                     bdk-android
  96                             </span>
  97                             <button class="button" data-role="dropdown-toggle" aria-label="Close table of contents">
  98                                 <i class="ui-kit-icon ui-kit-icon_cross"></i>
  99                             </button>
 100                         </div>
 101                         <div class="sidebar--inner" id="sideMenu"></div>
 102                     </ul>
 103                     <div class="dropdown--overlay"></div>
 104                 </div>
 105             </div>
 106             <div id="main">
 107 <div class="main-content" data-page-type="classlike" id="content" pageIds="bdk-android::org.bitcoindevkit/DescriptorPublicKeyInterface///PointingToDeclaration//300442814">
 108   <div class="breadcrumbs"><a href="../../../index.html">bdk-android</a><span class="delimiter">/</span><a href="../index.html">org.bitcoindevkit</a><span class="delimiter">/</span><span class="current">DescriptorPublicKeyInterface</span></div>
 109   <div class="cover ">
 110     <h1 class="cover"><span>Descriptor</span><wbr></wbr><span>Public</span><wbr></wbr><span>Key</span><wbr></wbr><span><span>Interface</span></span></h1>
 111     <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib/release"><div class="symbol monospace"><span class="token keyword">interface </span><a href="index.html">DescriptorPublicKeyInterface</a></div><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":lib/release" data-filterable-set=":lib/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-descriptor-public-key/index.html">DescriptorPublicKey</a></div></span></div><div></div></div></div></div></div></div>
 112   </div>
 113   <div class="tabbedcontent">
 114     <div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
 115     <div class="tabs-section-body">
 116       <div data-togglable="TYPE">
 117         <h2 class="">Types</h2>
 118         <div class="table"><a data-name="198114631%2FClasslikes%2F300442814" anchor-label="Companion" id="198114631%2FClasslikes%2F300442814" data-filterable-set=":lib/release"></a>
 119           <div class="table-row" data-filterable-current=":lib/release" data-filterable-set=":lib/release">
 120             <div class="main-subrow keyValue ">
 121               <div class=""><span class="inline-flex">
 122                   <div><a href="-companion/index.html"><span><span>Companion</span></span></a></div>
 123 <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="198114631%2FClasslikes%2F300442814"></span>
 124                     <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
 125                   </span></span></div>
 126               <div>
 127                 <div class="title">
 128                   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib/release"><div class="symbol monospace"><span class="token keyword">object </span><a href="-companion/index.html">Companion</a></div></div></div>
 129                 </div>
 130               </div>
 131             </div>
 132           </div>
 133         </div>
 134       </div>
 135       <div data-togglable="FUNCTION">
 136         <h2 class="">Functions</h2>
 137         <div class="table"><a data-name="-1789881961%2FFunctions%2F300442814" anchor-label="asString" id="-1789881961%2FFunctions%2F300442814" data-filterable-set=":lib/release"></a>
 138           <div class="table-row" data-filterable-current=":lib/release" data-filterable-set=":lib/release">
 139             <div class="main-subrow keyValue ">
 140               <div class=""><span class="inline-flex">
 141                   <div><a href="as-string.html"><span>as</span><wbr></wbr><span><span>String</span></span></a></div>
 142 <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1789881961%2FFunctions%2F300442814"></span>
 143                     <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
 144                   </span></span></div>
 145               <div>
 146                 <div class="title">
 147                   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">fun </span><a href="as-string.html"><span class="token function">asString</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a></div></div></div>
 148                 </div>
 149               </div>
 150             </div>
 151           </div>
 152 <a data-name="780437630%2FFunctions%2F300442814" anchor-label="derive" id="780437630%2FFunctions%2F300442814" data-filterable-set=":lib/release"></a>
 153           <div class="table-row" data-filterable-current=":lib/release" data-filterable-set=":lib/release">
 154             <div class="main-subrow keyValue ">
 155               <div class=""><span class="inline-flex">
 156                   <div><a href="derive.html"><span><span>derive</span></span></a></div>
 157 <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="780437630%2FFunctions%2F300442814"></span>
 158                     <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
 159                   </span></span></div>
 160               <div>
 161                 <div class="title">
 162                   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">fun </span><a href="derive.html"><span class="token function">derive</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">path<span class="token operator">: </span><a href="../-derivation-path/index.html">DerivationPath</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-descriptor-public-key/index.html">DescriptorPublicKey</a></div></div></div>
 163                 </div>
 164               </div>
 165             </div>
 166           </div>
 167 <a data-name="1828121579%2FFunctions%2F300442814" anchor-label="extend" id="1828121579%2FFunctions%2F300442814" data-filterable-set=":lib/release"></a>
 168           <div class="table-row" data-filterable-current=":lib/release" data-filterable-set=":lib/release">
 169             <div class="main-subrow keyValue ">
 170               <div class=""><span class="inline-flex">
 171                   <div><a href="extend.html"><span><span>extend</span></span></a></div>
 172 <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1828121579%2FFunctions%2F300442814"></span>
 173                     <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
 174                   </span></span></div>
 175               <div>
 176                 <div class="title">
 177                   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">fun </span><a href="extend.html"><span class="token function">extend</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">path<span class="token operator">: </span><a href="../-derivation-path/index.html">DerivationPath</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-descriptor-public-key/index.html">DescriptorPublicKey</a></div></div></div>
 178                 </div>
 179               </div>
 180             </div>
 181           </div>
 182 <a data-name="370771692%2FFunctions%2F300442814" anchor-label="isMultipath" id="370771692%2FFunctions%2F300442814" data-filterable-set=":lib/release"></a>
 183           <div class="table-row" data-filterable-current=":lib/release" data-filterable-set=":lib/release">
 184             <div class="main-subrow keyValue ">
 185               <div class=""><span class="inline-flex">
 186                   <div><a href="is-multipath.html"><span>is</span><wbr></wbr><span><span>Multipath</span></span></a></div>
 187 <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="370771692%2FFunctions%2F300442814"></span>
 188                     <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
 189                   </span></span></div>
 190               <div>
 191                 <div class="title">
 192                   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">fun </span><a href="is-multipath.html"><span class="token function">isMultipath</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Whether or not this key has multiple derivation paths.</p></div></div></div>
 193                 </div>
 194               </div>
 195             </div>
 196           </div>
 197 <a data-name="884043294%2FFunctions%2F300442814" anchor-label="masterFingerprint" id="884043294%2FFunctions%2F300442814" data-filterable-set=":lib/release"></a>
 198           <div class="table-row" data-filterable-current=":lib/release" data-filterable-set=":lib/release">
 199             <div class="main-subrow keyValue ">
 200               <div class=""><span class="inline-flex">
 201                   <div><a href="master-fingerprint.html"><span>master</span><wbr></wbr><span><span>Fingerprint</span></span></a></div>
 202 <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="884043294%2FFunctions%2F300442814"></span>
 203                     <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
 204                   </span></span></div>
 205               <div>
 206                 <div class="title">
 207                   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">fun </span><a href="master-fingerprint.html"><span class="token function">masterFingerprint</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The fingerprint of the master key associated with this key, <code class="lang-kotlin">0x00000000</code> if none.</p></div></div></div>
 208                 </div>
 209               </div>
 210             </div>
 211           </div>
 212         </div>
 213       </div>
 214     </div>
 215   </div>
 216 </div>
 217     <div class="footer">
 218         <a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
 219         <span>(c) Bitcoin Dev Kit Developers</span>
 220         <span class="pull-right">
 221             <span>Generated by </span>
 222             <a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">
 223                 <span>dokka</span>
 224             </a>
 225         </span>
 226     </div>
 227             </div>
 228         </div>
 229     </div>
 230 </body>
 231 </html>