Skip to content

Commit

Permalink
Update docs for 1.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
partnerizeJosh committed Sep 23, 2021
1 parent 8ee6678 commit 44100ce
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 5 deletions.
35 changes: 32 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,10 @@

<li class="nav-item" data-level="1"><a href="#resources" class="nav-link">Resources</a>
<ul class="nav flex-column">
<li class="nav-item" data-level="2"><a href="#click" class="nav-link">Click</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#conversion" class="nav-link">Conversion</a>
<ul class="nav flex-column">
</ul>
Expand Down Expand Up @@ -148,8 +152,24 @@ <h3 id="manual-installation">Manual Installation</h3>
<h3 id="example-app">Example app</h3>
<p>There is an example app provided <a href="https://github.com/PerformanceHorizonGroup/partnerize-mobile-sdk-ios/tree/master/SampleCode">here</a> for Swift.</p>
<h1 id="handling-inbound-clicks">Handling inbound clicks</h1>
<p>When an inbound intent from a mobile web browser or iOS app launches your iOS app via a deep link. This prepares an internal conversion object using Universal Link for further use and returns a new url containing original url with the <code>app_clickref</code> parameter stripped.</p>
<p>when conversion is completed.</p>
<p>When an inbound intent from a mobile web browser or iOS app launches your iOS app via a deep link. This prepares an internal conversion object using Universal Link for further use and returns a new url containing original url with the <code>app_clickref</code> parameter stripped when conversion is completed.</p>
<p>To return the full click object, use the following method.</p>
<pre><code class="language-swift">
func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -&gt; Void) -&gt; Bool {

if userActivity.activityType == NSUserActivityTypeBrowsingWeb {
let click = try? Partnerize.beginConversion(userActivity.webpageURL)

let clickRef = click?.clickRef
let camRef = click?.camRef
let destination = click?.destination
let utmParams = click?.utmParams
let meta = click?.meta
}
}

</code></pre>
<p>Alternatively, if just the destination URL is required, use the following method.</p>
<pre><code class="language-swift">func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -&gt; Void) -&gt; Bool {

if userActivity.activityType == NSUserActivityTypeBrowsingWeb {
Expand All @@ -166,6 +186,15 @@ <h2 id="posting-conversions-to-partnerize">Posting Conversions to Partnerize</h2
}
</code></pre>
<h1 id="resources">Resources</h1>
<h2 id="click">Click</h2>
<p>The <code>Click</code> class describes attributes and items within a click. This is returned from the method <code>Partnerize.beginConversion(conversionUrl)</code>.</p>
<pre><code class="language-swift"> let clickRef = click?.clickRef
let camRef = click?.camRef
let destination = click?.destination
let destinationMobile = click?.destinationMobile
let utmParams = click?.utmParams
let meta = click?.meta
</code></pre>
<h2 id="conversion">Conversion</h2>
<p>The <code>Conversion</code> class describes attributes and items within a conversion. This is accessed as a property on the <code>Partnerize</code> class.</p>
<pre><code class="language-swift"> Partnerize.conversion?.adRef = &quot;myAddRef&quot;
Expand Down Expand Up @@ -298,5 +327,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>

<!--
MkDocs version : 1.2.2
Build Date UTC : 2021-09-15 14:49:33.451709+00:00
Build Date UTC : 2021-09-23 10:22:00.883566+00:00
-->
Loading

0 comments on commit 44100ce

Please sign in to comment.