Files
2014-06-13 15:53:21 -07:00

713 lines
19 KiB
HTML

<!DOCTYPE HTML>
<html>
<head>
<meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
<title>UPSleepAPI Class Reference</title>
<meta id="xcode-display" name="xcode-display" content="render"/>
<link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
<link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
<meta name="generator" content="appledoc 2.2 (build 961)" />
</head>
<body>
<header id="top_header">
<div id="library" class="hideInXcode">
<h1><a id="libraryTitle" href="../index.html">UPPlatformSDK </a></h1>
<a id="developerHome" href="../index.html">Jawbone</a>
</div>
<div id="title" role="banner">
<h1 class="hideInXcode">UPSleepAPI Class Reference</h1>
</div>
<ul id="headerButtons" role="toolbar">
<li id="toc_button">
<button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button>
</li>
<li id="jumpto_button" role="navigation">
<select id="jumpTo">
<option value="top">Jump To&#133;</option>
<option value="overview">Overview</option>
<option value="tasks">Tasks</option>
<option value="class_methods">Class Methods</option>
<option value="//api/name/deleteSleep:completion:">&nbsp;&nbsp;&nbsp;&nbsp;+ deleteSleep:completion:</option>
<option value="//api/name/getSleepGraphImage:completion:">&nbsp;&nbsp;&nbsp;&nbsp;+ getSleepGraphImage:completion:</option>
<option value="//api/name/getSleepTicks:completion:">&nbsp;&nbsp;&nbsp;&nbsp;+ getSleepTicks:completion:</option>
<option value="//api/name/getSleepsFromStartDate:toEndDate:completion:">&nbsp;&nbsp;&nbsp;&nbsp;+ getSleepsFromStartDate:toEndDate:completion:</option>
<option value="//api/name/getSleepsWithLimit:completion:">&nbsp;&nbsp;&nbsp;&nbsp;+ getSleepsWithLimit:completion:</option>
<option value="//api/name/postSleep:completion:">&nbsp;&nbsp;&nbsp;&nbsp;+ postSleep:completion:</option>
<option value="//api/name/refreshSleep:completion:">&nbsp;&nbsp;&nbsp;&nbsp;+ refreshSleep:completion:</option>
</select>
</li>
</ul>
</header>
<nav id="tocContainer" class="isShowingTOC">
<ul id="toc" role="tree">
<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li>
<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul>
</ul></li>
<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#class_methods">Class Methods</a></span><ul>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/deleteSleep:completion:">deleteSleep:completion:</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/getSleepGraphImage:completion:">getSleepGraphImage:completion:</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/getSleepTicks:completion:">getSleepTicks:completion:</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/getSleepsFromStartDate:toEndDate:completion:">getSleepsFromStartDate:toEndDate:completion:</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/getSleepsWithLimit:completion:">getSleepsWithLimit:completion:</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/postSleep:completion:">postSleep:completion:</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/refreshSleep:completion:">refreshSleep:completion:</a></span></li>
</ul></li>
</ul>
</nav>
<article>
<div id="contents" class="isShowingTOC" role="main">
<a title="UPSleepAPI Class Reference" name="top"></a>
<div class="main-navigation navigation-top">
<ul>
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
</ul>
</div>
<div id="header">
<div class="section-header">
<h1 class="title title-header">UPSleepAPI Class Reference</h1>
</div>
</div>
<div id="container">
<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<td class="specification-title">Inherits from</td>
<td class="specification-value">NSObject</td>
</tr><tr>
<td class="specification-title">Declared in</td>
<td class="specification-value">UPSleepAPI.h<br />UPSleepAPI.m</td>
</tr>
</tbody></table></div>
<div class="section section-overview">
<a title="Overview" name="overview"></a>
<h2 class="subtitle subtitle-overview">Overview</h2>
<p>Provides an interface for interacting with the user&rsquo;s sleeps.</p>
</div>
<div class="section section-tasks">
<a title="Tasks" name="tasks"></a>
<h2 class="subtitle subtitle-tasks">Tasks</h2>
<ul class="task-list">
<li>
<span class="tooltip">
<code><a href="#//api/name/getSleepsWithLimit:completion:">+&nbsp;getSleepsWithLimit:completion:</a></code>
</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/getSleepsFromStartDate:toEndDate:completion:">+&nbsp;getSleepsFromStartDate:toEndDate:completion:</a></code>
</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/postSleep:completion:">+&nbsp;postSleep:completion:</a></code>
</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/refreshSleep:completion:">+&nbsp;refreshSleep:completion:</a></code>
</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/deleteSleep:completion:">+&nbsp;deleteSleep:completion:</a></code>
</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/getSleepGraphImage:completion:">+&nbsp;getSleepGraphImage:completion:</a></code>
</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/getSleepTicks:completion:">+&nbsp;getSleepTicks:completion:</a></code>
</span>
</li>
</ul>
</div>
<div class="section section-methods">
<a title="Class Methods" name="class_methods"></a>
<h2 class="subtitle subtitle-methods">Class Methods</h2>
<div class="section-method">
<a name="//api/name/deleteSleep:completion:" title="deleteSleep:completion:"></a>
<h3 class="subsubtitle method-title">deleteSleep:completion:</h3>
<div class="method-subsection brief-description">
<p>Delete a sleep event. The event must belong to the currently authenticated user.</p>
</div>
<div class="method-subsection method-declaration"><code>+ (void)deleteSleep:(UPSleep *)<em>sleep</em> completion:(UPBaseEventAPICompletion)<em>completion</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>sleep</em></dt>
<dd><p>The sleep event to be deleted.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>completion</em></dt>
<dd><p>Block to be executed upon completion. The block is passed a completion object.</p></dd>
</dl>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Delete a sleep event. The event must belong to the currently authenticated user.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">UPSleepAPI.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/getSleepGraphImage:completion:" title="getSleepGraphImage:completion:"></a>
<h3 class="subsubtitle method-title">getSleepGraphImage:completion:</h3>
<div class="method-subsection brief-description">
<p>Request an image containing a graph for the sleep event. The event must be visible to the currently authenticated user.</p>
</div>
<div class="method-subsection method-declaration"><code>+ (void)getSleepGraphImage:(UPSleep *)<em>sleep</em> completion:(UPBaseEventAPIImageCompletion)<em>completion</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>sleep</em></dt>
<dd><p>The sleep event to request.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>completion</em></dt>
<dd><p>Block to be executed upon completion. The block is passed the result.</p></dd>
</dl>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Request an image containing a graph for the sleep event. The event must be visible to the currently authenticated user.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">UPSleepAPI.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/getSleepTicks:completion:" title="getSleepTicks:completion:"></a>
<h3 class="subsubtitle method-title">getSleepTicks:completion:</h3>
<div class="method-subsection brief-description">
<p>Requests ticks of the sleep. The ticks provide finer detail about the sleep.</p>
</div>
<div class="method-subsection method-declaration"><code>+ (void)getSleepTicks:(UPSleep *)<em>sleep</em> completion:(UPBaseEventAPIArrayCompletion)<em>completion</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>sleep</em></dt>
<dd><p>The sleep event to request the snapshot for.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>completion</em></dt>
<dd><p>Block to be executed upon completion. The block is passed the result.</p></dd>
</dl>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Requests ticks of the sleep. The ticks provide finer detail about the sleep.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">UPSleepAPI.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/getSleepsFromStartDate:toEndDate:completion:" title="getSleepsFromStartDate:toEndDate:completion:"></a>
<h3 class="subsubtitle method-title">getSleepsFromStartDate:toEndDate:completion:</h3>
<div class="method-subsection brief-description">
<p>Request sleep events between two points in time for the currently authenticated user.</p>
</div>
<div class="method-subsection method-declaration"><code>+ (void)getSleepsFromStartDate:(NSDate *)<em>startDate</em> toEndDate:(NSDate *)<em>endDate</em> completion:(UPBaseEventAPIArrayCompletion)<em>completion</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>completion</em></dt>
<dd><p>Block to be executed upon completion. The block is passed the results.</p></dd>
</dl>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Request sleep events between two points in time for the currently authenticated user.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">UPSleepAPI.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/getSleepsWithLimit:completion:" title="getSleepsWithLimit:completion:"></a>
<h3 class="subsubtitle method-title">getSleepsWithLimit:completion:</h3>
<div class="method-subsection brief-description">
<p>Request recent sleep sleep for the currently authenticated user.</p>
</div>
<div class="method-subsection method-declaration"><code>+ (void)getSleepsWithLimit:(NSUInteger)<em>limit</em> completion:(UPBaseEventAPIArrayCompletion)<em>completion</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>limit</em></dt>
<dd><p>The maximum number of events that will be returned.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>completion</em></dt>
<dd><p>Block to be executed upon completion. The block is passed the results.</p></dd>
</dl>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Request recent sleep sleep for the currently authenticated user.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">UPSleepAPI.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/postSleep:completion:" title="postSleep:completion:"></a>
<h3 class="subsubtitle method-title">postSleep:completion:</h3>
<div class="method-subsection brief-description">
<p>Post a new sleep event to the user&rsquo;s timeline.</p>
</div>
<div class="method-subsection method-declaration"><code>+ (void)postSleep:(UPSleep *)<em>sleep</em> completion:(UPSleepAPICompletion)<em>completion</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>sleep</em></dt>
<dd><p>A new sleep event.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>completion</em></dt>
<dd><p>Block to be executed upon completion. The block is passed the results.</p></dd>
</dl>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Post a new sleep event to the user&rsquo;s timeline.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">UPSleepAPI.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/refreshSleep:completion:" title="refreshSleep:completion:"></a>
<h3 class="subsubtitle method-title">refreshSleep:completion:</h3>
<div class="method-subsection brief-description">
<p>Request sleep recent sleep events for the currently authenticated user.</p>
</div>
<div class="method-subsection method-declaration"><code>+ (void)refreshSleep:(UPSleep *)<em>sleep</em> completion:(UPSleepAPICompletion)<em>completion</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>completion</em></dt>
<dd><p>Block to be executed upon completion. The block is passed the results.</p></dd>
</dl>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Request sleep recent sleep events for the currently authenticated user.</p>
<p>@param limit</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">UPSleepAPI.h</code><br />
</div>
</div>
</div>
</div>
<div class="main-navigation navigation-bottom">
<ul>
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
</ul>
</div>
<div id="footer">
<hr />
<div class="footer-copyright">
<p><span class="copyright">&copy; 2014 Jawbone. All rights reserved. (Last updated: 2014-06-13)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2 (build 961)</a>.</span></p>
</div>
</div>
</div>
</article>
<script type="text/javascript">
function jumpToChange()
{
window.location.hash = this.options[this.selectedIndex].value;
}
function toggleTOC()
{
var contents = document.getElementById('contents');
var tocContainer = document.getElementById('tocContainer');
if (this.getAttribute('class') == 'open')
{
this.setAttribute('class', '');
contents.setAttribute('class', '');
tocContainer.setAttribute('class', '');
window.name = "hideTOC";
}
else
{
this.setAttribute('class', 'open');
contents.setAttribute('class', 'isShowingTOC');
tocContainer.setAttribute('class', 'isShowingTOC');
window.name = "";
}
return false;
}
function toggleTOCEntryChildren(e)
{
e.stopPropagation();
var currentClass = this.getAttribute('class');
if (currentClass == 'children') {
this.setAttribute('class', 'children open');
}
else if (currentClass == 'children open') {
this.setAttribute('class', 'children');
}
return false;
}
function tocEntryClick(e)
{
e.stopPropagation();
return true;
}
function init()
{
var selectElement = document.getElementById('jumpTo');
selectElement.addEventListener('change', jumpToChange, false);
var tocButton = document.getElementById('table_of_contents');
tocButton.addEventListener('click', toggleTOC, false);
var taskTreeItem = document.getElementById('task_treeitem');
if (taskTreeItem.getElementsByTagName('li').length > 0)
{
taskTreeItem.setAttribute('class', 'children');
taskTreeItem.firstChild.setAttribute('class', 'disclosure');
}
var tocList = document.getElementById('toc');
var tocEntries = tocList.getElementsByTagName('li');
for (var i = 0; i < tocEntries.length; i++) {
tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
}
var tocLinks = tocList.getElementsByTagName('a');
for (var i = 0; i < tocLinks.length; i++) {
tocLinks[i].addEventListener('click', tocEntryClick, false);
}
if (window.name == "hideTOC") {
toggleTOC.call(tocButton);
}
}
window.onload = init;
// If showing in Xcode, hide the TOC and Header
if (navigator.userAgent.match(/xcode/i)) {
document.getElementById("contents").className = "hideInXcode"
document.getElementById("tocContainer").className = "hideInXcode"
document.getElementById("top_header").className = "hideInXcode"
}
</script>
</body>
</html>