openapi-node
Version:
A Node library to interact with the Wix Hive (RESTful API)
1,000 lines (378 loc) • 14.3 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Wix openapi-node Class: Activities</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.spacelab.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top ">
<div class="navbar-inner">
<a class="brand" href="index.html">Wix openapi-node</a>
<ul class="nav">
<li class="dropdown">
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="API.html">Wix/API</a>
</li>
<li>
<a href="connect.html">wix/connect</a>
</li>
<li>
<a href="Connect_.html">Wix/Connect</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="Activities.html">Activities</a>
</li>
<li>
<a href="ActivityType.html">ActivityType</a>
</li>
<li>
<a href="APIBuilder.html">APIBuilder</a>
</li>
<li>
<a href="BaseWixAPIObject.html">BaseWixAPIObject</a>
</li>
<li>
<a href="Contact.html">Contact</a>
</li>
<li>
<a href="Contacts.html">Contacts</a>
</li>
<li>
<a href="Insights.html">Insights</a>
</li>
<li>
<a href="Wix.html">Wix</a>
</li>
<li>
<a href="WixActivity.html">WixActivity</a>
</li>
<li>
<a href="WixActivityData.html">WixActivityData</a>
</li>
<li>
<a href="WixAPICaller.html">WixAPICaller</a>
</li>
<li>
<a href="WixPagingData.html">WixPagingData</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<h1 class="page-title">Class: Activities</h1>
<section>
<header>
<h2>
Activities
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Activities"><span class="type-signature"></span>new Activities<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Handles interactions with the Activities RESTful API</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
WixClient.js
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Mixes In</h3>
<ul>
<li><a href="WixAPICaller.html">WixAPICaller</a></li>
</ul>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="getActivities"><span class="type-signature"></span>getActivities<span class="signature">(cursor, options)</span><span class="type-signature"> → {Promise.<<a href="WixPagingData.html">WixPagingData</a>, error>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Navigates the Activities found on the current site</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>cursor</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The current cursor</p></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type"><a href="global.html#GetActivitiesOptions">GetActivitiesOptions</a></span>
</td>
<td class="description last"><p>The Activity to post</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
WixClient.js
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A promise for a <a href="WixPagingData.html"><code>WixPagingData</code></a> object to navigate results, or an error</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="WixPagingData.html">WixPagingData</a>, error></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getActivityById"><span class="type-signature"></span>getActivityById<span class="signature">(activityId)</span><span class="type-signature"> → {Promise.<<a href="WixActivity.html">WixActivity</a>, error>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns an Activity by a given ID</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>activityId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The id of the Activity to return</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
WixClient.js
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An Activity, or an error</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="WixActivity.html">WixActivity</a>, error></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getTypes"><span class="type-signature"></span>getTypes<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<string>, error>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns a list of all activity types contained within the Wix system</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
WixClient.js
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A promise for an array of strings</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<Array.<string>, error></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="newActivity"><span class="type-signature"></span>newActivity<span class="signature">(type)</span><span class="type-signature"> → {<a href="WixActivity.html">WixActivity</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Creates a new WixActivity for the given <a href="ActivityType.html"><code>ActivityType</code></a></p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type"><a href="ActivityType.html">ActivityType</a></span>
</td>
<td class="description last"><p>the type of Activity</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
WixClient.js
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>returns an empty Wix Activity</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="WixActivity.html">WixActivity</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="postActivity"><span class="type-signature"></span>postActivity<span class="signature">(activity, userSessionToken)</span><span class="type-signature"> → {Promise.<string, error>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Posts the Activity to Wix. Returns a Promise for an id</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>activity</code></td>
<td class="type">
<span class="param-type"><a href="WixActivity.html">WixActivity</a></span>
</td>
<td class="description last"><p>the Activity to post to Wix</p></td>
</tr>
<tr>
<td class="name"><code>userSessionToken</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The current session token for active Wix user</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
WixClient.js
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new id, or an error</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<string, error></span>
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<a href='http://dev.wix.com'>Wix Developer Center</a>
<br />
<span class="copyright">
2014, Wix
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a>
on Thu Jul 31 2014 17:22:21 GMT+0300 (IDT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:false, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>