mixpanel-swift/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs.html

271 lines
11 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en">
<head>
2017-10-19 18:27:10 +00:00
<title>Structures 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>
</head>
<body>
2017-10-19 18:27:10 +00:00
<a title="Structures Reference"></a>
<header>
<div class="content-wrapper">
2018-04-20 18:33:16 +00:00
<p><a href="index.html">Mixpanel Docs</a> (99% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">Mixpanel Reference</a>
<img id="carat" src="img/carat.png" />
2017-10-19 18:27:10 +00:00
Structures 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/Mixpanel.html">Mixpanel</a>
</li>
<li class="nav-group-task">
<a href="Classes/MixpanelInstance.html">MixpanelInstance</a>
</li>
<li class="nav-group-task">
<a href="Classes/People.html">People</a>
</li>
<li class="nav-group-task">
2017-07-27 00:16:24 +00:00
<a href="Classes.html#/s:8Mixpanel10TweakStoreC">TweakStore</a>
</li>
</ul>
</li>
<li class="nav-group-name">
2017-10-19 18:27:10 +00:00
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/TweakViewDataType.html">TweakViewDataType</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/Array.html">Array</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Bool.html">Bool</a>
</li>
<li class="nav-group-task">
<a href="Extensions/CGFloat.html">CGFloat</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Date.html">Date</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Dictionary.html">Dictionary</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Double.html">Double</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Float.html">Float</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Int.html">Int</a>
</li>
<li class="nav-group-task">
<a href="Extensions/NSNull.html">NSNull</a>
</li>
<li class="nav-group-task">
<a href="Extensions/String.html">String</a>
</li>
<li class="nav-group-task">
<a href="Extensions/UIColor.html">UIColor</a>
</li>
<li class="nav-group-task">
<a href="Extensions/UInt.html">UInt</a>
</li>
<li class="nav-group-task">
<a href="Extensions/URL.html">URL</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Functions.html">Functions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
2018-09-20 21:36:54 +00:00
<a href="Functions.html#/s:8Mixpanel2eeoiySbAA5TweakVyxG_AEtAA13TweakableTypeRzlF">==(_:_:)</a>
</li>
<li class="nav-group-task">
2018-09-20 21:36:54 +00:00
<a href="Functions.html#/s:8Mixpanel2eeoiySbAA8AnyTweakV_ADtF">==(_:_:)</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/MixpanelDelegate.html">MixpanelDelegate</a>
</li>
<li class="nav-group-task">
<a href="Protocols/MixpanelType.html">MixpanelType</a>
</li>
<li class="nav-group-task">
<a href="Protocols/TweakClusterType.html">TweakClusterType</a>
</li>
<li class="nav-group-task">
<a href="Protocols/TweakLibraryType.html">TweakLibraryType</a>
</li>
<li class="nav-group-task">
<a href="Protocols/TweakableType.html">TweakableType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
2017-10-19 18:27:10 +00:00
<a href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/AnyTweak.html">AnyTweak</a>
</li>
<li class="nav-group-task">
<a href="Structs/MixpanelTweaks.html">MixpanelTweaks</a>
</li>
<li class="nav-group-task">
<a href="Structs/Tweak.html">Tweak</a>
</li>
</ul>
</li>
2018-04-20 18:33:16 +00:00
<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:8Mixpanel10Propertiesa">Properties</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
2017-10-19 18:27:10 +00:00
<h1>Structures</h1>
<p>The following structures are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
2017-07-27 00:16:24 +00:00
<a name="/s:8Mixpanel0A6TweaksV"></a>
<a name="//apple_ref/swift/Struct/MixpanelTweaks" class="dashAnchor"></a>
2017-07-27 00:16:24 +00:00
<a class="token" href="#/s:8Mixpanel0A6TweaksV">MixpanelTweaks</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The MixpanelTweaks struct that needs to be extended to define new Tweaks for A/B testing</p>
<a href="Structs/MixpanelTweaks.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
2018-03-12 22:15:13 +00:00
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">MixpanelTweaks</span><span class="p">:</span> <span class="kt"><a href="Protocols/TweakLibraryType.html">TweakLibraryType</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
2017-07-27 00:16:24 +00:00
<a name="/s:8Mixpanel5TweakV"></a>
<a name="//apple_ref/swift/Struct/Tweak" class="dashAnchor"></a>
2017-07-27 00:16:24 +00:00
<a class="token" href="#/s:8Mixpanel5TweakV">Tweak</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Tweaks let you adjust things on the fly.
Because each T needs a UI component, we have to restrict what T can be - hence T: TweakableType.
If T: SignedNumberType, you can declare a min / max for a Tweak.</p>
<a href="Structs/Tweak.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
2018-03-12 22:15:13 +00:00
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Tweak</span><span class="o">&lt;</span><span class="kt">T</span><span class="p">:</span> <span class="kt"><a href="Protocols/TweakableType.html">TweakableType</a></span><span class="o">&gt;</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
2017-07-27 00:16:24 +00:00
<a name="/s:8Mixpanel8AnyTweakV"></a>
<a name="//apple_ref/swift/Struct/AnyTweak" class="dashAnchor"></a>
2017-07-27 00:16:24 +00:00
<a class="token" href="#/s:8Mixpanel8AnyTweakV">AnyTweak</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A type-erasure around Tweak<T> for A/B Testing.</p>
<a href="Structs/AnyTweak.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
2018-03-12 22:15:13 +00:00
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">AnyTweak</span><span class="p">:</span> <span class="kt">TweakType</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
2018-10-05 22:37:39 +00:00
<p>&copy; 2018 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2018-10-05)</p>
2018-03-12 22:15:13 +00:00
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>