Elgato_dark/mixpanel-swift
1
0
Fork 0
mirror of https://github.com/mixpanel/mixpanel-swift synced 2026-04-21 13:37:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
mixpanel-swift/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols.html
Ketan S 8d46455a6b Update docs
2026-03-17 00:02:07 +05:30

380 lines
17 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<title>Protocols 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/Protocols" class="dashAnchor"></a>
<a title="Protocols Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Mixpanel 6.0.0 Docs</a> (68% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<p class="header-right"><a href="dash-feed://erivedDataPath%2C%2FUsers%2Fketan%2FDocuments%2FMixpanel-GitHub%2Fmixpanel-swift%2Fbuild"><img src="img/dash.png" alt="Dash"/>Install in Dash</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">Mixpanel</a>
<img id="carat" src="img/carat.png" alt=""/>
Protocols 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/Group.html">Group</a>
</li>
<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/MixpanelLogger.html">MixpanelLogger</a>
</li>
<li class="nav-group-task">
<a href="Classes/MixpanelOptions.html">MixpanelOptions</a>
</li>
<li class="nav-group-task">
<a href="Classes/People.html">People</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/GzipError.html">GzipError</a>
</li>
<li class="nav-group-task">
<a href="Enums/MixpanelLogLevel.html">MixpanelLogLevel</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/Data.html">Data</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/NSArray.html">NSArray</a>
</li>
<li class="nav-group-task">
<a href="Extensions/NSNull.html">NSNull</a>
</li>
<li class="nav-group-task">
<a href="Extensions/NSNumber.html">NSNumber</a>
</li>
<li class="nav-group-task">
<a href="Extensions/NSString.html">NSString</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Optional.html">Optional</a>
</li>
<li class="nav-group-task">
<a href="Extensions/String.html">String</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="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/MixpanelFlagDelegate.html">MixpanelFlagDelegate</a>
</li>
<li class="nav-group-task">
<a href="Protocols/MixpanelFlags.html">MixpanelFlags</a>
</li>
<li class="nav-group-task">
<a href="Protocols/MixpanelLogging.html">MixpanelLogging</a>
</li>
<li class="nav-group-task">
<a href="Protocols/MixpanelProxyServerDelegate.html">MixpanelProxyServerDelegate</a>
</li>
<li class="nav-group-task">
<a href="Protocols/MixpanelType.html">MixpanelType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/FeatureFlagOptions.html">FeatureFlagOptions</a>
</li>
<li class="nav-group-task">
<a href="Structs/MixpanelFlagVariant.html">MixpanelFlagVariant</a>
</li>
<li class="nav-group-task">
<a href="Structs/MixpanelLogMessage.html">MixpanelLogMessage</a>
</li>
<li class="nav-group-task">
<a href="Structs/ProxyServerConfig.html">ProxyServerConfig</a>
</li>
<li class="nav-group-task">
<a href="Structs/ServerProxyResource.html">ServerProxyResource</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:8Mixpanel10Propertiesa">Properties</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>Protocols</h1>
<p>The following protocols are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<div class="task-name-container">
<a name="/PendingFirstTimeEvent"></a>
<a name="//apple_ref/swift/Section/PendingFirstTimeEvent" class="dashAnchor"></a>
<div class="section-name-container">
<a class="section-name-link" href="#/PendingFirstTimeEvent"></a>
<h3 class="section-name"><span>PendingFirstTimeEvent</span>
</h3>
</div>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:8Mixpanel0A12FlagDelegateP"></a>
<a name="//apple_ref/swift/Protocol/MixpanelFlagDelegate" class="dashAnchor"></a>
<a class="token" href="#/s:8Mixpanel0A12FlagDelegateP">MixpanelFlagDelegate</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<a href="Protocols/MixpanelFlagDelegate.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">public</span> <span class="kd">protocol</span> <span class="kt">MixpanelFlagDelegate</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8Mixpanel0A5FlagsP"></a>
<a name="//apple_ref/swift/Protocol/MixpanelFlags" class="dashAnchor"></a>
<a class="token" href="#/s:8Mixpanel0A5FlagsP">MixpanelFlags</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A protocol defining the public interface for a feature flagging system.</p>
<a href="Protocols/MixpanelFlags.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">public</span> <span class="kd">protocol</span> <span class="kt">MixpanelFlags</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8Mixpanel0A19ProxyServerDelegateP"></a>
<a name="//apple_ref/swift/Protocol/MixpanelProxyServerDelegate" class="dashAnchor"></a>
<a class="token" href="#/s:8Mixpanel0A19ProxyServerDelegateP">MixpanelProxyServerDelegate</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Delegate protocol for updating the Proxy Server API&rsquo;s network behavior.</p>
<a href="Protocols/MixpanelProxyServerDelegate.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">public</span> <span class="kd">protocol</span> <span class="kt">MixpanelProxyServerDelegate</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8Mixpanel0A8DelegateP"></a>
<a name="//apple_ref/swift/Protocol/MixpanelDelegate" class="dashAnchor"></a>
<a class="token" href="#/s:8Mixpanel0A8DelegateP">MixpanelDelegate</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Delegate protocol for controlling the Mixpanel API&rsquo;s network behavior.</p>
<a href="Protocols/MixpanelDelegate.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">public</span> <span class="kd">protocol</span> <span class="kt">MixpanelDelegate</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8Mixpanel0A7LoggingP"></a>
<a name="//apple_ref/swift/Protocol/MixpanelLogging" class="dashAnchor"></a>
<a class="token" href="#/s:8Mixpanel0A7LoggingP">MixpanelLogging</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Any object that conforms to this protocol may log messages</p>
<a href="Protocols/MixpanelLogging.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">public</span> <span class="kd">protocol</span> <span class="kt">MixpanelLogging</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8Mixpanel0A4TypeP"></a>
<a name="//apple_ref/swift/Protocol/MixpanelType" class="dashAnchor"></a>
<a class="token" href="#/s:8Mixpanel0A4TypeP">MixpanelType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Property keys must be String objects and the supported value types need to conform to MixpanelType.
MixpanelType can be either String, Int, UInt, Double, Float, Bool, [MixpanelType], [String: MixpanelType], Date, URL, or NSNull.
Numbers are not NaN or infinity</p>
<a href="Protocols/MixpanelType.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">public</span> <span class="kd">protocol</span> <span class="kt">MixpanelType</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2026 <a class="link" href="http://mixpanel.com" target="_blank" rel="external noopener">Mixpanel</a>. All rights reserved. (Last updated: 2026-03-17)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink