-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of https://github.com/superwall-me/paywall-ios
- Loading branch information
Showing
10 changed files
with
2,459 additions
and
0 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
108 changes: 108 additions & 0 deletions
108
paywall-ios/Paywall_PaywallNetworkEnvironment/index.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| <title>Paywall - Paywall.PaywallNetworkEnvironment</title> | ||
| <link rel="stylesheet" type="text/css" href="./all.css" media="all" /> | ||
| </head> | ||
| <body> | ||
| <header> | ||
| <a href="./"> | ||
| <strong> | ||
| Paywall | ||
| </strong> | ||
| <span>Documentation</span> | ||
| </a> | ||
| </header> | ||
|
|
||
| <!-- | ||
| <form class="search"> | ||
| <input type="search" placeholder="Search" /> | ||
| </form> | ||
| --> | ||
|
|
||
| <nav> | ||
| <div class="wrapper"> | ||
| <h2>On This Page</h2> | ||
| <ol><li><a href="#relationships">Relationships</a><ul><li><a href="#relationships">Member Of</a></li></ul></li><li><a href="#enumeration cases">Enumeration Cases</a><ul><li class="case"><a href="#paywall.paywallnetworkenvironment.release">release</a></li><li class="case"><a href="#paywall.paywallnetworkenvironment.releasecandidate">releaseCandidate</a></li><li class="case"><a href="#paywall.paywallnetworkenvironment.developer">developer</a></li></ul></li></ol> | ||
| </div> | ||
| </nav> | ||
|
|
||
| <main> | ||
| <article> | ||
| <h1> | ||
| <small>Enumeration</small> | ||
| <code class="name">Paywall.PaywallNetworkEnvironment</code> | ||
| </h1> | ||
|
|
||
| <div class="declaration"> | ||
| <pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">enum</span> <span class="type">PaywallNetworkEnvironment</span> </body></html></code></pre> | ||
| </div> | ||
| <div class="summary" role="doc-abstract"> | ||
| <p>WARNING: Only use this enum to set <code>Paywall.networkEnvironment</code> if told so explicitly by the Superwall team.</p> | ||
|
|
||
| </div> | ||
| <section id="relationships"> | ||
| <h2 hidden>Relationships</h2> | ||
|
|
||
| <h3>Member Of</h3> | ||
| <dl> | ||
| <dt class="class"><code><a href="./Paywall">Paywall</a></code></dt> | ||
| <dd><p><code>Paywall</code> is the primary class for integrating Superwall into your application. To learn more, read our iOS getting started guide: https://docs.superwall.me/docs/ios</p> | ||
| </dd> | ||
| </dl> | ||
| </section> | ||
| <section id="enumeration cases"> | ||
| <h2>Enumeration Cases</h2> | ||
|
|
||
| <div role="article" class="case" id="paywall.paywallnetworkenvironment.release"> | ||
| <h3> | ||
| <code><a href="#paywall.paywallnetworkenvironment.release">release</a></code> | ||
| </h3> | ||
| <div class="declaration"> | ||
| <pre class="highlight"><code><html><body><span class="keyword">case</span> <span class="variable">release</span></body></html></code></pre> | ||
| </div> | ||
| <div class="summary" role="doc-abstract"> | ||
| <p>Default: Use the standard latest environment</p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <div role="article" class="case" id="paywall.paywallnetworkenvironment.releasecandidate"> | ||
| <h3> | ||
| <code><a href="#paywall.paywallnetworkenvironment.releasecandidate">releaseCandidate</a></code> | ||
| </h3> | ||
| <div class="declaration"> | ||
| <pre class="highlight"><code><html><body><span class="keyword">case</span> <span class="variable">releaseCandidate</span></body></html></code></pre> | ||
| </div> | ||
| <div class="summary" role="doc-abstract"> | ||
| <p>Use a release candidate environment</p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <div role="article" class="case" id="paywall.paywallnetworkenvironment.developer"> | ||
| <h3> | ||
| <code><a href="#paywall.paywallnetworkenvironment.developer">developer</a></code> | ||
| </h3> | ||
| <div class="declaration"> | ||
| <pre class="highlight"><code><html><body><span class="keyword">case</span> <span class="variable">developer</span></body></html></code></pre> | ||
| </div> | ||
| <div class="summary" role="doc-abstract"> | ||
| <p>Use the nightly build environment</p> | ||
|
|
||
| </div> | ||
| </div> | ||
| </section> | ||
|
|
||
|
|
||
|
|
||
| </article> | ||
| </main> | ||
|
|
||
| <footer> | ||
| <p> | ||
| Generated on <time datetime="2021-09-14T04:43:51+0000">September 14, 2021</time> using <a href="https://github.com/SwiftDocOrg/swift-doc">swift-doc</a> <span class="version">1.0.0-rc.1</span>. | ||
| </p> | ||
| </footer> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,228 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| <title>Paywall - Paywall.StandardEvent</title> | ||
| <link rel="stylesheet" type="text/css" href="./all.css" media="all" /> | ||
| </head> | ||
| <body> | ||
| <header> | ||
| <a href="./"> | ||
| <strong> | ||
| Paywall | ||
| </strong> | ||
| <span>Documentation</span> | ||
| </a> | ||
| </header> | ||
|
|
||
| <!-- | ||
| <form class="search"> | ||
| <input type="search" placeholder="Search" /> | ||
| </form> | ||
| --> | ||
|
|
||
| <nav> | ||
| <div class="wrapper"> | ||
| <h2>On This Page</h2> | ||
| <ol><li><a href="#relationships">Relationships</a><ul><li><a href="#relationships">Member Of</a></li></ul></li><li><a href="#enumeration cases">Enumeration Cases</a><ul><li class="case"><a href="#paywall.standardevent.deeplinkopen">deepLinkOpen</a></li><li class="case"><a href="#paywall.standardevent.onboardingstart">onboardingStart</a></li><li class="case"><a href="#paywall.standardevent.onboardingcomplete">onboardingComplete</a></li><li class="case"><a href="#paywall.standardevent.pushnotificationreceive">pushNotificationReceive</a></li><li class="case"><a href="#paywall.standardevent.pushnotificationopen">pushNotificationOpen</a></li><li class="case"><a href="#paywall.standardevent.coresessionstart">coreSessionStart</a></li><li class="case"><a href="#paywall.standardevent.coresessionabandon">coreSessionAbandon</a></li><li class="case"><a href="#paywall.standardevent.coresessioncomplete">coreSessionComplete</a></li><li class="case"><a href="#paywall.standardevent.signup">signUp</a></li><li class="case"><a href="#paywall.standardevent.login">logIn</a></li><li class="case"><a href="#paywall.standardevent.logout">logOut</a></li><li class="case"><a href="#paywall.standardevent.userattributes">userAttributes</a></li><li class="case"><a href="#paywall.standardevent.base">base</a></li></ul></li></ol> | ||
| </div> | ||
| </nav> | ||
|
|
||
| <main> | ||
| <article> | ||
| <h1> | ||
| <small>Enumeration</small> | ||
| <code class="name">Paywall.StandardEvent</code> | ||
| </h1> | ||
|
|
||
| <div class="declaration"> | ||
| <pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">enum</span> <span class="type">StandardEvent</span> </body></html></code></pre> | ||
| </div> | ||
| <div class="summary" role="doc-abstract"> | ||
| <p>Standard events for use in conjunction with <code>Paywall.track(_ event: StandardEvent, _ params: [String: Any] = [:])</code>.</p> | ||
|
|
||
| </div> | ||
| <section id="relationships"> | ||
| <h2 hidden>Relationships</h2> | ||
|
|
||
| <h3>Member Of</h3> | ||
| <dl> | ||
| <dt class="class"><code><a href="./Paywall">Paywall</a></code></dt> | ||
| <dd><p><code>Paywall</code> is the primary class for integrating Superwall into your application. To learn more, read our iOS getting started guide: https://docs.superwall.me/docs/ios</p> | ||
| </dd> | ||
| </dl> | ||
| </section> | ||
| <section id="enumeration cases"> | ||
| <h2>Enumeration Cases</h2> | ||
|
|
||
| <div role="article" class="case" id="paywall.standardevent.deeplinkopen"> | ||
| <h3> | ||
| <code><a href="#paywall.standardevent.deeplinkopen">deepLinkOpen</a></code> | ||
| </h3> | ||
| <div class="declaration"> | ||
| <pre class="highlight"><code><html><body><span class="keyword">case</span> <span class="variable">deepLinkOpen</span>(<span class="variable">deepLinkUrl</span>: <span class="type">URL</span>) </body></html></code></pre> | ||
| </div> | ||
| <div class="summary" role="doc-abstract"> | ||
| <p>Standard even used to track when a user opens your application by way of a deep link.</p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <div role="article" class="case" id="paywall.standardevent.onboardingstart"> | ||
| <h3> | ||
| <code><a href="#paywall.standardevent.onboardingstart">onboardingStart</a></code> | ||
| </h3> | ||
| <div class="declaration"> | ||
| <pre class="highlight"><code><html><body><span class="keyword">case</span> <span class="variable">onboardingStart</span></body></html></code></pre> | ||
| </div> | ||
| <div class="summary" role="doc-abstract"> | ||
| <p>Standard even used to track when a user begins onboarding.</p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <div role="article" class="case" id="paywall.standardevent.onboardingcomplete"> | ||
| <h3> | ||
| <code><a href="#paywall.standardevent.onboardingcomplete">onboardingComplete</a></code> | ||
| </h3> | ||
| <div class="declaration"> | ||
| <pre class="highlight"><code><html><body><span class="keyword">case</span> <span class="variable">onboardingComplete</span></body></html></code></pre> | ||
| </div> | ||
| <div class="summary" role="doc-abstract"> | ||
| <p>Standard even used to track when a user completes onboarding.</p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <div role="article" class="case" id="paywall.standardevent.pushnotificationreceive"> | ||
| <h3> | ||
| <code><a href="#paywall.standardevent.pushnotificationreceive">pushNotificationReceive</a></code> | ||
| </h3> | ||
| <div class="declaration"> | ||
| <pre class="highlight"><code><html><body><span class="keyword">case</span> <span class="variable">pushNotificationReceive</span>(<span class="variable">superwallId</span>: <span class="type">String</span>? = <span class="keyword">nil</span>) </body></html></code></pre> | ||
| </div> | ||
| <div class="summary" role="doc-abstract"> | ||
| <p>Standard even used to track when a user receives a push notification.</p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <div role="article" class="case" id="paywall.standardevent.pushnotificationopen"> | ||
| <h3> | ||
| <code><a href="#paywall.standardevent.pushnotificationopen">pushNotificationOpen</a></code> | ||
| </h3> | ||
| <div class="declaration"> | ||
| <pre class="highlight"><code><html><body><span class="keyword">case</span> <span class="variable">pushNotificationOpen</span>(<span class="variable">superwallId</span>: <span class="type">String</span>? = <span class="keyword">nil</span>) </body></html></code></pre> | ||
| </div> | ||
| <div class="summary" role="doc-abstract"> | ||
| <p>Standard even used to track when a user launches your application by way of a push notification.</p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <div role="article" class="case" id="paywall.standardevent.coresessionstart"> | ||
| <h3> | ||
| <code><a href="#paywall.standardevent.coresessionstart">coreSessionStart</a></code> | ||
| </h3> | ||
| <div class="declaration"> | ||
| <pre class="highlight"><code><html><body><span class="keyword">case</span> <span class="variable">coreSessionStart</span></body></html></code></pre> | ||
| </div> | ||
| <div class="summary" role="doc-abstract"> | ||
| <p>Standard even used to track when a user completes a 'Core Session' of your app. For example, if your app is a workout app, you should call this when a workout begins.</p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <div role="article" class="case" id="paywall.standardevent.coresessionabandon"> | ||
| <h3> | ||
| <code><a href="#paywall.standardevent.coresessionabandon">coreSessionAbandon</a></code> | ||
| </h3> | ||
| <div class="declaration"> | ||
| <pre class="highlight"><code><html><body><span class="keyword">case</span> <span class="variable">coreSessionAbandon</span></body></html></code></pre> | ||
| </div> | ||
| <div class="summary" role="doc-abstract"> | ||
| <p>Standard even used to track when a user completes a 'Core Session' of your app. For example, if your app is a workout app, you should call this when a workout is cancelled or aborted.</p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <div role="article" class="case" id="paywall.standardevent.coresessioncomplete"> | ||
| <h3> | ||
| <code><a href="#paywall.standardevent.coresessioncomplete">coreSessionComplete</a></code> | ||
| </h3> | ||
| <div class="declaration"> | ||
| <pre class="highlight"><code><html><body><span class="keyword">case</span> <span class="variable">coreSessionComplete</span></body></html></code></pre> | ||
| </div> | ||
| <div class="summary" role="doc-abstract"> | ||
| <p>Standard even used to track when a user completes a 'Core Session' of your app. For example, if your app is a workout app, you should call this when a workout is completed.</p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <div role="article" class="case" id="paywall.standardevent.signup"> | ||
| <h3> | ||
| <code><a href="#paywall.standardevent.signup">signUp</a></code> | ||
| </h3> | ||
| <div class="declaration"> | ||
| <pre class="highlight"><code><html><body><span class="keyword">case</span> <span class="variable">signUp</span></body></html></code></pre> | ||
| </div> | ||
| <div class="summary" role="doc-abstract"> | ||
| <p>Standard even used to track when a user signs up.</p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <div role="article" class="case" id="paywall.standardevent.login"> | ||
| <h3> | ||
| <code><a href="#paywall.standardevent.login">logIn</a></code> | ||
| </h3> | ||
| <div class="declaration"> | ||
| <pre class="highlight"><code><html><body><span class="keyword">case</span> <span class="variable">logIn</span></body></html></code></pre> | ||
| </div> | ||
| <div class="summary" role="doc-abstract"> | ||
| <p>Standard even used to track when a user logs in to your application.</p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <div role="article" class="case" id="paywall.standardevent.logout"> | ||
| <h3> | ||
| <code><a href="#paywall.standardevent.logout">logOut</a></code> | ||
| </h3> | ||
| <div class="declaration"> | ||
| <pre class="highlight"><code><html><body><span class="keyword">case</span> <span class="variable">logOut</span></body></html></code></pre> | ||
| </div> | ||
| <div class="summary" role="doc-abstract"> | ||
| <p>Standard even used to track when a user logs out of your application. Not to be confused with <code>Paywall.reset()</code> — this event is strictly for analytical purposes.</p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <div role="article" class="case" id="paywall.standardevent.userattributes"> | ||
| <h3> | ||
| <code><a href="#paywall.standardevent.userattributes">userAttributes</a></code> | ||
| </h3> | ||
| <div class="declaration"> | ||
| <pre class="highlight"><code><html><body><span class="keyword">case</span> <span class="variable">userAttributes</span>(<span class="variable">standard</span>: [<span class="type">StandardUserAttributeKey</span>: <span class="keyword">Any</span>?], <span class="variable">custom</span>: [<span class="type">String</span>: <span class="keyword">Any</span>?]) </body></html></code></pre> | ||
| </div> | ||
| <div class="summary" role="doc-abstract"> | ||
| <p>WARNING: Use <code>setUserAttributes(_ standard: StandardUserAttribute..., custom: [String: Any?] = [:])</code> instead.</p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <div role="article" class="case" id="paywall.standardevent.base"> | ||
| <h3> | ||
| <code><a href="#paywall.standardevent.base">base</a></code> | ||
| </h3> | ||
| <div class="declaration"> | ||
| <pre class="highlight"><code><html><body><span class="keyword">case</span> <span class="variable">base</span>(<span class="variable">name</span>: <span class="type">String</span>, <span class="variable">params</span>: [<span class="type">String</span>: <span class="keyword">Any</span>]) </body></html></code></pre> | ||
| </div> | ||
| <div class="summary" role="doc-abstract"> | ||
| <p>WARNING: This is used internally, ignore please</p> | ||
|
|
||
| </div> | ||
| </div> | ||
| </section> | ||
|
|
||
|
|
||
|
|
||
| </article> | ||
| </main> | ||
|
|
||
| <footer> | ||
| <p> | ||
| Generated on <time datetime="2021-09-14T04:43:51+0000">September 14, 2021</time> using <a href="https://github.com/SwiftDocOrg/swift-doc">swift-doc</a> <span class="version">1.0.0-rc.1</span>. | ||
| </p> | ||
| </footer> | ||
| </body> | ||
| </html> |
Oops, something went wrong.