<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_71) on Wed Oct 07 18:20:59 PDT 2015 -->
<title>ParseCloud (Parse 1.10.2 API)</title>
<meta name="date" content="2015-10-07">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ParseCloud (Parse 1.10.2 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../com/parse/ParseClassName.html" title="annotation in com.parse"><span class="strong">Prev Class</span></a></li>
<li><a href="../../com/parse/ParseConfig.html" title="class in com.parse"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?com/parse/ParseCloud.html" target="_top">Frames</a></li>
<li><a href="ParseCloud.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.parse</div>
<h2 title="Class ParseCloud" class="title">Class ParseCloud</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://d.android.com/reference/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.parse.ParseCloud</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="strong">ParseCloud</span>
extends <a href="http://d.android.com/reference/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">The ParseCloud class defines provides methods for interacting with Parse Cloud Functions. A Cloud
Function can be called with <a href="../../com/parse/ParseCloud.html#callFunctionInBackground(java.lang.String,%20java.util.Map,%20com.parse.FunctionCallback)"><code>ParseCloud.callFunctionInBackground(String, Map, FunctionCallback)</code></a>
using a <a href="../../com/parse/FunctionCallback.html" title="interface in com.parse"><code>FunctionCallback</code></a>. For example, this sample code calls the "validateGame" Cloud
Function and calls processResponse if the call succeeded and handleError if it failed.
<pre>
ParseCloud.callFunctionInBackground("validateGame", parameters, new FunctionCallback<Object>() {
public void done(Object object, ParseException e) {
if (e == null) {
processResponse(object);
} else {
handleError();
}
}
}
</pre>
Using the callback methods is usually preferred because the network operation will not block the
calling thread. However, in some cases it may be easier to use the
<a href="../../com/parse/ParseCloud.html#callFunction(java.lang.String,%20java.util.Map)"><code>ParseCloud.callFunction(String, Map)</code></a> call which do block the calling thread. For example, if your
application has already spawned a background task to perform work, that background task could use
the blocking calls and avoid the code complexity of callbacks.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <T> T</code></td>
<td class="colLast"><code><strong><a href="../../com/parse/ParseCloud.html#callFunction(java.lang.String,%20java.util.Map)">callFunction</a></strong>(<a href="http://d.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
<a href="http://d.android.com/reference/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://d.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> params)</code>
<div class="block">Calls a cloud function.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <T> <a href="http://boltsframework.github.io/docs/android/bolts/Task.html?is-external=true" title="class or interface in bolts">Task</a><T></code></td>
<td class="colLast"><code><strong><a href="../../com/parse/ParseCloud.html#callFunctionInBackground(java.lang.String,%20java.util.Map)">callFunctionInBackground</a></strong>(<a href="http://d.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
<a href="http://d.android.com/reference/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://d.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> params)</code>
<div class="block">Calls a cloud function in the background.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <T> void</code></td>
<td class="colLast"><code><strong><a href="../../com/parse/ParseCloud.html#callFunctionInBackground(java.lang.String,%20java.util.Map,%20com.parse.FunctionCallback)">callFunctionInBackground</a></strong>(<a href="http://d.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
<a href="http://d.android.com/reference/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://d.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> params,
<a href="../../com/parse/FunctionCallback.html" title="interface in com.parse">FunctionCallback</a><T> callback)</code>
<div class="block">Calls a cloud function in the background.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="http://d.android.com/reference/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://d.android.com/reference/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://d.android.com/reference/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://d.android.com/reference/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://d.android.com/reference/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://d.android.com/reference/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://d.android.com/reference/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://d.android.com/reference/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://d.android.com/reference/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://d.android.com/reference/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://d.android.com/reference/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://d.android.com/reference/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="callFunctionInBackground(java.lang.String, java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>callFunctionInBackground</h4>
<pre>public static <T> <a href="http://boltsframework.github.io/docs/android/bolts/Task.html?is-external=true" title="class or interface in bolts">Task</a><T> callFunctionInBackground(<a href="http://d.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
<a href="http://d.android.com/reference/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://d.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> params)</pre>
<div class="block">Calls a cloud function in the background.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The cloud function to call.</dd><dd><code>params</code> - The parameters to send to the cloud function. This map can contain anything that could
be placed in a ParseObject except for ParseObjects themselves.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A Task that will be resolved when the cloud function has returned.</dd></dl>
</li>
</ul>
<a name="callFunction(java.lang.String, java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>callFunction</h4>
<pre>public static <T> T callFunction(<a href="http://d.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
<a href="http://d.android.com/reference/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://d.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> params)
throws <a href="../../com/parse/ParseException.html" title="class in com.parse">ParseException</a></pre>
<div class="block">Calls a cloud function.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The cloud function to call.</dd><dd><code>params</code> - The parameters to send to the cloud function. This map can contain anything that could
be placed in a ParseObject except for ParseObjects themselves.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The result of the cloud call. Result may be a @{link Map}< <a href="http://d.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a>, ?>,
<a href="../../com/parse/ParseObject.html" title="class in com.parse"><code>ParseObject</code></a>, <a href="http://d.android.com/reference/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a><?>, or any type that can be set as a field in a
ParseObject.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../com/parse/ParseException.html" title="class in com.parse">ParseException</a></code></dd></dl>
</li>
</ul>
<a name="callFunctionInBackground(java.lang.String, java.util.Map, com.parse.FunctionCallback)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>callFunctionInBackground</h4>
<pre>public static <T> void callFunctionInBackground(<a href="http://d.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
<a href="http://d.android.com/reference/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://d.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> params,
<a href="../../com/parse/FunctionCallback.html" title="interface in com.parse">FunctionCallback</a><T> callback)</pre>
<div class="block">Calls a cloud function in the background.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The cloud function to call.</dd><dd><code>params</code> - The parameters to send to the cloud function. This map can contain anything that could
be placed in a ParseObject except for ParseObjects themselves.</dd><dd><code>callback</code> - The callback that will be called when the cloud function has returned.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../com/parse/ParseClassName.html" title="annotation in com.parse"><span class="strong">Prev Class</span></a></li>
<li><a href="../../com/parse/ParseConfig.html" title="class in com.parse"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?com/parse/ParseCloud.html" target="_top">Frames</a></li>
<li><a href="ParseCloud.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>