|
| 1 | +<!DOCTYPE html> |
| 2 | +<html lang="en"> |
| 3 | + <head> |
| 4 | + <title>Classes Reference</title> |
| 5 | + <link rel="stylesheet" type="text/css" href="css/jazzy.css" /> |
| 6 | + <link rel="stylesheet" type="text/css" href="css/highlight.css" /> |
| 7 | + <meta charset='utf-8'> |
| 8 | + <script src="js/jquery.min.js" defer></script> |
| 9 | + <script src="js/jazzy.js" defer></script> |
| 10 | + |
| 11 | + <script src="js/lunr.min.js" defer></script> |
| 12 | + <script src="js/typeahead.jquery.js" defer></script> |
| 13 | + <script src="js/jazzy.search.js" defer></script> |
| 14 | + </head> |
| 15 | + <body> |
| 16 | + <a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a> |
| 17 | + <a title="Classes Reference"></a> |
| 18 | + <header> |
| 19 | + <div class="content-wrapper"> |
| 20 | + <p><a href="index.html">ButtonMerchant 1.4.5 Docs</a> (95% documented)</p> |
| 21 | + <div class="header-right"> |
| 22 | + <form role="search" action="search.json"> |
| 23 | + <input type="text" placeholder="Search documentation" data-typeahead> |
| 24 | + </form> |
| 25 | + </div> |
| 26 | + </div> |
| 27 | + </header> |
| 28 | + <div class="content-wrapper"> |
| 29 | + <p id="breadcrumbs"> |
| 30 | + <a href="index.html">ButtonMerchant Reference</a> |
| 31 | + <img id="carat" src="img/carat.png" alt=""/> |
| 32 | + Classes Reference |
| 33 | + </p> |
| 34 | + </div> |
| 35 | + <div class="content-wrapper"> |
| 36 | + <nav class="sidebar"> |
| 37 | + <ul class="nav-groups"> |
| 38 | + <li class="nav-group-name"> |
| 39 | + <a href="Classes.html">Classes</a> |
| 40 | + <ul class="nav-group-tasks"> |
| 41 | + <li class="nav-group-task"> |
| 42 | + <a href="Classes/ButtonMerchant.html">ButtonMerchant</a> |
| 43 | + </li> |
| 44 | + <li class="nav-group-task"> |
| 45 | + <a href="Classes/ButtonProduct.html">ButtonProduct</a> |
| 46 | + </li> |
| 47 | + <li class="nav-group-task"> |
| 48 | + <a href="Classes/Order.html">Order</a> |
| 49 | + </li> |
| 50 | + <li class="nav-group-task"> |
| 51 | + <a href="Classes/Order/Customer.html">– Customer</a> |
| 52 | + </li> |
| 53 | + <li class="nav-group-task"> |
| 54 | + <a href="Classes/Order/LineItem.html">– LineItem</a> |
| 55 | + </li> |
| 56 | + </ul> |
| 57 | + </li> |
| 58 | + <li class="nav-group-name"> |
| 59 | + <a href="Enums.html">Enumerations</a> |
| 60 | + <ul class="nav-group-tasks"> |
| 61 | + <li class="nav-group-task"> |
| 62 | + <a href="Enums/ButtonMerchantError.html">ButtonMerchantError</a> |
| 63 | + </li> |
| 64 | + <li class="nav-group-task"> |
| 65 | + <a href="Enums/ConfigurationError.html">ConfigurationError</a> |
| 66 | + </li> |
| 67 | + <li class="nav-group-task"> |
| 68 | + <a href="Enums/NetworkError.html">NetworkError</a> |
| 69 | + </li> |
| 70 | + </ul> |
| 71 | + </li> |
| 72 | + <li class="nav-group-name"> |
| 73 | + <a href="Protocols.html">Protocols</a> |
| 74 | + <ul class="nav-group-tasks"> |
| 75 | + <li class="nav-group-task"> |
| 76 | + <a href="Protocols/Activity.html">Activity</a> |
| 77 | + </li> |
| 78 | + <li class="nav-group-task"> |
| 79 | + <a href="Protocols/ButtonProductCompatible.html">ButtonProductCompatible</a> |
| 80 | + </li> |
| 81 | + <li class="nav-group-task"> |
| 82 | + <a href="Protocols/Configurable.html">Configurable</a> |
| 83 | + </li> |
| 84 | + </ul> |
| 85 | + </li> |
| 86 | + <li class="nav-group-name"> |
| 87 | + <a href="Structs.html">Structures</a> |
| 88 | + <ul class="nav-group-tasks"> |
| 89 | + <li class="nav-group-task"> |
| 90 | + <a href="Structs.html#/s:14ButtonMerchant7VersionV">Version</a> |
| 91 | + </li> |
| 92 | + </ul> |
| 93 | + </li> |
| 94 | + </ul> |
| 95 | + </nav> |
| 96 | + <article class="main-content"> |
| 97 | + <section> |
| 98 | + <section class="section"> |
| 99 | + <h1>Classes</h1> |
| 100 | + <p>The following classes are available globally.</p> |
| 101 | + |
| 102 | + </section> |
| 103 | + <section class="section task-group-section"> |
| 104 | + <div class="task-group"> |
| 105 | + <ul> |
| 106 | + <li class="item"> |
| 107 | + <div> |
| 108 | + <code> |
| 109 | + <a name="/c:@M@ButtonMerchant@objc(cs)ButtonMerchant"></a> |
| 110 | + <a name="//apple_ref/swift/Class/ButtonMerchant" class="dashAnchor"></a> |
| 111 | + <a class="token" href="#/c:@M@ButtonMerchant@objc(cs)ButtonMerchant">ButtonMerchant</a> |
| 112 | + </code> |
| 113 | + </div> |
| 114 | + <div class="height-container"> |
| 115 | + <div class="pointer-container"></div> |
| 116 | + <section class="section"> |
| 117 | + <div class="pointer"></div> |
| 118 | + <div class="abstract"> |
| 119 | + <p><code>ButtonMerchant</code> is the main entry point to the library.</p> |
| 120 | + |
| 121 | +<p>To get started with your integration, |
| 122 | +get your application Id from from the <a href="https://app.usebutton.com">Button Dashboard</a>. |
| 123 | +and follow our simple <a href="https://developer.usebutton.com/docs/ios-add-merchant-library">integration guide</a></p> |
| 124 | + |
| 125 | + <a href="Classes/ButtonMerchant.html" class="slightly-smaller">See more</a> |
| 126 | + </div> |
| 127 | + <div class="declaration"> |
| 128 | + <h4>Declaration</h4> |
| 129 | + <div class="language"> |
| 130 | + <p class="aside-title">Swift</p> |
| 131 | + <pre class="highlight swift"><code><span class="kd">@objcMembers</span> |
| 132 | +<span class="kd">final</span> <span class="kd">public</span> <span class="kd">class</span> <span class="kt">ButtonMerchant</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> |
| 133 | + |
| 134 | + </div> |
| 135 | + </div> |
| 136 | + </section> |
| 137 | + </div> |
| 138 | + </li> |
| 139 | + <li class="item"> |
| 140 | + <div> |
| 141 | + <code> |
| 142 | + <a name="/c:@M@ButtonMerchant@objc(cs)ButtonProduct"></a> |
| 143 | + <a name="//apple_ref/swift/Class/ButtonProduct" class="dashAnchor"></a> |
| 144 | + <a class="token" href="#/c:@M@ButtonMerchant@objc(cs)ButtonProduct">ButtonProduct</a> |
| 145 | + </code> |
| 146 | + </div> |
| 147 | + <div class="height-container"> |
| 148 | + <div class="pointer-container"></div> |
| 149 | + <section class="section"> |
| 150 | + <div class="pointer"></div> |
| 151 | + <div class="abstract"> |
| 152 | + <p>A concrete implementation of the ButtonProductCompatible protocol.</p> |
| 153 | + |
| 154 | + <a href="Classes/ButtonProduct.html" class="slightly-smaller">See more</a> |
| 155 | + </div> |
| 156 | + <div class="declaration"> |
| 157 | + <h4>Declaration</h4> |
| 158 | + <div class="language"> |
| 159 | + <p class="aside-title">Swift</p> |
| 160 | + <pre class="highlight swift"><code><span class="kd">final</span> <span class="kd">public</span> <span class="kd">class</span> <span class="kt">ButtonProduct</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt"><a href="Protocols/ButtonProductCompatible.html">ButtonProductCompatible</a></span><span class="p">,</span> <span class="kt">Codable</span></code></pre> |
| 161 | + |
| 162 | + </div> |
| 163 | + </div> |
| 164 | + </section> |
| 165 | + </div> |
| 166 | + </li> |
| 167 | + <li class="item"> |
| 168 | + <div> |
| 169 | + <code> |
| 170 | + <a name="/c:@M@ButtonMerchant@objc(cs)BTNOrder"></a> |
| 171 | + <a name="//apple_ref/swift/Class/Order" class="dashAnchor"></a> |
| 172 | + <a class="token" href="#/c:@M@ButtonMerchant@objc(cs)BTNOrder">Order</a> |
| 173 | + </code> |
| 174 | + </div> |
| 175 | + <div class="height-container"> |
| 176 | + <div class="pointer-container"></div> |
| 177 | + <section class="section"> |
| 178 | + <div class="pointer"></div> |
| 179 | + <div class="abstract"> |
| 180 | + <p>Represents an order placed by the user to be reported using <code>ButtonMerchant.reportOrder(order)</code>.</p> |
| 181 | + |
| 182 | + <a href="Classes/Order.html" class="slightly-smaller">See more</a> |
| 183 | + </div> |
| 184 | + <div class="declaration"> |
| 185 | + <h4>Declaration</h4> |
| 186 | + <div class="language"> |
| 187 | + <p class="aside-title">Swift</p> |
| 188 | + <pre class="highlight swift"><code><span class="kd">@objcMembers</span> |
| 189 | +<span class="kd">@objc(BTNOrder)</span> |
| 190 | +<span class="kd">final</span> <span class="kd">public</span> <span class="kd">class</span> <span class="kt">Order</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">Codable</span></code></pre> |
| 191 | + |
| 192 | + </div> |
| 193 | + </div> |
| 194 | + </section> |
| 195 | + </div> |
| 196 | + </li> |
| 197 | + </ul> |
| 198 | + </div> |
| 199 | + </section> |
| 200 | + </section> |
| 201 | + <section id="footer"> |
| 202 | + <p>Copyright © 2018 Button, Inc. All rights reserved. (<a href="https://usebutton.com">https://usebutton.com</a>) under <a class="link" href="https://github.com/button/button-merchant-ios-private/blob/master/LICENSE" target="_blank" rel="external noopener">MIT License</a>.</p> |
| 203 | + <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p> |
| 204 | + </section> |
| 205 | + </article> |
| 206 | + </div> |
| 207 | + </body> |
| 208 | +</html> |
0 commit comments