Skip to content

Adds api 1.10.2 #513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 28, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2,229 changes: 2,229 additions & 0 deletions api/1.10.2/Parse.ACL.html

Large diffs are not rendered by default.

376 changes: 376 additions & 0 deletions api/1.10.2/Parse.Analytics.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,376 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Analytics</title>

<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

<h1 class="page-title">Class: Analytics</h1>






<section>

<header>

<h2><span class="attribs"><span class="type-signature"></span></span>
<span class="ancestors"><a href="Parse.html">Parse</a>.</span>Analytics</h2>


</header>

<article>
<div class="container-overview">

















<dl class="details">
































</dl>



















</div>
















<h3 class="subsection-title">Methods</h3>







<h4 class="name" id=".track"><span class="type-signature">(static) </span>track<span class="signature">(name, dimensions, options)</span><span class="type-signature"> &rarr; {<a href="Parse.Promise.html">Parse.Promise</a>}</span></h4>






<div class="description">
Tracks the occurrence of a custom event with additional dimensions.
Parse will store a data point at the time of invocation with the given
event name.

Dimensions will allow segmentation of the occurrences of this custom
event. Keys and values should be {@code String}s, and will throw
otherwise.

To track a user signup along with additional metadata, consider the
following:
<pre>
var dimensions = {
gender: 'm',
source: 'web',
dayType: 'weekend'
};
Parse.Analytics.track('signup', dimensions);
</pre>

There is a default limit of 8 dimensions per event tracked.
</div>









<h5>Parameters:</h5>


<table class="params">
<thead>
<tr>

<th>Name</th>


<th>Type</th>





<th class="last">Description</th>
</tr>
</thead>

<tbody>


<tr>

<td class="name"><code>name</code></td>


<td class="type">


<span class="param-type">String</span>



</td>





<td class="description last">The name of the custom event to report to Parse as
having happened.</td>
</tr>



<tr>

<td class="name"><code>dimensions</code></td>


<td class="type">


<span class="param-type">Object</span>



</td>





<td class="description last">The dictionary of information by which to
segment this event.</td>
</tr>



<tr>

<td class="name"><code>options</code></td>


<td class="type">


<span class="param-type">Object</span>



</td>





<td class="description last">A Backbone-style callback object.</td>
</tr>


</tbody>
</table>






<dl class="details">
































</dl>













<h5>Returns:</h5>


<div class="param-desc">
A promise that is resolved when the round-trip
to the server completes.
</div>



<dl>
<dt>
Type
</dt>
<dd>

<span class="param-type"><a href="Parse.Promise.html">Parse.Promise</a></span>


</dd>
</dl>













</article>

</section>




</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Parse.html">Parse</a></li><li><a href="Parse.ACL.html">ACL</a></li><li><a href="Parse.Analytics.html">Analytics</a></li><li><a href="Parse.Cloud.html">Cloud</a></li><li><a href="Parse.Config.html">Config</a></li><li><a href="Parse.Error.html">Error</a></li><li><a href="Parse.FacebookUtils.html">FacebookUtils</a></li><li><a href="Parse.File.html">File</a></li><li><a href="Parse.GeoPoint.html">GeoPoint</a></li><li><a href="Parse.LiveQuery.html">LiveQuery</a></li><li><a href="Parse.LiveQueryClient.html">LiveQueryClient</a></li><li><a href="Parse.LiveQuerySubscription.html">LiveQuerySubscription</a></li><li><a href="Parse.Object.html">Object</a></li><li><a href="Parse.Polygon.html">Polygon</a></li><li><a href="Parse.Promise.html">Promise</a></li><li><a href="Parse.Push.html">Push</a></li><li><a href="Parse.Query.html">Query</a></li><li><a href="Parse.Relation.html">Relation</a></li><li><a href="Parse.Role.html">Role</a></li><li><a href="Parse.Session.html">Session</a></li><li><a href="Parse.User.html">User</a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Nov 27 2017 21:04:38 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Loading