Skip to content

Commit

Permalink
Adds missing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vegaro committed Nov 14, 2019
1 parent 44212a8 commit 13ea1ef
Show file tree
Hide file tree
Showing 167 changed files with 3,723 additions and 710 deletions.
69 changes: 46 additions & 23 deletions docs/purchases/alltypes/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,33 +11,34 @@ <h3>All Types</h3>
<tbody>
<tr>
<td>
<a href="../com.revenuecat.purchases.interfaces/-callback/index.html">com.revenuecat.purchases.interfaces.Callback</a></td>
<a href="../com.revenuecat.purchases/-build-config/index.html">com.revenuecat.purchases.BuildConfig</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.revenuecat.purchases/-callback-cache-key.html">com.revenuecat.purchases.CallbackCacheKey</a></td>
<a href="../com.revenuecat.purchases/-build-config/index.html">com.revenuecat.purchases.BuildConfig</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.revenuecat.purchases.interfaces/-callback/index.html">com.revenuecat.purchases.interfaces.Callback</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.revenuecat.purchases/-entitlement/index.html">com.revenuecat.purchases.Entitlement</a></td>
<a href="../com.revenuecat.purchases/-entitlement-info/index.html">com.revenuecat.purchases.EntitlementInfo</a></td>
<td>
<p>An entitlement represents features or content that a user is "entitled" to.
Entitlements are unlocked by having an active subscription or making a one-time purchase.
Many different products can unlock. Most subscription apps only have one entitlement,
unlocking all premium features. However, if you had two tiers of content such as premium and
premium_plus, you would have 2 entitlements. A common and simple setup example is one entitlement
with identifier pro, one offering monthly, with one product.
See <a href="https://docs.revenuecat.com/docs/entitlements">this link</a> for more info</p>
<p>This object gives you access to all of the information about the status of a user's entitlements.</p>
</td>
</tr>
<tr>
<td>
<a href="../com.revenuecat.purchases/-entitlement-map-callback.html">com.revenuecat.purchases.EntitlementMapCallback</a></td>
<a href="../com.revenuecat.purchases/-entitlement-infos/index.html">com.revenuecat.purchases.EntitlementInfos</a></td>
<td>
<p>This class contains all the entitlements associated to the user.</p>
</td>
</tr>
<tr>
Expand All @@ -58,36 +59,44 @@ <h3>All Types</h3>
<td>
<a href="../com.revenuecat.purchases/-offering/index.html">com.revenuecat.purchases.Offering</a></td>
<td>
<p>Most well monetized subscription apps provide many different offerings to purchase an
entitlement. These are usually associated with different durations i.e. an annual plan and a
monthly plan.
See <a href="https://docs.revenuecat.com/docs/entitlements">this link</a> for more info</p>
<p>An offering is a collection of <a href="../com.revenuecat.purchases/-package/index.html">Package</a> available for the user to purchase.
For more info see https://docs.revenuecat.com/docs/entitlements</p>
</td>
</tr>
<tr>
<td>
<a href="../com.revenuecat.purchases/-post-receipt-callback.html">com.revenuecat.purchases.PostReceiptCallback</a></td>
<a href="../com.revenuecat.purchases/-offerings/index.html">com.revenuecat.purchases.Offerings</a></td>
<td>
<p>This class contains all the offerings configured in RevenueCat dashboard.
For more info see https://docs.revenuecat.com/docs/entitlements</p>
</td>
</tr>
<tr>
<td>
<a href="../com.revenuecat.purchases.interfaces/-purchase-completed-listener/index.html">com.revenuecat.purchases.interfaces.PurchaseCompletedListener</a></td>
<a href="../com.revenuecat.purchases/-package/index.html">com.revenuecat.purchases.Package</a></td>
<td>
<p>Interface to be implemented when making purchases.</p>
<p>Contains information about the product available for the user to purchase. For more info see https://docs.revenuecat.com/docs/entitlements</p>
</td>
</tr>
<tr>
<td>
<a href="../com.revenuecat.purchases/-purchaser-info/index.html">com.revenuecat.purchases.PurchaserInfo</a></td>
<a href="../com.revenuecat.purchases/-package-type/index.html">com.revenuecat.purchases.PackageType</a></td>
<td>
<p>Class containing all information regarding the purchaser</p>
<p>Enumeration of all possible Package types.</p>
</td>
</tr>
<tr>
<td>
<a href="../com.revenuecat.purchases/-purchaser-info-callback.html">com.revenuecat.purchases.PurchaserInfoCallback</a></td>
<a href="../com.revenuecat.purchases/-period-type/index.html">com.revenuecat.purchases.PeriodType</a></td>
<td>
<p>Enum of supported period types for an entitlement.</p>
</td>
</tr>
<tr>
<td>
<a href="../com.revenuecat.purchases/-purchaser-info/index.html">com.revenuecat.purchases.PurchaserInfo</a></td>
<td>
<p>Class containing all information regarding the purchaser</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -116,9 +125,9 @@ <h3>All Types</h3>
</tr>
<tr>
<td>
<a href="../com.revenuecat.purchases.interfaces/-receive-entitlements-listener/index.html">com.revenuecat.purchases.interfaces.ReceiveEntitlementsListener</a></td>
<a href="../com.revenuecat.purchases.interfaces/-receive-offerings-listener/index.html">com.revenuecat.purchases.interfaces.ReceiveOfferingsListener</a></td>
<td>
<p>Interface to be implemented when making calls to fetch [Entitlement]</p>
<p>Interface to be implemented when making calls to fetch [Offering].</p>
</td>
</tr>
<tr>
Expand All @@ -130,11 +139,25 @@ <h3>All Types</h3>
</tr>
<tr>
<td>
<a href="../com.revenuecat.purchases/-store/index.html">com.revenuecat.purchases.Store</a></td>
<td>
<p>Enum of supported stores</p>
</td>
</tr>
<tr>
<td>
<a href="../com.revenuecat.purchases.interfaces/-updated-purchaser-info-listener/index.html">com.revenuecat.purchases.interfaces.UpdatedPurchaserInfoListener</a></td>
<td>
<p>Used to handle async updates from [Purchases]. This interface should be implemented to receive updates when the [PurchaserInfo] changes.</p>
</td>
</tr>
<tr>
<td>
<a href="../com.revenuecat.purchases/-upgrade-info/index.html">com.revenuecat.purchases.UpgradeInfo</a></td>
<td>
<p>This object holds the information used when upgrading from another sku.</p>
</td>
</tr>
</tbody>
</table>
</BODY>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ <h3>Functions</h3>
<p><a href="on-error.html">onError</a></p>
</td>
<td>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">onError</span><span class="symbol">(</span><span class="identifier" id="com.revenuecat.purchases.interfaces.MakePurchaseListener$onError(com.revenuecat.purchases.PurchasesError, kotlin.Boolean)/error">error</span><span class="symbol">:</span>&nbsp;<a href="../../com.revenuecat.purchases/-purchases-error/index.html"><span class="identifier">PurchasesError</span></a><span class="symbol">, </span><span class="identifier" id="com.revenuecat.purchases.interfaces.MakePurchaseListener$onError(com.revenuecat.purchases.PurchasesError, kotlin.Boolean)/userCancelled">userCancelled</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a><span class="symbol">!</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">onError</span><span class="symbol">(</span><span class="identifier" id="com.revenuecat.purchases.interfaces.MakePurchaseListener$onError(com.revenuecat.purchases.PurchasesError, kotlin.Boolean)/error">error</span><span class="symbol">:</span>&nbsp;<a href="../../com.revenuecat.purchases/-purchases-error/index.html"><span class="identifier">PurchasesError</span></a><span class="symbol">, </span><span class="identifier" id="com.revenuecat.purchases.interfaces.MakePurchaseListener$onError(com.revenuecat.purchases.PurchasesError, kotlin.Boolean)/userCancelled">userCancelled</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
<p>Will be called after the purchase has completed with error</p>
</td>
</tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@
<br/>
<h1>onError</h1>
<a name="com.revenuecat.purchases.interfaces.MakePurchaseListener$onError(com.revenuecat.purchases.PurchasesError, kotlin.Boolean)"></a>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">onError</span><span class="symbol">(</span><span class="identifier">@NonNull</span> <span class="identifier" id="com.revenuecat.purchases.interfaces.MakePurchaseListener$onError(com.revenuecat.purchases.PurchasesError, kotlin.Boolean)/error">error</span><span class="symbol">:</span>&nbsp;<a href="../../com.revenuecat.purchases/-purchases-error/index.html"><span class="identifier">PurchasesError</span></a><span class="symbol">, </span><span class="identifier" id="com.revenuecat.purchases.interfaces.MakePurchaseListener$onError(com.revenuecat.purchases.PurchasesError, kotlin.Boolean)/userCancelled">userCancelled</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a><span class="symbol">!</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">onError</span><span class="symbol">(</span><span class="identifier">@NonNull</span> <span class="identifier" id="com.revenuecat.purchases.interfaces.MakePurchaseListener$onError(com.revenuecat.purchases.PurchasesError, kotlin.Boolean)/error">error</span><span class="symbol">:</span>&nbsp;<a href="../../com.revenuecat.purchases/-purchases-error/index.html"><span class="identifier">PurchasesError</span></a><span class="symbol">, </span><span class="identifier" id="com.revenuecat.purchases.interfaces.MakePurchaseListener$onError(com.revenuecat.purchases.PurchasesError, kotlin.Boolean)/userCancelled">userCancelled</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
<p>Will be called after the purchase has completed with error</p>
<h3>Parameters</h3>
<p><a name="error"></a>
<code>error</code> - <a href="../../com.revenuecat.purchases/-purchases-error/index.html"><span class="identifier">PurchasesError</span></a><span class="symbol">:</span> A [PurchasesError] containing the reason for the failure when making the purchase</p>
<p><a name="userCancelled"></a>
<code>userCancelled</code> - <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a><span class="symbol">!</span><span class="symbol">:</span> A boolean indicating if the user cancelled the purchase. In that case the error will also be [PurchasesErrorCode.PurchaseCancelledError]</p>
<code>userCancelled</code> - <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a><span class="symbol">:</span> A boolean indicating if the user cancelled the purchase. In that case the error will also be [PurchasesErrorCode.PurchaseCancelledError]</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>ReceiveOfferingsListener - purchases</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">purchases</a>&nbsp;/&nbsp;<a href="../index.html">com.revenuecat.purchases.interfaces</a>&nbsp;/&nbsp;<a href="./index.html">ReceiveOfferingsListener</a><br/>
<br/>
<h1>ReceiveOfferingsListener</h1>
<code><span class="keyword">interface </span><span class="identifier">ReceiveOfferingsListener</span></code>
<p>Interface to be implemented when making calls to fetch [Offering].</p>
<h3>Functions</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="on-error.html">onError</a></p>
</td>
<td>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">onError</span><span class="symbol">(</span><span class="identifier" id="com.revenuecat.purchases.interfaces.ReceiveOfferingsListener$onError(com.revenuecat.purchases.PurchasesError)/error">error</span><span class="symbol">:</span>&nbsp;<a href="../../com.revenuecat.purchases/-purchases-error/index.html"><span class="identifier">PurchasesError</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
<p>Will be called after an error fetching offerings</p>
</td>
</tr>
<tr>
<td>
<p><a href="on-received.html">onReceived</a></p>
</td>
<td>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">onReceived</span><span class="symbol">(</span><span class="identifier" id="com.revenuecat.purchases.interfaces.ReceiveOfferingsListener$onReceived(com.revenuecat.purchases.Offerings)/offerings">offerings</span><span class="symbol">:</span>&nbsp;<a href="../../com.revenuecat.purchases/-offerings/index.html"><span class="identifier">Offerings</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
<p>Will be called after a successful fetch of offerings.</p>
</td>
</tr>
</tbody>
</table>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>ReceiveOfferingsListener.onError - purchases</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">purchases</a>&nbsp;/&nbsp;<a href="../index.html">com.revenuecat.purchases.interfaces</a>&nbsp;/&nbsp;<a href="index.html">ReceiveOfferingsListener</a>&nbsp;/&nbsp;<a href="./on-error.html">onError</a><br/>
<br/>
<h1>onError</h1>
<a name="com.revenuecat.purchases.interfaces.ReceiveOfferingsListener$onError(com.revenuecat.purchases.PurchasesError)"></a>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">onError</span><span class="symbol">(</span><span class="identifier">@NonNull</span> <span class="identifier" id="com.revenuecat.purchases.interfaces.ReceiveOfferingsListener$onError(com.revenuecat.purchases.PurchasesError)/error">error</span><span class="symbol">:</span>&nbsp;<a href="../../com.revenuecat.purchases/-purchases-error/index.html"><span class="identifier">PurchasesError</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
<p>Will be called after an error fetching offerings</p>
<h3>Parameters</h3>
<p><a name="error"></a>
<code>error</code> - <a href="../../com.revenuecat.purchases/-purchases-error/index.html"><span class="identifier">PurchasesError</span></a><span class="symbol">:</span> A [PurchasesError] containing the reason for the failure when fetching offerings.</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>ReceiveOfferingsListener.onReceived - purchases</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">purchases</a>&nbsp;/&nbsp;<a href="../index.html">com.revenuecat.purchases.interfaces</a>&nbsp;/&nbsp;<a href="index.html">ReceiveOfferingsListener</a>&nbsp;/&nbsp;<a href="./on-received.html">onReceived</a><br/>
<br/>
<h1>onReceived</h1>
<a name="com.revenuecat.purchases.interfaces.ReceiveOfferingsListener$onReceived(com.revenuecat.purchases.Offerings)"></a>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">onReceived</span><span class="symbol">(</span><span class="identifier">@NonNull</span> <span class="identifier" id="com.revenuecat.purchases.interfaces.ReceiveOfferingsListener$onReceived(com.revenuecat.purchases.Offerings)/offerings">offerings</span><span class="symbol">:</span>&nbsp;<a href="../../com.revenuecat.purchases/-offerings/index.html"><span class="identifier">Offerings</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
<p>Will be called after a successful fetch of offerings.</p>
<h3>Parameters</h3>
<p><a name="offerings"></a>
<code>offerings</code> - <a href="../../com.revenuecat.purchases/-offerings/index.html"><span class="identifier">Offerings</span></a><span class="symbol">:</span> </p>
</BODY>
</HTML>
15 changes: 3 additions & 12 deletions docs/purchases/com.revenuecat.purchases.interfaces/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,20 +38,11 @@ <h3>Types</h3>
</tr>
<tr>
<td>
<p><a href="-purchase-completed-listener/index.html">PurchaseCompletedListener</a></p>
<p><a href="-receive-offerings-listener/index.html">ReceiveOfferingsListener</a></p>
</td>
<td>
<code><span class="keyword">interface </span><span class="identifier">PurchaseCompletedListener</span></code>
<p>Interface to be implemented when making purchases.</p>
</td>
</tr>
<tr>
<td>
<p><a href="-receive-entitlements-listener/index.html">ReceiveEntitlementsListener</a></p>
</td>
<td>
<code><span class="keyword">interface </span><span class="identifier">ReceiveEntitlementsListener</span></code>
<p>Interface to be implemented when making calls to fetch [Entitlement]</p>
<code><span class="keyword">interface </span><span class="identifier">ReceiveOfferingsListener</span></code>
<p>Interface to be implemented when making calls to fetch [Offering].</p>
</td>
</tr>
<tr>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>BuildConfig.APPLICATION_ID - purchases</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">purchases</a>&nbsp;/&nbsp;<a href="../index.html">com.revenuecat.purchases</a>&nbsp;/&nbsp;<a href="index.html">BuildConfig</a>&nbsp;/&nbsp;<a href="./-a-p-p-l-i-c-a-t-i-o-n_-i-d.html">APPLICATION_ID</a><br/>
<br/>
<h1>APPLICATION_ID</h1>
<a name="com.revenuecat.purchases.BuildConfig$APPLICATION_ID"></a>
<code><span class="keyword">static</span> <span class="keyword">val </span><span class="identifier">APPLICATION_ID</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code><br/>
<a name="com.revenuecat.purchases.BuildConfig$APPLICATION_ID"></a>
<code><span class="keyword">static</span> <span class="keyword">val </span><span class="identifier">APPLICATION_ID</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>BuildConfig.BUILD_TYPE - purchases</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">purchases</a>&nbsp;/&nbsp;<a href="../index.html">com.revenuecat.purchases</a>&nbsp;/&nbsp;<a href="index.html">BuildConfig</a>&nbsp;/&nbsp;<a href="./-b-u-i-l-d_-t-y-p-e.html">BUILD_TYPE</a><br/>
<br/>
<h1>BUILD_TYPE</h1>
<a name="com.revenuecat.purchases.BuildConfig$BUILD_TYPE"></a>
<code><span class="keyword">static</span> <span class="keyword">val </span><span class="identifier">BUILD_TYPE</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code><br/>
<a name="com.revenuecat.purchases.BuildConfig$BUILD_TYPE"></a>
<code><span class="keyword">static</span> <span class="keyword">val </span><span class="identifier">BUILD_TYPE</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code>
</BODY>
</HTML>
Loading

0 comments on commit 13ea1ef

Please sign in to comment.