| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <title>EventClient Class 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 type="text/javascript"> |
| window.jazzy = {'docset': false} |
| if (typeof window.dash != 'undefined') { |
| document.documentElement.className += ' dash' |
| window.jazzy.docset = true |
| } |
| if (navigator.userAgent.match(/xcode/i)) { |
| document.documentElement.className += ' xcode' |
| window.jazzy.docset = true |
| } |
| </script> |
| <script src="../js/jquery.min.js" defer></script> |
| <script src="../js/jazzy.js" defer></script> |
| </head> |
| <body id="reference" class="Swift"> |
| <a name="//apple_ref/swift/Class/EventClient" class="dashAnchor"></a> |
| <a title="EventClient Class Reference"></a> |
| <header> |
| <div class="content-wrapper"> |
| <p class="header-text"><a href="../index.html">PredictionIO Swift SDK Docs</a> (96% documented)</p> |
| <p id="header-links"><a href="https://github.com/minhtule/PredictionIO-iOS-SDK"><img id="header-icon" src="../img/gh.png" height="16px" width="16px" />View on GitHub</a></p> |
| </div> |
| </header> |
| <section id="valence"> |
| <div class="content-wrapper"> |
| <p id="hierarchial_navigation"> |
| <a href="../index.html" id="design_resources_link">PredictionIO Swift SDK Reference</a> |
| <img id="carat" src="../img/carat.png" height="10px" width="6px" /> |
| EventClient Class Reference |
| </p> |
| </div> |
| </section> |
| <div class="content-wrapper"> |
| <nav class="book-parts"> |
| <ul class="nav-parts"> |
| <li class="part-name tasks"> |
| <a href="../Classes.html">Classes</a> |
| <ul class="nav-chapters"> |
| <li class="nav-chapter"> |
| <a href="../Classes/BaseClient.html">BaseClient</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="../Classes/EngineClient.html">EngineClient</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="../Classes/EventClient.html">EventClient</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="../Classes.html#/s:C15PredictionIOSDK7Manager">Manager</a> |
| </li> |
| </ul> |
| </li> |
| <li class="part-name tasks"> |
| <a href="../Extensions.html">Extensions</a> |
| <ul class="nav-chapters"> |
| <li class="nav-chapter"> |
| <a href="../Extensions/EventClient.html">EventClient</a> |
| </li> |
| </li> |
| </ul> |
| </li> |
| <li class="part-name tasks"> |
| <a href="../Structs.html">Structs</a> |
| <ul class="nav-chapters"> |
| <li class="nav-chapter"> |
| <a href="../Structs/Event.html">Event</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </nav> |
| <div class="pixel-line"></div> |
| <div class="rubber-band-gap"></div> |
| <article class="chapter"> |
| <a name="/"></a> |
| <h1 class="chapter-name">EventClient</h1> |
| <section> |
| <section class="section"> |
| <p class="para">Client for sending data to PredictionIO Event Server.</p> |
| </section> |
| <section class="section task-group-section"> |
| <div class="task-group"> |
| <div class="task-name-container"> |
| |
| <a name="/Constructors"></a> |
| <a name="//apple_ref/swift/Section/Constructors" class="dashAnchor"></a> |
| <a href="#/Constructors"> |
| <h3 class="section-name">Constructors</h3> |
| </a> |
| |
| </div> |
| <ul class="task-group-list"> |
| <li class="item symbol"> |
| <div class="task-group-term"> |
| <code> |
| <a name="/s:FC15PredictionIOSDK11EventClientcFMS0_FT9accessKeySS7baseURLSS7timeoutSd_S0_"> |
| <a name="//apple_ref/swift/Method/init(accessKey:baseURL:timeout:)" class="dashAnchor"></a> |
| <a class="x-instance-method Swift" href="#/s:FC15PredictionIOSDK11EventClientcFMS0_FT9accessKeySS7baseURLSS7timeoutSd_S0_">init(accessKey:baseURL:timeout:)</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointy-thing-container"></div> |
| <section class="section instance-method"> |
| <div class="pointy-thing"></div> |
| <div class="abstract"> |
| |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| |
| <div class="Swift"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">accessKey</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">baseURL</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"http://localhost:7070"</span><span class="p">,</span> <span class="nv">timeout</span><span class="p">:</span> <span class="kt">NSTimeInterval</span> <span class="o">=</span> <span class="mi">5</span><span class="p">)</span></code></pre> |
| |
| </div> |
| </div> |
| <div class="parameters"> |
| <h4>Parameters</h4> |
| <table class="graybox" border="0" cellspacing="0" cellpadding="5"> |
| <tbody> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">accessKey</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The access key for your application</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">baseURL</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The base URL. Default to be <a href="http://localhost:7070">http://localhost:7070</a>.</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">timeout</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The request timeout. Default to be 5s.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="task-group"> |
| <div class="task-name-container"> |
| |
| <a name="/Methods"></a> |
| <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> |
| <a href="#/Methods"> |
| <h3 class="section-name">Methods</h3> |
| </a> |
| |
| </div> |
| <ul class="task-group-list"> |
| <li class="item symbol"> |
| <div class="task-group-term"> |
| <code> |
| <a name="/s:FC15PredictionIOSDK11EventClient11createEventFS0_FTVS_5Event17completionHandlerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T__T_"> |
| <a name="//apple_ref/swift/Method/createEvent(_:completionHandler:)" class="dashAnchor"></a> |
| <a class="x-instance-method Swift" href="#/s:FC15PredictionIOSDK11EventClient11createEventFS0_FTVS_5Event17completionHandlerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T__T_">createEvent(_:completionHandler:)</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointy-thing-container"></div> |
| <section class="section instance-method"> |
| <div class="pointy-thing"></div> |
| <div class="abstract"> |
| <p class="para">Create an event in Event Server.</p> |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| |
| <div class="Swift"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">createEvent</span><span class="p">(</span><span class="nv">event</span><span class="p">:</span> <span class="kt">Event</span><span class="p">,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?,</span> <span class="kt">AnyObject</span><span class="p">?,</span> <span class="kt">NSError</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span></code></pre> |
| |
| </div> |
| </div> |
| <div class="parameters"> |
| <h4>Parameters</h4> |
| <table class="graybox" border="0" cellspacing="0" cellpadding="5"> |
| <tbody> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">event</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">An <code>Event</code> instance that captures the event.</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">completionHandler</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The callback to be executed when the request has finished.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="task-group"> |
| <div class="task-name-container"> |
| |
| <a name="/For%20development%20and%20debugging%20purpose%20only."></a> |
| <a name="//apple_ref/swift/Section/For development and debugging purpose only." class="dashAnchor"></a> |
| <a href="#/For%20development%20and%20debugging%20purpose%20only."> |
| <h3 class="section-name">For development and debugging purpose only.</h3> |
| </a> |
| |
| </div> |
| <ul class="task-group-list"> |
| <li class="item symbol"> |
| <div class="task-group-term"> |
| <code> |
| <a name="/s:FC15PredictionIOSDK11EventClient8getEventFS0_FTSS17completionHandlerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T__T_"> |
| <a name="//apple_ref/swift/Method/getEvent(_:completionHandler:)" class="dashAnchor"></a> |
| <a class="x-instance-method Swift" href="#/s:FC15PredictionIOSDK11EventClient8getEventFS0_FTSS17completionHandlerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T__T_">getEvent(_:completionHandler:)</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointy-thing-container"></div> |
| <section class="section instance-method"> |
| <div class="pointy-thing"></div> |
| <div class="abstract"> |
| <p class="para">Get an event from Event Server.</p> |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| |
| <div class="Swift"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">getEvent</span><span class="p">(</span><span class="nv">eventID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?,</span> <span class="kt">AnyObject</span><span class="p">?,</span> <span class="kt">NSError</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span></code></pre> |
| |
| </div> |
| </div> |
| <div class="parameters"> |
| <h4>Parameters</h4> |
| <table class="graybox" border="0" cellspacing="0" cellpadding="5"> |
| <tbody> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">eventID</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The event ID</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">completionHandler</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The callback to be executed when the request has finished.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </div> |
| </li> |
| <li class="item symbol"> |
| <div class="task-group-term"> |
| <code> |
| <a name="/s:FC15PredictionIOSDK11EventClient11deleteEventFS0_FTSS17completionHandlerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T__T_"> |
| <a name="//apple_ref/swift/Method/deleteEvent(_:completionHandler:)" class="dashAnchor"></a> |
| <a class="x-instance-method Swift" href="#/s:FC15PredictionIOSDK11EventClient11deleteEventFS0_FTSS17completionHandlerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T__T_">deleteEvent(_:completionHandler:)</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointy-thing-container"></div> |
| <section class="section instance-method"> |
| <div class="pointy-thing"></div> |
| <div class="abstract"> |
| <p class="para">Delete an event from Event Server.</p> |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| |
| <div class="Swift"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">deleteEvent</span><span class="p">(</span><span class="nv">eventID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?,</span> <span class="kt">AnyObject</span><span class="p">?,</span> <span class="kt">NSError</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span></code></pre> |
| |
| </div> |
| </div> |
| <div class="parameters"> |
| <h4>Parameters</h4> |
| <table class="graybox" border="0" cellspacing="0" cellpadding="5"> |
| <tbody> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">eventID</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The event ID</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">completionHandler</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The callback to be executed when the request has finished.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </section> |
| </section> |
| <section id="footer"> |
| <p class="copyright">© 2015 <a class="link" href="https://github.com/minhtule" target="_blank" rel="external">Minh-Tu Le</a>. All rights reserved. (Last updated: 2015-03-03)</p> |
| <p class="copyright">Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.1.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p> |
| </section> |
| </article> |
| </div> |
| </body> |
| </div> |
| </html> |
