Skip to content

Commit

Permalink
chore: update API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
runner authored and runner committed Jun 6, 2024
1 parent d438db4 commit 6e335d1
Show file tree
Hide file tree
Showing 59 changed files with 15,492 additions and 0 deletions.
277 changes: 277 additions & 0 deletions docs/Classes.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,277 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Classes Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset='utf-8'>
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>

<script src="js/lunr.min.js" defer></script>
<script src="js/typeahead.jquery.js" defer></script>
<script src="js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a>
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Clickstream Docs</a></p>
<p class="header-right"><a href="https://github.com/awslabs/clickstream-swift"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</div>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">Clickstream</a>
<img id="carat" src="img/carat.png" alt=""/>
Classes Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Classes/Attr.html">Attr</a>
</li>
<li class="nav-group-task">
<a href="Classes/ClickstreamConfiguration.html">ClickstreamConfiguration</a>
</li>
<li class="nav-group-task">
<a href="Classes/ClickstreamItemKey.html">ClickstreamItemKey</a>
</li>
<li class="nav-group-task">
<a href="Classes/ClickstreamObjc.html">ClickstreamObjc</a>
</li>
<li class="nav-group-task">
<a href="Classes/EventName.html">EventName</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/ClickstreamAnalytics.html">ClickstreamAnalytics</a>
</li>
<li class="nav-group-task">
<a href="Enums/ClickstreamAnalytics/EventName.html">– EventName</a>
</li>
<li class="nav-group-task">
<a href="Enums/ClickstreamAnalytics/Attr.html">– Attr</a>
</li>
<li class="nav-group-task">
<a href="Enums/ClickstreamAnalytics/Item.html">– Item</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Extensions.html#/c:@SA@NSDecimal">Decimal</a>
</li>
<li class="nav-group-task">
<a href="Extensions.html#/s:s5Int64V">Int64</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Typealiases.html#/s:11Clickstream0A9Attributea">ClickstreamAttribute</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>Classes</h1>
<p>The following classes are available globally.</p>

</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:@M@Clickstream@objc(cs)ClickstreamObjc"></a>
<a name="//apple_ref/swift/Class/ClickstreamObjc" class="dashAnchor"></a>
<a class="token" href="#/c:@M@Clickstream@objc(cs)ClickstreamObjc">ClickstreamObjc</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>ClickstreamAnalytics api for objective-c</p>

<a href="Classes/ClickstreamObjc.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objcMembers</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">ClickstreamObjc</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@Clickstream@objc(cs)EventName"></a>
<a name="//apple_ref/swift/Class/EventName" class="dashAnchor"></a>
<a class="token" href="#/c:@M@Clickstream@objc(cs)EventName">EventName</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>ClickstreamAnalytics preset events</p>

<a href="Classes/EventName.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objcMembers</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">EventName</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@Clickstream@objc(cs)Attr"></a>
<a name="//apple_ref/swift/Class/Attr" class="dashAnchor"></a>
<a class="token" href="#/c:@M@Clickstream@objc(cs)Attr">Attr</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>ClickstreamANalytics preset attributes</p>

<a href="Classes/Attr.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objcMembers</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">Attr</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@Clickstream@objc(cs)ClickstreamItemKey"></a>
<a name="//apple_ref/swift/Class/ClickstreamItemKey" class="dashAnchor"></a>
<a class="token" href="#/c:@M@Clickstream@objc(cs)ClickstreamItemKey">ClickstreamItemKey</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>ClickstreamAnalytics preset item keys for objective-c
In addition to the item attributes defined below, you can add up to 10 custom attributes to an item.</p>

<a href="Classes/ClickstreamItemKey.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objcMembers</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">ClickstreamItemKey</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/ClickstreamContext"></a>
<a name="//apple_ref/swift/Section/ClickstreamContext" class="dashAnchor"></a>
<div class="section-name-container">
<a class="section-name-link" href="#/ClickstreamContext"></a>
<h3 class="section-name"><span>ClickstreamContext</span>
</h3>
</div>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/c:@M@Clickstream@objc(cs)ClickstreamConfiguration"></a>
<a name="//apple_ref/swift/Class/ClickstreamConfiguration" class="dashAnchor"></a>
<a class="token" href="#/c:@M@Clickstream@objc(cs)ClickstreamConfiguration">ClickstreamConfiguration</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The configuration object for clickstream, modify the params after sdk initialize</p>

<a href="Classes/ClickstreamConfiguration.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objcMembers</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">ClickstreamConfiguration</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener">Amazon Web Services</a>. All rights reserved. (Last updated: 2024-06-06)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</html>
Loading

0 comments on commit 6e335d1

Please sign in to comment.