diff --git a/TodoListManager/AndroidManifest.xml b/TodoListManager/AndroidManifest.xml
index a6fc10d..f6b40fa 100644
--- a/TodoListManager/AndroidManifest.xml
+++ b/TodoListManager/AndroidManifest.xml
@@ -8,6 +8,9 @@
android:minSdkVersion="11"
android:targetSdkVersion="19" />
+
CountCallback
+ +DeleteCallback + +FindCallback + +FunctionCallback + +GetCallback + +GetDataCallback + +LocationCallback + +LogInCallback + +Parse + +ParseACL + +ParseAnalytics + +ParseAnonymousUtils + +ParseClassName + +ParseCloud + +ParseException + +ParseFacebookUtils + +ParseFile + +ParseGeoPoint + +ParseImageView + +ParseInstallation + +ParseObject + +ParsePush + +ParseQuery + +ParseQuery.CachePolicy + +ParseQueryAdapter + +ParseQueryAdapter.OnQueryLoadListener + +ParseQueryAdapter.QueryFactory + +ParseRelation + +ParseRole + +ParseTwitterUtils + +ParseUser + +ProgressCallback + +PushService + +RefreshCallback + +RequestPasswordResetCallback + +SaveCallback + +SendCallback + +SignUpCallback + + |
+
CountCallback
+ +DeleteCallback + +FindCallback + +FunctionCallback + +GetCallback + +GetDataCallback + +LocationCallback + +LogInCallback + +Parse + +ParseACL + +ParseAnalytics + +ParseAnonymousUtils + +ParseClassName + +ParseCloud + +ParseException + +ParseFacebookUtils + +ParseFile + +ParseGeoPoint + +ParseImageView + +ParseInstallation + +ParseObject + +ParsePush + +ParseQuery + +ParseQuery.CachePolicy + +ParseQueryAdapter + +ParseQueryAdapter.OnQueryLoadListener + +ParseQueryAdapter.QueryFactory + +ParseRelation + +ParseRole + +ParseTwitterUtils + +ParseUser + +ProgressCallback + +PushService + +RefreshCallback + +RequestPasswordResetCallback + +SaveCallback + +SendCallback + +SignUpCallback + + |
+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.CountCallback +
public abstract class CountCallback
+A CountCallback is used to run code after a ParseQuery
is used to count objects matching
+ a query in a background thread.
+
+ The easiest way to use a GetCallback is through an anonymous inner class. Override the
+ done
function to specify what the callback should do after the count is complete.
+ The done
function will be run in the UI thread, while the count happens in a
+ background thread. This ensures that the UI does not freeze while the fetch happens.
+
+ For example, this sample code counts objects of class "MyClass"
. It calls a
+ different function depending on whether the count succeeded or not.
+
+ +
+ ParseQuery<ParseObject> query = ParseQuery.getQuery("MyClass"); + query.countInBackground(new CountCallback() { + public void done(int count, ParseException e) { + if (e == null) { + objectsWereCountedSuccessfully(count); + } else { + objectCountingFailed(); + } + } + }); ++
+ +
+
+Constructor Summary | +|
---|---|
CountCallback()
+
++ |
+
+Method Summary | +|
---|---|
+abstract void |
+done(int count,
+ ParseException e)
+
++ Override this function with the code you want to run after the count is complete. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public CountCallback()+
+Method Detail | +
---|
+public abstract void done(int count, + ParseException e)+
+
count
- The number of objects matching the query, or -1 if it failed.e
- The exception raised by the count, or null if it succeeded.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.DeleteCallback +
public abstract class DeleteCallback
+A DeleteCallback is used to run code after saving a ParseObject
in a background thread.
+
+ The easiest way to use a DeleteCallback is through an anonymous inner class. Override the
+ done
function to specify what the callback should do after the delete is complete.
+ The done
function will be run in the UI thread, while the delete happens in a
+ background thread. This ensures that the UI does not freeze while the delete happens.
+
+ For example, this sample code deletes the object myObject
and calls a different
+ function depending on whether the save succeeded or not.
+
+ +
+ myObject.deleteInBackground(new DeleteCallback() { + public void done(ParseException e) { + if (e == null) { + myObjectWasDeletedSuccessfully(); + } else { + myObjectDeleteDidNotSucceed(); + } + } + }); ++
+ +
+
+Constructor Summary | +|
---|---|
DeleteCallback()
+
++ |
+
+Method Summary | +|
---|---|
+abstract void |
+done(ParseException e)
+
++ Override this function with the code you want to run after the delete is complete. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public DeleteCallback()+
+Method Detail | +
---|
+public abstract void done(ParseException e)+
+
e
- The exception raised by the delete, or null if it succeeded.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.FindCallback<T> +
public abstract class FindCallback<T extends ParseObject>
+A FindCallback is used to run code after a ParseQuery
is used to fetch a list of
+ ParseObject
s in a background thread.
+
+ The easiest way to use a FindCallback is through an anonymous inner class. Override the
+ done
function to specify what the callback should do after the fetch is complete.
+ The done
function will be run in the UI thread, while the fetch happens in a
+ background thread. This ensures that the UI does not freeze while the fetch happens.
+
+ For example, this sample code fetches all objects of class "MyClass"
. It calls a
+ different function depending on whether the fetch succeeded or not.
+
+ +
+ ParseQuery<ParseObject> query = ParseQuery.getQuery("MyClass"); + query.findInBackground(new FindCallback<ParseObject>() { + public void done(List<ParseObject> objects, ParseException e) { + if (e == null) { + objectsWereRetrievedSuccessfully(objects); + } else { + objectRetrievalFailed(); + } + } + }); ++
+ +
+
+Constructor Summary | +|
---|---|
FindCallback()
+
++ |
+
+Method Summary | +|
---|---|
+abstract void |
+done(List<T> objects,
+ ParseException e)
+
++ Override this function with the code you want to run after the fetch is complete. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public FindCallback()+
+Method Detail | +
---|
+public abstract void done(List<T> objects, + ParseException e)+
+
objects
- The objects that were retrieved, or null if it did not succeed.e
- The exception raised by the save, or null if it succeeded.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.FunctionCallback<T> +
T
- The type of object returned by the Cloud Function.public abstract class FunctionCallback<T>
+A FunctionCallback is used to run code after ParseCloud.callFunction(java.lang.String, java.util.Map
is used to run a
+ Cloud Function in a background thread.
+
+ The easiest way to use a FunctionCallback is through an anonymous inner class. Override the
+ done
function to specify what the callback should do after the cloud function is
+ complete. The done
function will be run in the UI thread, while the fetch happens in
+ a background thread. This ensures that the UI does not freeze while the fetch happens.
+
+ For example, this sample code calls a cloud function "MyFunction"
with
+ params
and calls a different function depending on whether the function succeeded.
+
+ +
+ ParseCloud.callFunctionInBackground("MyFunction"new, params, FunctionCallback+() { + public void done(ParseObject object, ParseException e) { + if (e == null) { + cloudFunctionSucceeded(object); + } else { + cloudFunctionFailed(); + } + } + }); +
+ +
+
+Constructor Summary | +|
---|---|
FunctionCallback()
+
++ |
+
+Method Summary | +|
---|---|
+abstract void |
+done(T object,
+ ParseException e)
+
++ Override this function with the code you want to run after the cloud function is complete. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public FunctionCallback()+
+Method Detail | +
---|
+public abstract void done(T object, + ParseException e)+
+
object
- The object that was returned by the cloud function.e
- The exception raised by the cloud call, or null if it succeeded.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.GetCallback<T> +
public abstract class GetCallback<T extends ParseObject>
+A GetCallback is used to run code after a ParseQuery
is used to fetch a
+ ParseObject
in a background thread.
+
+ The easiest way to use a GetCallback is through an anonymous inner class. Override the
+ done
function to specify what the callback should do after the fetch is complete.
+ The done
function will be run in the UI thread, while the fetch happens in a
+ background thread. This ensures that the UI does not freeze while the fetch happens.
+
+ For example, this sample code fetches an object of class "MyClass"
and id
+ myId
. It calls a different function depending on whether the fetch succeeded or not.
+
+ +
+ ParseQuery<ParseObject> query = ParseQuery.getQuery("MyClass"); + query.getInBackground(myId, new GetCallback<ParseObject>() { + public void done(ParseObject object, ParseException e) { + if (e == null) { + objectWasRetrievedSuccessfully(object); + } else { + objectRetrievalFailed(); + } + } + }); ++
+ +
+
+Constructor Summary | +|
---|---|
GetCallback()
+
++ |
+
+Method Summary | +|
---|---|
+abstract void |
+done(T object,
+ ParseException e)
+
++ Override this function with the code you want to run after the fetch is complete. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public GetCallback()+
+Method Detail | +
---|
+public abstract void done(T object, + ParseException e)+
+
object
- The object that was retrieved, or null if it did not succeed.e
- The exception raised by the save, or null if it succeeded.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.GetDataCallback +
public abstract class GetDataCallback
+A GetDataCallback is used to run code after a ParseFile
fetches its data on a background
+ thread.
+
+ The easiest way to use a GetDataCallback is through an anonymous inner class. Override the
+ done
function to specify what the callback should do after the fetch is complete.
+ The done
function will be run in the UI thread, while the fetch happens in a
+ background thread. This ensures that the UI does not freeze while the fetch happens.
+
+ file.getDataInBackground(new GetDataCallback() { public void done(byte[] data, ParseException e) + { // ... } }); +
+ +
+
+Constructor Summary | +|
---|---|
GetDataCallback()
+
++ |
+
+Method Summary | +|
---|---|
+abstract void |
+done(byte[] data,
+ ParseException e)
+
++ |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public GetDataCallback()+
+Method Detail | +
---|
+public abstract void done(byte[] data, + ParseException e)+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.LocationCallback +
public abstract class LocationCallback
+A LocationCallback is used to run code after a Location has been fetched by some + LocationProvider. +
+ The easiest way to use a LocationCallback is through an anonymous inner class. Override the
+ done
function to specify what the callback should do after the location has been
+ fetched. The done
function will be run in the UI thread, while the location check
+ happens in a background thread. This ensures that the UI does not freeze while the fetch happens.
+
+ For example, this sample code defines a timeout for fetching the user's current location, and + provides a callback. Within the callback, the success and failure cases are handled differently. +
+ +
+ ParseGeoPoint.getCurrentLocationAsync(1000, new LocationCallback() { + public void done(ParseGeoPoint geoPoint, ParseException e) { + if (e == null) { + // do something with your new ParseGeoPoint + } else { + // handle your error + e.printStackTrace(); + } + } + }); ++
+ +
+
+Constructor Summary | +|
---|---|
LocationCallback()
+
++ |
+
+Method Summary | +|
---|---|
+abstract void |
+done(ParseGeoPoint geoPoint,
+ ParseException e)
+
++ Override this function with the code you want to run after the location fetch is complete. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public LocationCallback()+
+Method Detail | +
---|
+public abstract void done(ParseGeoPoint geoPoint, + ParseException e)+
+
geoPoint
- The ParseGeoPoint returned by the location fetch.e
- The exception raised by the location fetch, or null if it succeeded.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.LogInCallback +
public abstract class LogInCallback
+A LogInCallback is used to run code after logging in a user. +
+ The easiest way to use a LogInCallback is through an anonymous inner class. Override the
+ done
function to specify what the callback should do after the login is complete.
+ The done
function will be run in the UI thread, while the login happens in a
+ background thread. This ensures that the UI does not freeze while the save happens.
+
+ For example, this sample code logs in a user and calls a different function depending on whether + the login succeeded or not. +
+ +
+ ParseUser.logInInBackground("username", "password", new LogInCallback() { + public void done(ParseUser user, ParseException e) { + if (e == null && user != null) { + loginSuccessful(); + } else if (user == null) { + usernameOrPasswordIsInvalid(); + } else { + somethingWentWrong(); + } + } + }); ++
+ +
+
+Constructor Summary | +|
---|---|
LogInCallback()
+
++ |
+
+Method Summary | +|
---|---|
+abstract void |
+done(ParseUser user,
+ ParseException e)
+
++ Override this function with the code you want to run after the save is complete. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public LogInCallback()+
+Method Detail | +
---|
+public abstract void done(ParseUser user, + ParseException e)+
+
user
- The user that logged in, if the username and password is valid.e
- The exception raised by the login.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.Parse +
public class Parse
+The Parse class contains static functions that handle global configuration for the Parse library. +
+ +
+
+Field Summary | +|
---|---|
+static int |
+LOG_LEVEL_DEBUG
+
++ |
+
+static int |
+LOG_LEVEL_ERROR
+
++ |
+
+static int |
+LOG_LEVEL_INFO
+
++ |
+
+static int |
+LOG_LEVEL_NONE
+
++ |
+
+static int |
+LOG_LEVEL_VERBOSE
+
++ |
+
+static int |
+LOG_LEVEL_WARNING
+
++ |
+
+Method Summary | +|
---|---|
+static int |
+getLogLevel()
+
++ Gets the level of logging that will be displayed. |
+
+static void |
+initialize(Context context,
+ String applicationId,
+ String clientKey)
+
++ Authenticates this client as belonging to your application. |
+
+static void |
+setLogLevel(int logLevel)
+
++ Sets the level of logging to display, where each level includes all those below it. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Field Detail | +
---|
+public static final int LOG_LEVEL_VERBOSE+
+public static final int LOG_LEVEL_DEBUG+
+public static final int LOG_LEVEL_INFO+
+public static final int LOG_LEVEL_WARNING+
+public static final int LOG_LEVEL_ERROR+
+public static final int LOG_LEVEL_NONE+
+Method Detail | +
---|
+public static void initialize(Context context, + String applicationId, + String clientKey)+
Parse.initialize
in each of your onCreate
methods. An example:
+
+ + import android.app.Application; + import com.parse.Parse; + + public class MyApplication extends Application { + + public void onCreate() { + Parse.initialize(this, "your application id", "your client key"); + } + + } ++
+
context
- The active Context for your application.applicationId
- The application id provided in the Parse dashboard.clientKey
- The client key provided in the Parse dashboard.+public static void setLogLevel(int logLevel)+
Parse.LOG_LEVEL_ERROR
. Please ensure this is set to Parse.LOG_LEVEL_ERROR
+ or Parse.LOG_LEVEL_NONE
before deploying your app to ensure no sensitive information is
+ logged. The levels are:
+ Parse.LOG_LEVEL_VERBOSE
Parse.LOG_LEVEL_DEBUG
Parse.LOG_LEVEL_INFO
Parse.LOG_LEVEL_WARNING
Parse.LOG_LEVEL_ERROR
Parse.LOG_LEVEL_NONE
+
logLevel
- The level of logcat logging that Parse should do.+public static int getLogLevel()+
+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.ParseACL +
public class ParseACL
+A ParseACL is used to control which users can access or modify a particular object. Each
+ ParseObject
can have its own ParseACL. You can grant read and write permissions
+ separately to specific users, to groups of users that belong to roles, or you can grant
+ permissions to "the public" so that, for example, any user could read a particular object but
+ only a particular set of users could write to that object.
+
+ +
+
+Constructor Summary | +|
---|---|
ParseACL()
+
++ Creates an ACL with no permissions granted. |
+|
ParseACL(ParseUser owner)
+
++ Creates an ACL where only the provided user has access. |
+
+Method Summary | +|
---|---|
+ boolean |
+getPublicReadAccess()
+
++ Get whether the public is allowed to read this object. |
+
+ boolean |
+getPublicWriteAccess()
+
++ Set whether the public is allowed to write this object. |
+
+ boolean |
+getReadAccess(ParseUser user)
+
++ Get whether the given user id is *explicitly* allowed to read this object. |
+
+ boolean |
+getReadAccess(String userId)
+
++ Get whether the given user id is *explicitly* allowed to read this object. |
+
+ boolean |
+getRoleReadAccess(ParseRole role)
+
++ Get whether users belonging to the given role are allowed to read this object. |
+
+ boolean |
+getRoleReadAccess(String roleName)
+
++ Get whether users belonging to the role with the given roleName are allowed to read this + object. |
+
+ boolean |
+getRoleWriteAccess(ParseRole role)
+
++ Get whether users belonging to the given role are allowed to write this object. |
+
+ boolean |
+getRoleWriteAccess(String roleName)
+
++ Get whether users belonging to the role with the given roleName are allowed to write this + object. |
+
+ boolean |
+getWriteAccess(ParseUser user)
+
++ Get whether the given user id is *explicitly* allowed to write this object. |
+
+ boolean |
+getWriteAccess(String userId)
+
++ Get whether the given user id is *explicitly* allowed to write this object. |
+
+static void |
+setDefaultACL(ParseACL acl,
+ boolean withAccessForCurrentUser)
+
++ Sets a default ACL that will be applied to all ParseObject s when they are created. |
+
+ void |
+setPublicReadAccess(boolean allowed)
+
++ Set whether the public is allowed to read this object. |
+
+ void |
+setPublicWriteAccess(boolean allowed)
+
++ Set whether the public is allowed to write this object. |
+
+ void |
+setReadAccess(ParseUser user,
+ boolean allowed)
+
++ Set whether the given user is allowed to read this object. |
+
+ void |
+setReadAccess(String userId,
+ boolean allowed)
+
++ Set whether the given user id is allowed to read this object. |
+
+ void |
+setRoleReadAccess(ParseRole role,
+ boolean allowed)
+
++ Set whether users belonging to the given role are allowed to read this object. |
+
+ void |
+setRoleReadAccess(String roleName,
+ boolean allowed)
+
++ Set whether users belonging to the role with the given roleName are allowed to read this + object. |
+
+ void |
+setRoleWriteAccess(ParseRole role,
+ boolean allowed)
+
++ Set whether users belonging to the given role are allowed to write this object. |
+
+ void |
+setRoleWriteAccess(String roleName,
+ boolean allowed)
+
++ Set whether users belonging to the role with the given roleName are allowed to write this + object. |
+
+ void |
+setWriteAccess(ParseUser user,
+ boolean allowed)
+
++ Set whether the given user is allowed to write this object. |
+
+ void |
+setWriteAccess(String userId,
+ boolean allowed)
+
++ Set whether the given user id is allowed to write this object. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public ParseACL()+
+
+public ParseACL(ParseUser owner)+
+
owner
- The only user that can read or write objects governed by this ACL.+Method Detail | +
---|
+public void setPublicReadAccess(boolean allowed)+
+
+public boolean getPublicReadAccess()+
+
+public void setPublicWriteAccess(boolean allowed)+
+
+public boolean getPublicWriteAccess()+
+
+public void setReadAccess(String userId, + boolean allowed)+
+
+public boolean getReadAccess(String userId)+
+
+public void setWriteAccess(String userId, + boolean allowed)+
+
+public boolean getWriteAccess(String userId)+
+
+public void setReadAccess(ParseUser user, + boolean allowed)+
+
+public boolean getReadAccess(ParseUser user)+
+
+public void setWriteAccess(ParseUser user, + boolean allowed)+
+
+public boolean getWriteAccess(ParseUser user)+
+
+public boolean getRoleReadAccess(String roleName)+
false
, the role may still be able to read it if a parent
+ role has read access.
++
roleName
- The name of the role.
+true
if the role has read access. false
otherwise.+public void setRoleReadAccess(String roleName, + boolean allowed)+
+
roleName
- The name of the role.allowed
- Whether the given role can read this object.+public boolean getRoleWriteAccess(String roleName)+
false
, the role may still be able to write it if a parent
+ role has write access.
++
roleName
- The name of the role.
+true
if the role has write access. false
otherwise.+public void setRoleWriteAccess(String roleName, + boolean allowed)+
+
roleName
- The name of the role.allowed
- Whether the given role can write this object.+public boolean getRoleReadAccess(ParseRole role)+
false
, the role may still be able to read it if a parent role has read access.
+ The role must already be saved on the server and its data must have been fetched in order to
+ use this method.
++
role
- The role to check for access.
+true
if the role has read access. false
otherwise.+public void setRoleReadAccess(ParseRole role, + boolean allowed)+
+
role
- The role to assign access.allowed
- Whether the given role can read this object.+public boolean getRoleWriteAccess(ParseRole role)+
false
, the role may still be able to write it if a parent role has write
+ access. The role must already be saved on the server and its data must have been fetched in
+ order to use this method.
++
role
- The role to check for access.
+true
if the role has write access. false
otherwise.+public void setRoleWriteAccess(ParseRole role, + boolean allowed)+
+
role
- The role to assign access.allowed
- Whether the given role can write this object.+public static void setDefaultACL(ParseACL acl, + boolean withAccessForCurrentUser)+
ParseObject
s when they are created.
++
acl
- The ACL to use as a template for all ParseObject
s created after setDefaultACL
+ has been called. This value will be copied and used as a template for the creation of
+ new ACLs, so changes to the instance after setDefaultACL() has been called will not be
+ reflected in new ParseObject
s.withAccessForCurrentUser
- If true, the ParseACL that is applied to newly-created ParseObject
s will
+ provide read and write access to the ParseUser.getCurrentUser()
at the time of
+ creation. If false, the provided ACL will be used without modification. If acl is
+ null, this value is ignored.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.ParseAnalytics +
public class ParseAnalytics
+The ParseAnalytics class provides an interface to Parse's logging and analytics backend. Methods + will return immediately and cache requests (+ timestamps) to be handled "eventually." That is, + the request will be sent immediately if possible or the next time a network connection is + available otherwise. +
+ +
+
+Constructor Summary | +|
---|---|
ParseAnalytics()
+
++ |
+
+Method Summary | +|
---|---|
+static void |
+trackAppOpened(Intent intent)
+
++ Tracks this application being launched (and if this happened as the result of the user opening + a push notification, this method sends along information to correlate this open with that + push). |
+
+static void |
+trackEvent(String name)
+
++ Tracks the occurrence of a custom event. |
+
+static void |
+trackEvent(String name,
+ Map<String,String> dimensions)
+
++ Tracks the occurrence of a custom event with additional dimensions. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public ParseAnalytics()+
+Method Detail | +
---|
+public static void trackAppOpened(Intent intent)+
+
intent
- The Intent
that started an Activity
, if any. Can be null.+public static void trackEvent(String name)+
+
name
- The name of the custom event to report to Parse as having happened.+public static void trackEvent(String name, + Map<String,String> dimensions)+
+ To track a user signup along with additional metadata, consider the following: +
+ Map+ There is a default limit of 4 dimensions per event tracked. +dimensions = new HashMap (); + dimensions.put("gender", "m"); + dimensions.put("source", "web"); + dimensions.put("dayType", "weekend"); + ParseAnalytics.trackEvent("signup", dimensions); +
+
name
- The name of the custom event to report to Parse as having happened.dimensions
- The dictionary of information by which to segment this event.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.ParseAnonymousUtils +
public final class ParseAnonymousUtils
+Provides utility functions for working with Anonymously logged-in users. Anonymous users have + some unique characteristics: +
+ +
+
+Method Summary | +|
---|---|
+static boolean |
+isLinked(ParseUser user)
+
++ Whether the user is logged in anonymously. |
+
+static void |
+logIn(LogInCallback callback)
+
++ Creates an anonymous user. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Method Detail | +
---|
+public static boolean isLinked(ParseUser user)+
+
user
- User to check for anonymity. The user must be logged in on this device.
++public static void logIn(LogInCallback callback)+
+
callback
- The callback to execute when anonymous user creation is complete.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: REQUIRED | OPTIONAL | ++DETAIL: ELEMENT | +
Associates a class name for a subclass of ParseObject. ++ +
+
+ +
+Required Element Summary | +|
---|---|
+ String |
+value
+
++ |
+
+Element Detail | +
---|
+public abstract String value+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: REQUIRED | OPTIONAL | ++DETAIL: ELEMENT | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.ParseCloud +
public class ParseCloud
+The ParseCloud class defines provides methods for interacting with Parse Cloud Functions. A Cloud
+ Function can be called with ParseCloud.callFunctionInBackground(String, Map, FunctionCallback)
+ using a FunctionCallback
. For example, this sample code calls the "validateGame" Cloud
+ Function and calls processResponse if the call succeeded and handleError if it failed.
+
+
+ ParseCloud.callFunctionInBackground("validateGame", parameters, new FunctionCallback+ + 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 +
ParseCloud.callFunction(String, Map)
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.
++ +
+
+Constructor Summary | +|
---|---|
ParseCloud()
+
++ |
+
+Method Summary | +||
---|---|---|
+static
+ |
+callFunction(String name,
+ Map<String,?> params)
+
++ Calls a cloud function. |
+|
+static
+ |
+callFunctionInBackground(String name,
+ Map<String,?> params,
+ FunctionCallback<T> callback)
+
++ Calls a cloud function in the background. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public ParseCloud()+
+Method Detail | +
---|
+public static <T> T callFunction(String name, + Map<String,?> params) + throws ParseException+
+
name
- The cloud function to callparams
- The parameters to send to the cloud function. This map can contain anything that could
+ be placed in a ParseObject except for ParseObjects themselves.
+String
, ?>,
+ ParseObject
, List
<?>, or any type that can be set as a field in a
+ ParseObject.
+ParseException
+public static <T> void callFunctionInBackground(String name, + Map<String,?> params, + FunctionCallback<T> callback)+
+
name
- The cloud function to callparams
- The parameters to send to the cloud function. This map can contain anything that could
+ be placed in a ParseObject except for ParseObjects themselves.callback
- The callback that will be called when the cloud function has returned.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++Throwable +
Exception +
com.parse.ParseException +
public class ParseException
+A ParseException gets raised whenever a ParseObject
issues an invalid request, such as
+ deleting or editing an object that no longer exists on the server, or when there is a network
+ failure preventing communication with the Parse server.
+
+ +
+
+Field Summary | +|
---|---|
+static int |
+ACCOUNT_ALREADY_LINKED
+
++ Error code indicating that an an account being linked is already linked to another user. |
+
+static int |
+CACHE_MISS
+
++ Error code indicating the result was not found in the cache. |
+
+static int |
+COMMAND_UNAVAILABLE
+
++ Error code indicating that the feature you tried to access is only available internally for + testing purposes. |
+
+static int |
+CONNECTION_FAILED
+
++ Error code indicating the connection to the Parse servers failed. |
+
+static int |
+DUPLICATE_VALUE
+
++ Error code indicating that a unique field was given a value that is already taken. |
+
+static int |
+EMAIL_MISSING
+
++ Error code indicating that the email is missing, but must be specified. |
+
+static int |
+EMAIL_NOT_FOUND
+
++ Error code indicating that a user with the specified email was not found. |
+
+static int |
+EMAIL_TAKEN
+
++ Error code indicating that the email has already been taken. |
+
+static int |
+EXCEEDED_QUOTA
+
++ Error code indicating that an application quota was exceeded. |
+
+static int |
+FILE_DELETE_ERROR
+
++ Error code indicating that deleting a file failed. |
+
+static int |
+INCORRECT_TYPE
+
++ Error code indicating that a field was set to an inconsistent type. |
+
+static int |
+INTERNAL_SERVER_ERROR
+
++ Error code indicating that something has gone wrong with the server. |
+
+static int |
+INVALID_ACL
+
++ Error code indicating an invalid ACL was provided. |
+
+static int |
+INVALID_CHANNEL_NAME
+
++ Error code indicating an invalid channel name. |
+
+static int |
+INVALID_CLASS_NAME
+
++ Error code indicating a missing or invalid classname. |
+
+static int |
+INVALID_EMAIL_ADDRESS
+
++ Error code indicating that the email address was invalid. |
+
+static int |
+INVALID_FILE_NAME
+
++ Error code indicating that an invalid filename was used for ParseFile. |
+
+static int |
+INVALID_JSON
+
++ Error code indicating that badly formed JSON was received upstream. |
+
+static int |
+INVALID_KEY_NAME
+
++ Error code indicating an invalid key name. |
+
+static int |
+INVALID_LINKED_SESSION
+
++ Error code indicating that a user with a linked (e.g. |
+
+static int |
+INVALID_NESTED_KEY
+
++ Error code indicating that an invalid key was used in a nested JSONObject. |
+
+static int |
+INVALID_POINTER
+
++ Error code indicating a malformed pointer. |
+
+static int |
+INVALID_QUERY
+
++ Error code indicating you tried to query with a datatype that doesn't support it, like exact + matching an array or object. |
+
+static int |
+INVALID_ROLE_NAME
+
++ Error code indicating that a role's name is invalid. |
+
+static int |
+LINKED_ID_MISSING
+
++ Error code indicating that a user cannot be linked to an account because that account's id + could not be found. |
+
+static int |
+MISSING_OBJECT_ID
+
++ Error code indicating an unspecified object id. |
+
+static int |
+MUST_CREATE_USER_THROUGH_SIGNUP
+
++ Error code indicating that a user can only be created through signup. |
+
+static int |
+NOT_INITIALIZED
+
++ You must call Parse.initialize before using the Parse library. |
+
+static int |
+OBJECT_NOT_FOUND
+
++ Error code indicating the specified object doesn't exist. |
+
+static int |
+OBJECT_TOO_LARGE
+
++ Error code indicating that the object is too large. |
+
+static int |
+OPERATION_FORBIDDEN
+
++ Error code indicating that the operation isn't allowed for clients. |
+
+static int |
+OTHER_CAUSE
+
++ |
+
+static int |
+PASSWORD_MISSING
+
++ Error code indicating that the password is missing or empty. |
+
+static int |
+PUSH_MISCONFIGURED
+
++ Error code indicating that push is misconfigured. |
+
+static int |
+SCRIPT_ERROR
+
++ Error code indicating that a Cloud Code script failed. |
+
+static int |
+SESSION_MISSING
+
++ Error code indicating that a user object without a valid session could not be altered. |
+
+static int |
+TIMEOUT
+
++ Error code indicating that the request timed out on the server. |
+
+static int |
+UNSUPPORTED_SERVICE
+
++ Error code indicating that a service being linked (e.g. |
+
+static int |
+USERNAME_MISSING
+
++ Error code indicating that the username is missing or empty. |
+
+static int |
+USERNAME_TAKEN
+
++ Error code indicating that the username has already been taken. |
+
+static int |
+VALIDATION_ERROR
+
++ Error code indicating that cloud code validation failed. |
+
+Constructor Summary | +|
---|---|
ParseException(int theCode,
+ String theMessage)
+
++ Construct a new ParseException with a particular error code. |
+|
ParseException(String message,
+ Throwable cause)
+
++ Construct a new ParseException with an external cause. |
+|
ParseException(Throwable cause)
+
++ Construct a new ParseException with an external cause. |
+
+Method Summary | +|
---|---|
+ int |
+getCode()
+
++ Access the code for this error. |
+
Methods inherited from class Throwable | +
---|
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
+
+Field Detail | +
---|
+public static final int OTHER_CAUSE+
+public static final int INTERNAL_SERVER_ERROR+
+
+public static final int CONNECTION_FAILED+
+
+public static final int OBJECT_NOT_FOUND+
+
+public static final int INVALID_QUERY+
+
+public static final int INVALID_CLASS_NAME+
+
+public static final int MISSING_OBJECT_ID+
+
+public static final int INVALID_KEY_NAME+
+
+public static final int INVALID_POINTER+
+
+public static final int INVALID_JSON+
+
+public static final int COMMAND_UNAVAILABLE+
+
+public static final int NOT_INITIALIZED+
+
+public static final int INCORRECT_TYPE+
+
+public static final int INVALID_CHANNEL_NAME+
+
+public static final int PUSH_MISCONFIGURED+
+
+public static final int OBJECT_TOO_LARGE+
+
+public static final int OPERATION_FORBIDDEN+
+
+public static final int CACHE_MISS+
+
+public static final int INVALID_NESTED_KEY+
+
+public static final int INVALID_FILE_NAME+
+
+public static final int INVALID_ACL+
+
+public static final int TIMEOUT+
+
+public static final int INVALID_EMAIL_ADDRESS+
+
+public static final int DUPLICATE_VALUE+
+
+public static final int INVALID_ROLE_NAME+
+
+public static final int EXCEEDED_QUOTA+
+
+public static final int SCRIPT_ERROR+
+
+public static final int VALIDATION_ERROR+
+
+public static final int FILE_DELETE_ERROR+
+
+public static final int USERNAME_MISSING+
+
+public static final int PASSWORD_MISSING+
+
+public static final int USERNAME_TAKEN+
+
+public static final int EMAIL_TAKEN+
+
+public static final int EMAIL_MISSING+
+
+public static final int EMAIL_NOT_FOUND+
+
+public static final int SESSION_MISSING+
+
+public static final int MUST_CREATE_USER_THROUGH_SIGNUP+
+
+public static final int ACCOUNT_ALREADY_LINKED+
+
+public static final int LINKED_ID_MISSING+
+
+public static final int INVALID_LINKED_SESSION+
+
+public static final int UNSUPPORTED_SERVICE+
+
+Constructor Detail | +
---|
+public ParseException(int theCode, + String theMessage)+
+
theCode
- The error code to identify the type of exception.theMessage
- A message describing the error in more detail.+public ParseException(String message, + Throwable cause)+
+
message
- A message describing the error in more detail.cause
- The cause of the error.+public ParseException(Throwable cause)+
+
cause
- The cause of the error.+Method Detail | +
---|
+public int getCode()+
+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.ParseFacebookUtils +
public final class ParseFacebookUtils
+Provides a set of utilities for using Parse with Facebook. +
+ +
+
+Method Summary | +|
---|---|
+static void |
+extendAccessToken(ParseUser user,
+ Context context,
+ SaveCallback callback)
+
++ Deprecated. |
+
+static boolean |
+extendAccessTokenIfNeeded(ParseUser user,
+ Context context,
+ SaveCallback callback)
+
++ Deprecated. |
+
+static void |
+finishAuthentication(int requestCode,
+ int resultCode,
+ Intent data)
+
++ Completes authentication after the Facebook app returns an activity result. |
+
+static com.facebook.android.Facebook |
+getFacebook()
+
++ Deprecated. |
+
+static com.facebook.Session |
+getSession()
+
++ |
+
+static void |
+initialize(String appId)
+
++ Initializes Facebook for use with Parse. |
+
+static boolean |
+isLinked(ParseUser user)
+
++ Returns true if the user is linked to a Facebook account. |
+
+static void |
+link(ParseUser user,
+ Activity activity)
+
++ |
+
+static void |
+link(ParseUser user,
+ Activity activity,
+ int activityCode)
+
++ |
+
+static void |
+link(ParseUser user,
+ Activity activity,
+ int activityCode,
+ SaveCallback callback)
+
++ |
+
+static void |
+link(ParseUser user,
+ Activity activity,
+ SaveCallback callback)
+
++ |
+
+static void |
+link(ParseUser user,
+ Collection<String> permissions,
+ Activity activity)
+
++ |
+
+static void |
+link(ParseUser user,
+ Collection<String> permissions,
+ Activity activity,
+ int activityCode)
+
++ |
+
+static void |
+link(ParseUser user,
+ Collection<String> permissions,
+ Activity activity,
+ int activityCode,
+ SaveCallback callback)
+
++ Links a ParseUser to a Facebook account, allowing you to use Facebook for authentication, and + providing access to Facebook data for the user. |
+
+static void |
+link(ParseUser user,
+ Collection<String> permissions,
+ Activity activity,
+ SaveCallback callback)
+
++ Links a user using the default activity code if single sign-on is enabled. |
+
+static void |
+link(ParseUser user,
+ String facebookId,
+ String accessToken,
+ Date expirationDate)
+
++ |
+
+static void |
+link(ParseUser user,
+ String facebookId,
+ String accessToken,
+ Date expirationDate,
+ SaveCallback callback)
+
++ Links a ParseUser to a Facebook account, allowing you to use Facebook for authentication, and + providing access to Facebook data for the user. |
+
+static void |
+logIn(Activity activity,
+ int activityCode,
+ LogInCallback callback)
+
++ |
+
+static void |
+logIn(Activity activity,
+ LogInCallback callback)
+
++ |
+
+static void |
+logIn(Collection<String> permissions,
+ Activity activity,
+ int activityCode,
+ LogInCallback callback)
+
++ Logs in a ParseUser using Facebook for authentication. |
+
+static void |
+logIn(Collection<String> permissions,
+ Activity activity,
+ LogInCallback callback)
+
++ Logs in a user using the default activity code if single sign-on is enabled. |
+
+static void |
+logIn(String facebookId,
+ String accessToken,
+ Date expirationDate,
+ LogInCallback callback)
+
++ Logs in a ParseUser using Facebook for authentication. |
+
+static void |
+saveLatestSessionData(ParseUser user)
+
++ |
+
+static void |
+saveLatestSessionData(ParseUser user,
+ SaveCallback callback)
+
++ Saves the latest session data to the user. |
+
+static boolean |
+shouldExtendAccessToken(ParseUser user)
+
++ Deprecated. |
+
+static void |
+unlink(ParseUser user)
+
++ Unlinks a user from a Facebook account. |
+
+static void |
+unlinkInBackground(ParseUser user)
+
++ |
+
+static void |
+unlinkInBackground(ParseUser user,
+ SaveCallback callback)
+
++ Unlinks a user from a Facebook account in the background. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Method Detail | +
---|
+@Deprecated +public static com.facebook.android.Facebook getFacebook()+
+
+
+public static com.facebook.Session getSession()+
+public static boolean isLinked(ParseUser user)+
true
if the user is linked to a Facebook account.
++
+public static void initialize(String appId)+
ParseFacebookUtils.logIn(Activity, int, LogInCallback)
or
+ ParseFacebookUtils.link(ParseUser, Activity, int, SaveCallback)
. You may invoke this method more than
+ once if you need to change the appId.
+
+ IMPORTANT: If you choose to enable single sign-on, you must override the
+ Activity.onActivityResult(int, int, android.content.Intent)
method to invoke
+ ParseFacebookUtils.finishAuthentication(int, int, Intent)
.
++
appId
- The Facebook appId for your application.ParseFacebookUtils.logIn(Collection, Activity, int, LogInCallback)
,
+ParseFacebookUtils.link(ParseUser, Collection, Activity, int, SaveCallback)
+public static void unlink(ParseUser user) + throws ParseException+
+
ParseException
+public static void unlinkInBackground(ParseUser user)+
ParseFacebookUtils.unlinkInBackground(ParseUser)
+public static void unlinkInBackground(ParseUser user, + SaveCallback callback)+
+
+public static void link(ParseUser user, + String facebookId, + String accessToken, + Date expirationDate)+
ParseFacebookUtils.link(ParseUser, String, String, Date, SaveCallback)
+public static void link(ParseUser user, + String facebookId, + String accessToken, + Date expirationDate, + SaveCallback callback)+
+
user
- The user to link to a Facebook account.facebookId
- The facebook ID of the user being linked.accessToken
- The access token for the user.expirationDate
- The expiration date of the access token.callback
- Callback for notifying when the new authentication data has been saved to the user.+public static void link(ParseUser user, + Collection<String> permissions, + Activity activity, + int activityCode, + SaveCallback callback)+
authenticate()
method.
+
+ IMPORTANT: Note that single sign-on authentication will not function correctly if you do
+ not include a call to the finishAuthentication()
method in your onActivityResult()
+ function! Please see below for more information.
+
+ From the Facebook SDK documentation:
+
+ Starts either an Activity or a dialog which prompts the user to log in to Facebook and grant
+ the requested permissions to the given application.
+
+ This method will, when possible, use Facebook's single sign-on for Android to obtain an access
+ token. This involves proxying a call through the Facebook for Android stand-alone application,
+ which will handle the authentication flow, and return an OAuth access token for making API
+ calls.
+
+ Because this process will not be available for all users, if single sign-on is not possible,
+ this method will automatically fall back to the OAuth 2.0 User-Agent flow. In this flow, the
+ user credentials are handled by Facebook in an embedded WebView, not by the client application.
+ As such, the dialog makes a network request and renders HTML content rather than a native UI.
+ The access token is retrieved from a redirect to a special URL that the WebView handles.
++
user
- The user to link to a Facebook account.permissions
- A list of permissions to be used when logging in. Many of these constants are defined
+ here: ParseFacebookUtils.Permissions
.activity
- The Android activity in which we want to display the authorization dialog.activityCode
- Single sign-on requires an activity result to be called back to the client application
+ -- if you are waiting on other activities to return data, pass a custom activity code
+ here to avoid collisions.callback
- Callback for notifying the calling application when the Facebook authentication has
+ completed, failed, or been canceled.+public static void link(ParseUser user, + Collection<String> permissions, + Activity activity, + SaveCallback callback)+
+
ParseFacebookUtils.link(ParseUser, Collection, Activity, int, SaveCallback)
+public static void link(ParseUser user, + Collection<String> permissions, + Activity activity, + int activityCode)+
ParseFacebookUtils.link(ParseUser, Collection, Activity, int, SaveCallback)
+public static void link(ParseUser user, + Collection<String> permissions, + Activity activity)+
ParseFacebookUtils.link(ParseUser, Collection, Activity, int, SaveCallback)
+public static void link(ParseUser user, + Activity activity, + int activityCode, + SaveCallback callback)+
ParseFacebookUtils.link(ParseUser, Collection, Activity, int, SaveCallback)
+public static void link(ParseUser user, + Activity activity, + SaveCallback callback)+
ParseFacebookUtils.link(ParseUser, Collection, Activity, int, SaveCallback)
+public static void link(ParseUser user, + Activity activity, + int activityCode)+
ParseFacebookUtils.link(ParseUser, Collection, Activity, int, SaveCallback)
+public static void link(ParseUser user, + Activity activity)+
ParseFacebookUtils.link(ParseUser, Collection, Activity, int, SaveCallback)
+public static void logIn(String facebookId, + String accessToken, + Date expirationDate, + LogInCallback callback)+
+
facebookId
- The facebook ID of the user being linked.accessToken
- The access token for the user.expirationDate
- The expiration date of the access token.callback
- Callback for notifying when the new authentication data has been saved to the user.+public static void logIn(Collection<String> permissions, + Activity activity, + int activityCode, + LogInCallback callback)+
authenticate()
method.
+
+ IMPORTANT: Note that single sign-on authentication will not function correctly if you do
+ not include a call to the finishAuthentication()
method in your onActivityResult()
+ function! Please see below for more information.
+
+ From the Facebook SDK documentation:
+
+ Starts either an Activity or a dialog which prompts the user to log in to Facebook and grant
+ the requested permissions to the given application.
+
+ This method will, when possible, use Facebook's single sign-on for Android to obtain an access
+ token. This involves proxying a call through the Facebook for Android stand-alone application,
+ which will handle the authentication flow, and return an OAuth access token for making API
+ calls.
+
+ Because this process will not be available for all users, if single sign-on is not possible,
+ this method will automatically fall back to the OAuth 2.0 User-Agent flow. In this flow, the
+ user credentials are handled by Facebook in an embedded WebView, not by the client application.
+ As such, the dialog makes a network request and renders HTML content rather than a native UI.
+ The access token is retrieved from a redirect to a special URL that the WebView handles.
++
permissions
- A list of permissions to be used when logging in. Many of these constants are defined
+ here: ParseFacebookUtils.Permissions
.activity
- The Android activity in which we want to display the authorization dialog.activityCode
- Single sign-on requires an activity result to be called back to the client application
+ -- if you are waiting on other activities to return data, pass a custom activity code
+ here to avoid collisions.callback
- Callback for notifying the calling application when the Facebook authentication has
+ completed, failed, or been canceled.+public static void logIn(Activity activity, + int activityCode, + LogInCallback callback)+
ParseFacebookUtils.logIn(Collection, Activity, int, LogInCallback)
+public static void logIn(Collection<String> permissions, + Activity activity, + LogInCallback callback)+
+
ParseFacebookUtils.logIn(Collection, Activity, int, LogInCallback)
+public static void logIn(Activity activity, + LogInCallback callback)+
ParseFacebookUtils.logIn(Collection, Activity, int, LogInCallback)
+public static void finishAuthentication(int requestCode, + int resultCode, + Intent data)+
ParseFacebookUtils.logIn(Activity, int, LogInCallback)
or
+ ParseFacebookUtils.link(ParseUser, Activity, int, SaveCallback)
methods in ParseFacebookUtilities
+ . For more information, see http://developer.android.com/reference/android/app/
+ Activity.html#onActivityResult(int, int, android.content.Intent)
++
+public static void saveLatestSessionData(ParseUser user, + SaveCallback callback)+
+
user
- The user whose session information should be updated.callback
- Callback invoked when the session data has been saved.+public static void saveLatestSessionData(ParseUser user)+
ParseFacebookUtils.saveLatestSessionData(ParseUser, SaveCallback)
+@Deprecated +public static boolean shouldExtendAccessToken(ParseUser user)+
+
+
+@Deprecated +public static void extendAccessToken(ParseUser user, + Context context, + SaveCallback callback)+
+
+
+@Deprecated +public static boolean extendAccessTokenIfNeeded(ParseUser user, + Context context, + SaveCallback callback)+
+
+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.ParseFile +
public class ParseFile
+ParseFile is a local representation of a file that is saved to the Parse cloud. +
+ The workflow is to construct a ParseFile with data and optionally a filename. Then save it and + set it as a field on a ParseObject. +
+ Example: ParseFile file = new ParseFile("hello".getBytes()); file.save(); ParseObject object = + new ParseObject("TestObject"); object.put("file", file); object.save(); +
+ +
+
+Constructor Summary | +|
---|---|
ParseFile(byte[] data)
+
++ Creates a new file from a byte array. |
+|
ParseFile(byte[] data,
+ String contentType)
+
++ Creates a new file from a byte array, and content type. |
+|
ParseFile(String name,
+ byte[] data)
+
++ Creates a new file from a byte array and a name. |
+|
ParseFile(String name,
+ byte[] data,
+ String contentType)
+
++ Creates a new file from a byte array, file name, and content type. |
+
+Method Summary | +|
---|---|
+ void |
+cancel()
+
++ Cancels the current network request and callbacks whether it's uploading or fetching data from + the server. |
+
+ byte[] |
+getData()
+
++ Synchronously gets the data for this object. |
+
+ void |
+getDataInBackground(GetDataCallback dataCallback)
+
++ Gets the data for this object in a background thread. |
+
+ void |
+getDataInBackground(GetDataCallback dataCallback,
+ ProgressCallback progressCallback)
+
++ Gets the data for this object in a background thread. |
+
+ String |
+getName()
+
++ The filename. |
+
+ String |
+getUrl()
+
++ This returns the url of the file. |
+
+ boolean |
+isDataAvailable()
+
++ Whether the file has available data. |
+
+ boolean |
+isDirty()
+
++ Whether the file still needs to be saved. |
+
+ void |
+save()
+
++ Saves the file to the Parse cloud synchronously. |
+
+ void |
+saveInBackground()
+
++ Saves the file to the Parse cloud in a background thread. |
+
+ void |
+saveInBackground(SaveCallback callback)
+
++ Saves the file to the Parse cloud in a background thread. |
+
+ void |
+saveInBackground(SaveCallback saveCallback,
+ ProgressCallback progressCallback)
+
++ Saves the file to the Parse cloud in a background thread. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public ParseFile(String name, + byte[] data, + String contentType)+
+
name
- The file's name, ideally with extension. The file name must begin with an alphanumeric
+ character, and consist of alphanumeric characters, periods, spaces, underscores, or
+ dashes.data
- The file's data.contentType
- The file's content type.+public ParseFile(byte[] data)+
+
data
- The file's data.+public ParseFile(String name, + byte[] data)+
+
name
- The file's name, ideally with extension. The file name must begin with an alphanumeric
+ character, and consist of alphanumeric characters, periods, spaces, underscores, or
+ dashes.data
- The file's data.+public ParseFile(byte[] data, + String contentType)+
+
data
- The file's data.contentType
- The file's content type.+Method Detail | +
---|
+public String getName()+
+
+public boolean isDirty()+
+
+public boolean isDataAvailable()+
+
+public String getUrl()+
+
+public void save() + throws ParseException+
+
ParseException
+public void saveInBackground(SaveCallback saveCallback, + ProgressCallback progressCallback)+
+
saveCallback
- A SaveCallback that gets called when the save completes.progressCallback
- A ProgressCallback that is called periodically with progress updates.+public void saveInBackground(SaveCallback callback)+
+
callback
- A SaveCallback that gets called when the save completes.+public void saveInBackground()+
+
+public byte[] getData() + throws ParseException+
ParseFile.getDataInBackground(com.parse.GetDataCallback, com.parse.ProgressCallback)
instead unless you're already in a background thread.
++
ParseException
+public void getDataInBackground(GetDataCallback dataCallback, + ProgressCallback progressCallback)+
+
dataCallback
- A GetDataCallback that is called when the get completes.progressCallback
- A ProgressCallback that is called periodically with progress updates.+public void getDataInBackground(GetDataCallback dataCallback)+
+
dataCallback
- A GetDataCallback that is called when the get completes.+public void cancel()+
+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.ParseGeoPoint +
public class ParseGeoPoint
+ParseGeoPoint represents a latitude / longitude point that may be associated with a key in a + ParseObject or used as a reference point for geo queries. This allows proximity based queries on + the key. +
+ Only one key in a class may contain a GeoPoint. +
+ Example:
+ ParseGeoPoint point = new ParseGeoPoint(30.0, -20.0);
+ ParseObject object = new ParseObject("PlaceObject");
+ object.put("location", point);
+ object.save();
+
+
+ +
+
+Constructor Summary | +|
---|---|
ParseGeoPoint()
+
++ Creates a new default point with latitude and longitude set to 0.0. |
+|
ParseGeoPoint(double latitude,
+ double longitude)
+
++ Creates a new point with the specified latitude and longitude. |
+
+Method Summary | +|
---|---|
+ double |
+distanceInKilometersTo(ParseGeoPoint point)
+
++ Get distance between this point and another geopoint in kilometers. |
+
+ double |
+distanceInMilesTo(ParseGeoPoint point)
+
++ Get distance between this point and another geopoint in kilometers. |
+
+ double |
+distanceInRadiansTo(ParseGeoPoint point)
+
++ Get distance in radians between this point and another GeoPoint. |
+
+static void |
+getCurrentLocationInBackground(long timeout,
+ Criteria criteria,
+ LocationCallback callback)
+
++ Fetches the user's current location and returns a new ParseGeoPoint via the provided + LocationCallback. |
+
+static void |
+getCurrentLocationInBackground(long timeout,
+ LocationCallback callback)
+
++ Fetches the user's current location and returns a new ParseGeoPoint via the provided + LocationCallback. |
+
+ double |
+getLatitude()
+
++ Get latitude. |
+
+ double |
+getLongitude()
+
++ Get longitude. |
+
+ void |
+setLatitude(double latitude)
+
++ Set latitude. |
+
+ void |
+setLongitude(double longitude)
+
++ Set longitude. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public ParseGeoPoint()+
+
+public ParseGeoPoint(double latitude, + double longitude)+
+
latitude
- The point's latitude.longitude
- The point's longitude.+Method Detail | +
---|
+public void setLatitude(double latitude)+
+
latitude
- The point's latitude.+public double getLatitude()+
+
+public void setLongitude(double longitude)+
+
longitude
- The point's longitude.+public double getLongitude()+
+
+public double distanceInRadiansTo(ParseGeoPoint point)+
+
point
- GeoPoint describing the other point being measured against.+public double distanceInKilometersTo(ParseGeoPoint point)+
+
point
- GeoPoint describing the other point being measured against.+public double distanceInMilesTo(ParseGeoPoint point)+
+
point
- GeoPoint describing the other point being measured against.+public static void getCurrentLocationInBackground(long timeout, + LocationCallback callback)+
+
timeout
- The number of milliseconds to allow before timing out.callback
- callback.done(geoPoint, error) is called when a location is found.+public static void getCurrentLocationInBackground(long timeout, + Criteria criteria, + LocationCallback callback)+
+
timeout
- The number of milliseconds to allow before timing out.criteria
- The application criteria for selecting a location provider.callback
- callback.done(geoPoint, error) is called when a location is found.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++android.view.View +
android.widget.ImageView +
com.parse.ParseImageView +
public class ParseImageView
+A specialized ImageView
that downloads and displays remote images stored on Parse's
+ servers.
+
+ Given a ParseFile
storing an image, a ParseImageView
works seamlessly to fetch
+ the file data and display it in the background. See below for an example:
+
+
+ ParseImageView imageView = (ParseImageView) findViewById(android.R.id.icon); + // The placeholder will be used before and during the fetch, to be replaced by the fetched image + // data. + imageView.setPlaceholder(getResources().getDrawable(R.drawable.placeholder)); + imageView.setParseFile(file); + imageView.loadInBackground(new GetDataCallback() { + @Override + public void done(byte[] data, ParseException e) { + Log.i("ParseImageView", + "Fetched! Data length: " + data.length + ", or exception: " + e.getMessage()); + } + }); ++
+ +
+
+Nested Class Summary | +
---|
Nested classes/interfaces inherited from class android.widget.ImageView | +
---|
ImageView.ScaleType |
+
Nested classes/interfaces inherited from class android.view.View | +
---|
View.BaseSavedState, View.MeasureSpec, View.OnClickListener, View.OnCreateContextMenuListener, View.OnFocusChangeListener, View.OnKeyListener, View.OnLongClickListener, View.OnTouchListener |
+
+Field Summary | +
---|
+Constructor Summary | +|
---|---|
ParseImageView(Context context)
+
++ Simple constructor to use when creating a ParseImageView from code. |
+|
ParseImageView(Context context,
+ AttributeSet attributeSet)
+
++ Constructor that is called when inflating a ParseImageView from XML. |
+|
ParseImageView(Context context,
+ AttributeSet attributeSet,
+ int defStyle)
+
++ Perform inflation from XML and apply a class-specific base style. |
+
+Method Summary | +|
---|---|
+ void |
+loadInBackground()
+
++ Kick off downloading of remote image. |
+
+ void |
+loadInBackground(GetDataCallback completionCallback)
+
++ Kick off downloading of remote image. |
+
+protected void |
+onDetachedFromWindow()
+
++ |
+
+ void |
+setImageBitmap(Bitmap bitmap)
+
++ |
+
+ void |
+setParseFile(ParseFile file)
+
++ Sets the remote file on Parse's server that stores the image. |
+
+ void |
+setPlaceholder(Drawable placeholder)
+
++ Sets the placeholder to be used while waiting for an image to be loaded. |
+
Methods inherited from class android.widget.ImageView | +
---|
clearColorFilter, drawableStateChanged, getBaseline, getDrawable, getImageMatrix, getScaleType, invalidateDrawable, onCreateDrawableState, onDraw, onMeasure, onSetAlpha, setAdjustViewBounds, setAlpha, setColorFilter, setColorFilter, setColorFilter, setFrame, setImageDrawable, setImageLevel, setImageMatrix, setImageResource, setImageState, setImageURI, setMaxHeight, setMaxWidth, setScaleType, setSelected, verifyDrawable |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public ParseImageView(Context context)+
ParseImageView
from code.
++
context
- Context for this View+public ParseImageView(Context context, + AttributeSet attributeSet)+
ParseImageView
from XML.
++
context
- Context for this ViewattributeSet
- AttributeSet defined for this View in XML+public ParseImageView(Context context, + AttributeSet attributeSet, + int defStyle)+
+
context
- Context for this ViewattributeSet
- AttributeSet defined for this View in XMLdefStyle
- Class-specific base style.+Method Detail | +
---|
+protected void onDetachedFromWindow()+
onDetachedFromWindow
in class View
+public void setImageBitmap(Bitmap bitmap)+
setImageBitmap
in class ImageView
+public void setPlaceholder(Drawable placeholder)+
+
placeholder
- A Drawable
to be displayed while the remote image data is being fetched. This
+ value can be null, and this ImageView
will simply be blank while data is
+ fetched.+public void setParseFile(ParseFile file)+
+
file
- The remote file on Parse's server.+public void loadInBackground()+
+
+public void loadInBackground(GetDataCallback completionCallback)+
completionCallback
will be triggered.
++
completionCallback
- A custom GetDataCallback
to be called after the image data is fetched and this
+ ImageView
displays the image.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.ParseObject +
com.parse.ParseInstallation +
public class ParseInstallation
+
+Constructor Summary | +|
---|---|
ParseInstallation()
+
++ |
+
+Method Summary | +|
---|---|
+static ParseInstallation |
+getCurrentInstallation()
+
++ |
+
+ String |
+getInstallationId()
+
++ Returns the unique ID of this installation. |
+
+static ParseQuery<ParseInstallation> |
+getQuery()
+
++ Constructs a query for ParseInstallations. |
+
+ void |
+put(String key,
+ Object value)
+
++ Add a key-value pair to this object. |
+
+ void |
+remove(String key)
+
++ Removes a key from this object's data if it exists. |
+
+ void |
+saveEventually(SaveCallback callback)
+
++ Saves this object to the server at some unspecified time in the future, even if Parse is + currently inaccessible. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public ParseInstallation()+
+Method Detail | +
---|
+public static ParseInstallation getCurrentInstallation()+
+public static ParseQuery<ParseInstallation> getQuery()+
+
+public String getInstallationId()+
+
+public void put(String key, + Object value) + throws IllegalArgumentException+
ParseObject
+
put
in class ParseObject
key
- Keys must be alphanumerical plus underscore, and start with a letter.value
- Values may be numerical, String, JSONObject, JSONArray, JSONObject.NULL, or other
+ ParseObjects. value may not be null
.
+IllegalArgumentException
+public void remove(String key)+
ParseObject
+
remove
in class ParseObject
key
- The key to remove.+public void saveEventually(SaveCallback callback)+
ParseObject
+
saveEventually
in class ParseObject
callback
- - A callback which will be called if the save completes before the app exits.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.ParseObject +
public class ParseObject
+The ParseObject is a local representation of data that can be saved and retrieved from the Parse + cloud. +
+ The basic workflow for creating new data is to construct a new ParseObject, use put() to fill it + with data, and then use save() to persist to the database. +
+ The basic workflow for accessing existing data is to use a ParseQuery
to specify which
+ existing data to retrieve.
+
+ +
+
+Constructor Summary | +|
---|---|
+protected |
+ParseObject()
+
++ The base class constructor to call in subclasses. |
+
+ |
+ParseObject(String theClassName)
+
++ Constructs a new ParseObject with no data in it. |
+
+Method Summary | +||
---|---|---|
+ void |
+add(String key,
+ Object value)
+
++ Atomically adds an object to the end of the array associated with a given key. |
+|
+ void |
+addAll(String key,
+ Collection<?> values)
+
++ Atomically adds the objects contained in a Collection to the end of the array
+ associated with a given key. |
+|
+ void |
+addAllUnique(String key,
+ Collection<?> values)
+
++ Atomically adds the objects contained in a Collection to the array associated with a
+ given key, only adding elements which are not already present in the array. |
+|
+ void |
+addUnique(String key,
+ Object value)
+
++ Atomically adds an object to the array associated with a given key, only if it is not already + present in the array. |
+|
+ boolean |
+containsKey(String key)
+
++ Whether this object has a particular key. |
+|
+static
+ |
+create(Class<T> subclass)
+
++ Creates a new ParseObject based upon a subclass type. |
+|
+static ParseObject |
+create(String className)
+
++ Creates a new ParseObject based upon a class name. |
+|
+static
+ |
+createWithoutData(Class<T> subclass,
+ String objectId)
+
++ Creates a reference to an existing ParseObject for use in creating associations between + ParseObjects. |
+|
+static ParseObject |
+createWithoutData(String className,
+ String objectId)
+
++ Creates a reference to an existing ParseObject for use in creating associations between + ParseObjects. |
+|
+ void |
+delete()
+
++ Deletes this object on the server. |
+|
+static void |
+deleteAll(List<ParseObject> objects)
+
++ Deletes each object in the provided list. |
+|
+static void |
+deleteAllInBackground(List<ParseObject> objects,
+ DeleteCallback callback)
+
++ Deletes each object in the provided list. |
+|
+ void |
+deleteEventually()
+
++ Deletes this object from the server at some unspecified time in the future, even if Parse is + currently inaccessible. |
+|
+ void |
+deleteEventually(DeleteCallback callback)
+
++ Deletes this object from the server at some unspecified time in the future, even if Parse is + currently inaccessible. |
+|
+ void |
+deleteInBackground()
+
++ Deletes this object on the server in a background thread. |
+|
+ void |
+deleteInBackground(DeleteCallback callback)
+
++ Deletes this object on the server in a background thread. |
+|
+
+ |
+fetch()
+
++ Fetches this object with the data from the server. |
+|
+static List<ParseObject> |
+fetchAll(List<ParseObject> objects)
+
++ Fetches all the objects in the provided list. |
+|
+static
+ |
+fetchAllIfNeeded(List<T> objects)
+
++ Fetches all the objects that don't have data in the provided list. |
+|
+static
+ |
+fetchAllIfNeededInBackground(List<T> objects,
+ FindCallback<T> callback)
+
++ Fetches all the objects that don't have data in the provided list in the background |
+|
+static
+ |
+fetchAllInBackground(List<T> objects,
+ FindCallback<T> callback)
+
++ Fetches all the objects in the provided list in the background |
+|
+
+ |
+fetchIfNeeded()
+
++ If this ParseObject has not been fetched (i.e. |
+|
+
+ |
+fetchIfNeededInBackground(GetCallback<T> callback)
+
++ If this ParseObject has not been fetched (i.e. |
+|
+
+ |
+fetchInBackground(GetCallback<T> callback)
+
++ Fetches this object with the data from the server in a background thread. |
+|
+ Object |
+get(String key)
+
++ Access a value. |
+|
+ ParseACL |
+getACL()
+
++ Access the ParseACL governing this object. |
+|
+ boolean |
+getBoolean(String key)
+
++ Access a boolean value. |
+|
+ byte[] |
+getBytes(String key)
+
++ Access a byte array value. |
+|
+ String |
+getClassName()
+
++ Accessor to the class name. |
+|
+ Date |
+getCreatedAt()
+
++ This reports time as the server sees it, so that if you create a ParseObject, then wait a + while, and then call save(), the creation time will be the time of the first save() call rather + than the time the object was created locally. |
+|
+ Date |
+getDate(String key)
+
++ Access a Date value. |
+|
+ double |
+getDouble(String key)
+
++ Access a double value. |
+|
+ int |
+getInt(String key)
+
++ Access an int value. |
+|
+ JSONArray |
+getJSONArray(String key)
+
++ Access a JSONArray value. |
+|
+ JSONObject |
+getJSONObject(String key)
+
++ Access a JSONObject value. |
+|
+
+ |
+getList(String key)
+
++ Access a List |
+|
+ long |
+getLong(String key)
+
++ Access a long value. |
+|
+
+ |
+getMap(String key)
+
++ Access a Map |
+|
+ Number |
+getNumber(String key)
+
++ Access a numerical value. |
+|
+ String |
+getObjectId()
+
++ Accessor to the object id. |
+|
+ ParseFile |
+getParseFile(String key)
+
++ Access a ParseFile value. |
+|
+ ParseGeoPoint |
+getParseGeoPoint(String key)
+
++ Access a ParseGeoPoint value. |
+|
+ ParseObject |
+getParseObject(String key)
+
++ Access a ParseObject value. |
+|
+ ParseUser |
+getParseUser(String key)
+
++ Access a ParseUser value. |
+|
+
+ |
+getRelation(String key)
+
++ Access or create a Relation value for a key |
+|
+ String |
+getString(String key)
+
++ Access a string value. |
+|
+ Date |
+getUpdatedAt()
+
++ This reports time as the server sees it, so that if you make changes to a ParseObject, then + wait a while, and then call save(), the updated time will be the time of the save() call rather + than the time the object was changed locally. |
+|
+ boolean |
+has(String key)
+
++ Whether this object has a particular key. |
+|
+ boolean |
+hasSameId(ParseObject other)
+
++ |
+|
+ void |
+increment(String key)
+
++ Atomically increments the given key by 1. |
+|
+ void |
+increment(String key,
+ Number amount)
+
++ Atomically increments the given key by the given number. |
+|
+ boolean |
+isDataAvailable()
+
++ Gets whether the ParseObject has been fetched. |
+|
+ boolean |
+isDirty()
+
++ Whether any key-value pair in this object (or its children) has been added/updated/removed + and not saved yet. |
+|
+ boolean |
+isDirty(String key)
+
++ Whether a value associated with a key has been added/updated/removed and not saved yet. |
+|
+ Set<String> |
+keySet()
+
++ Returns a set view of the keys contained in this object. |
+|
+ void |
+put(String key,
+ Object value)
+
++ Add a key-value pair to this object. |
+|
+ void |
+refresh()
+
++ Refreshes this object with the data from the server. |
+|
+ void |
+refreshInBackground(RefreshCallback callback)
+
++ Refreshes this object with the data from the server in a background thread. |
+|
+static void |
+registerSubclass(Class<? extends ParseObject> subclass)
+
++ Registers a custom subclass type with the Parse SDK, enabling strong-typing of those + ParseObjects whenever they appear. |
+|
+ void |
+remove(String key)
+
++ Removes a key from this object's data if it exists. |
+|
+ void |
+removeAll(String key,
+ Collection<?> values)
+
++ Atomically removes all instances of the objects contained in a Collection from the
+ array associated with a given key. |
+|
+ void |
+save()
+
++ Saves this object to the server. |
+|
+static void |
+saveAll(List<ParseObject> objects)
+
++ Saves each object in the provided list. |
+|
+static void |
+saveAllInBackground(List<ParseObject> objects)
+
++ Saves each object to the server in a background thread. |
+|
+static void |
+saveAllInBackground(List<ParseObject> objects,
+ SaveCallback callback)
+
++ Saves each object in the provided list to the server in a background thread. |
+|
+ void |
+saveEventually()
+
++ Saves this object to the server at some unspecified time in the future, even if Parse is + currently inaccessible. |
+|
+ void |
+saveEventually(SaveCallback callback)
+
++ Saves this object to the server at some unspecified time in the future, even if Parse is + currently inaccessible. |
+|
+ void |
+saveInBackground()
+
++ Saves this object to the server in a background thread. |
+|
+ void |
+saveInBackground(SaveCallback callback)
+
++ Saves this object to the server in a background thread. |
+|
+ void |
+setACL(ParseACL acl)
+
++ Set the ParseACL governing this object. |
+|
+ void |
+setObjectId(String newObjectId)
+
++ Setter for the object id. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+protected ParseObject()+
ParseClassName
annotation on the subclass.
++
+public ParseObject(String theClassName)+
+ Class names must be alphanumerical plus underscore, and start with a letter. It is recommended + to name classes in CamelCaseLikeThis. +
+
theClassName
- The className for this ParseObject.+Method Detail | +
---|
+public static ParseObject create(String className)+
+
className
- The class of object to create.
++public static <T extends ParseObject> T create(Class<T> subclass)+
ParseClassName
of the given subclass type. For example, calling
+ create(ParseUser.class) may create an instance of a custom subclass of ParseUser.
++
subclass
- The class of object to create.
++public static ParseObject createWithoutData(String className, + String objectId)+
ParseObject.isDataAvailable()
on this object will return false
until
+ ParseObject.fetchIfNeeded()
or ParseObject.refresh()
has been called. No network request will be
+ made.
++
className
- The object's class.objectId
- The object id for the referenced object.
++public static <T extends ParseObject> T createWithoutData(Class<T> subclass, + String objectId)+
ParseObject.isDataAvailable()
on this object will return false
until
+ ParseObject.fetchIfNeeded()
or ParseObject.refresh()
has been called. No network request will be
+ made.
++
subclass
- The ParseObject subclass to create.objectId
- The object id for the referenced object.
++public static void registerSubclass(Class<? extends ParseObject> subclass)+
ParseClassName
+ annotation and have a default constructor.
++
subclass
- The subclass type to register.+public String getClassName()+
+
+public Set<String> keySet()+
+
+public Date getUpdatedAt()+
+
+public Date getCreatedAt()+
+
+public boolean isDirty()+
+
+public boolean isDirty(String key)+
+
key
- The key to check for
++public String getObjectId()+
+
+public void setObjectId(String newObjectId)+
+
+public final void save() + throws ParseException+
ParseObject.saveInBackground(com.parse.SaveCallback)
instead of
+ this, unless you are managing your own threading.
++
ParseException
- Throws an exception if the server is inaccessible.+public final void saveInBackground(SaveCallback callback)+
+
callback
- callback.done(e) is called when the save completes.+public final void saveInBackground()+
+
+public final void saveEventually()+
+
+public void saveEventually(SaveCallback callback)+
+
callback
- - A callback which will be called if the save completes before the app exits.+public final void deleteEventually()+
+
+public final void deleteEventually(DeleteCallback callback)+
+
callback
- - A callback which will be called if the delete completes before the app exits.+public final void refresh() + throws ParseException+
+
ParseException
- Throws an exception if the server is inaccessible.+public final void refreshInBackground(RefreshCallback callback)+
+
callback
- callback.done(object, e) is called when the refresh completes.+public <T extends ParseObject> T fetch() + throws ParseException+
+
ParseException
- Throws an exception if the server is inaccessible.+public final <T extends ParseObject> void fetchInBackground(GetCallback<T> callback)+
+
callback
- callback.done(object, e) is called when the fetch completes.+public <T extends ParseObject> T fetchIfNeeded() + throws ParseException+
ParseObject.isDataAvailable()
returns false),
+ fetches this object with the data from the server.
++
ParseException
- Throws an exception if the server is inaccessible.+public final <T extends ParseObject> void fetchIfNeededInBackground(GetCallback<T> callback)+
ParseObject.isDataAvailable()
returns false),
+ fetches this object with the data from the server in a background thread. This is preferable to
+ using ParseObject.fetchIfNeeded()
, unless your code is already running from a background thread.
++
callback
- callback.done(object, e) is called when the fetch completes.+public final void delete() + throws ParseException+
+
ParseException
- Throws an error if the object does not exist or if the internet fails.+public final void deleteInBackground(DeleteCallback callback)+
+
callback
- callback.done(e) is called when the save completes.+public final void deleteInBackground()+
+
+public static void deleteAll(List<ParseObject> objects) + throws ParseException+
+
objects
- The objects to delete.
+ParseException
- Throws an exception if the server returns an error or is inaccessible.+public static void deleteAllInBackground(List<ParseObject> objects, + DeleteCallback callback)+
+
objects
- The objects to delete.callback
- The callback method to execute when completed.
+ParseException
- Throws an exception if the server returns an error or is inaccessible.+public static void saveAll(List<ParseObject> objects) + throws ParseException+
+
objects
- The objects to save.
+ParseException
- Throws an exception if the server returns an error or is inaccessible.+public static <T extends ParseObject> List<T> fetchAllIfNeeded(List<T> objects) + throws ParseException+
+
objects
- The list of objects to fetch.
+ParseException
- Throws an exception if the server returns an error or is inaccessible.+public static <T extends ParseObject> void fetchAllIfNeededInBackground(List<T> objects, + FindCallback<T> callback)+
+
objects
- The list of objects to fetch.callback
- callback.done(result, e) is called when the fetch completes.+public static List<ParseObject> fetchAll(List<ParseObject> objects) + throws ParseException+
+
objects
- The list of objects to fetch.
+ParseException
- Throws an exception if the server returns an error or is inaccessible.+public static <T extends ParseObject> void fetchAllInBackground(List<T> objects, + FindCallback<T> callback)+
+
objects
- The list of objects to fetch.callback
- callback.done(result, e) is called when the fetch completes.+public static void saveAllInBackground(List<ParseObject> objects, + SaveCallback callback)+
+
objects
- The objects to save.callback
- callback.done(e) is called when the save completes.+public static void saveAllInBackground(List<ParseObject> objects)+
+
objects
- The objects to save.+public void remove(String key)+
+
key
- The key to remove.+public boolean has(String key)+
+
key
- The key to check for
++public void put(String key, + Object value)+
+
key
- Keys must be alphanumerical plus underscore, and start with a letter.value
- Values may be numerical, String, JSONObject, JSONArray, JSONObject.NULL, or other
+ ParseObjects. value may not be null
.+public void increment(String key)+
+
key
- The key to increment.+public void increment(String key, + Number amount)+
+
key
- The key to increment.amount
- The amount to increment by.+public void add(String key, + Object value)+
+
key
- The key.value
- The object to add.+public void addAll(String key, + Collection<?> values)+
Collection
to the end of the array
+ associated with a given key.
++
key
- The key.values
- The objects to add.+public void addUnique(String key, + Object value)+
+
key
- The key.value
- The object to add.+public void addAllUnique(String key, + Collection<?> values)+
Collection
to the array associated with a
+ given key, only adding elements which are not already present in the array. The position of the
+ insert is not guaranteed.
++
key
- The key.values
- The objects to add.+public void removeAll(String key, + Collection<?> values)+
Collection
from the
+ array associated with a given key. To maintain consistency with the Java Collection API, there
+ is no method removing all instances of a single object. Instead, you can call
+ parseObject.removeAll(key, Arrays.asList(value))
.
++
key
- The key.values
- The objects to remove.+public boolean containsKey(String key)+
+
key
- The key to check for
++public String getString(String key)+
+
key
- The key to access the value for.
++public byte[] getBytes(String key)+
+
key
- The key to access the value for.
++public Number getNumber(String key)+
+
key
- The key to access the value for.
++public JSONArray getJSONArray(String key)+
+
key
- The key to access the value for.
++public <T> List<T> getList(String key)+
+
key
- The key to access the value for
++public <V> Map<String,V> getMap(String key)+
+
key
- The key to access the value for
++public JSONObject getJSONObject(String key)+
+
key
- The key to access the value for.
++public int getInt(String key)+
+
key
- The key to access the value for.
++public double getDouble(String key)+
+
key
- The key to access the value for.
++public long getLong(String key)+
+
key
- The key to access the value for.
++public boolean getBoolean(String key)+
+
key
- The key to access the value for.
++public Date getDate(String key)+
+
key
- The key to access the value for.
++public ParseObject getParseObject(String key)+
ParseQuery.include(String)
or by calling
+ ParseObject.fetchIfNeeded()
or ParseObject.refresh()
), ParseObject.isDataAvailable()
will return false.
++
key
- The key to access the value for.
++public ParseUser getParseUser(String key)+
ParseQuery.include(String)
or by calling
+ ParseObject.fetchIfNeeded()
or ParseObject.refresh()
), ParseObject.isDataAvailable()
will return false.
++
key
- The key to access the value for.
++public ParseFile getParseFile(String key)+
ParseFile.getData()
),
+ ParseFile.isDataAvailable()
will return false.
++
key
- The key to access the value for.
++public ParseGeoPoint getParseGeoPoint(String key)+
+
key
- The key to access the value for
++public ParseACL getACL()+
+
+public void setACL(ParseACL acl)+
+
+public boolean isDataAvailable()+
+
true
if the ParseObject is new or has been fetched or refreshed. false
+ otherwise.+public <T extends ParseObject> ParseRelation<T> getRelation(String key)+
+
key
- The key to access the relation for.
++public Object get(String key)+
+
key
- The key to access the value for.
+Throws
- a ParseException if the server could not be reached to load a relational value.+public boolean hasSameId(ParseObject other)+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.ParsePush +
public class ParsePush
+The ParsePush is a local representation of data that can be sent as a push notification. +
+ The typical workflow for sending a push notification from the client is to construct a new
+ ParsePush, use the setter functions to fill it with data, and then use
+ ParsePush.sendInBackground()
to send it.
+
+ +
+
+Constructor Summary | +|
---|---|
ParsePush()
+
++ Creates a new push notification. |
+
+Method Summary | +|
---|---|
+ void |
+clearExpiration()
+
++ Clears both expiration values, indicating that the notification should never expire. |
+
+ void |
+send()
+
++ Sends this push notification while blocking this thread until the push notification has + successfully reached the Parse servers. |
+
+static void |
+sendDataInBackground(JSONObject data,
+ ParseQuery<ParseInstallation> query)
+
++ A helper method to concisely send a push to a query. |
+
+static void |
+sendDataInBackground(JSONObject data,
+ ParseQuery<ParseInstallation> query,
+ SendCallback callback)
+
++ A helper method to concisely send a push to a query. |
+
+ void |
+sendInBackground()
+
++ Sends this push notification in a background thread. |
+
+ void |
+sendInBackground(SendCallback callback)
+
++ Sends this push notification in a background thread. |
+
+static void |
+sendMessageInBackground(String message,
+ ParseQuery<ParseInstallation> query)
+
++ A helper method to concisely send a push message to a query. |
+
+static void |
+sendMessageInBackground(String message,
+ ParseQuery<ParseInstallation> query,
+ SendCallback callback)
+
++ A helper method to concisely send a push message to a query. |
+
+ void |
+setChannel(String channel)
+
++ Sets the channel on which this push notification will be sent. |
+
+ void |
+setChannels(Collection<String> channels)
+
++ Sets the collection of channels on which this push notification will be sent. |
+
+ void |
+setData(JSONObject data)
+
++ Sets the entire data of the push message. |
+
+ void |
+setExpirationTime(long time)
+
++ Sets a UNIX epoch timestamp at which this notification should expire, in seconds (UTC). |
+
+ void |
+setExpirationTimeInterval(long timeInterval)
+
++ Sets the time interval after which this notification should expire, in seconds. |
+
+ void |
+setMessage(String message)
+
++ Sets the message that will be shown in the notification. |
+
+ void |
+setPushToAndroid(boolean pushToAndroid)
+
++ Deprecated. |
+
+ void |
+setPushToIOS(boolean pushToIOS)
+
++ Deprecated. |
+
+ void |
+setQuery(ParseQuery<ParseInstallation> query)
+
++ Sets the query for this push for which this push notification will be sent. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public ParsePush()+
ParsePush.setChannel(String)
,
+ ParsePush.setChannels(Collection)
or ParsePush.setQuery(ParseQuery)
. Before sending the push
+ notification you must call either ParsePush.setMessage(String)
or ParsePush.setData(JSONObject)
.
++
+Method Detail | +
---|
+public static void sendMessageInBackground(String message, + ParseQuery<ParseInstallation> query)+
+
message
- The message that will be shown in the notification.query
- A ParseInstallation query which specifies the recipients of a push.+public static void sendMessageInBackground(String message, + ParseQuery<ParseInstallation> query, + SendCallback callback)+
+
message
- The message that will be shown in the notification.query
- A ParseInstallation query which specifies the recipients of a push.callback
- callback.done(e) is called when the send completes.+public static void sendDataInBackground(JSONObject data, + ParseQuery<ParseInstallation> query)+
+
data
- The entire data of the push message. See the push guide for more details on the data
+ format.query
- A ParseInstallation query which specifies the recipients of a push.+public static void sendDataInBackground(JSONObject data, + ParseQuery<ParseInstallation> query, + SendCallback callback)+
+
data
- The entire data of the push message. See the push guide for more details on the data
+ format.query
- A ParseInstallation query which specifies the recipients of a push.callback
- callback.done(e) is called when the send completes.+public void setChannel(String channel)+
+
+public void setChannels(Collection<String> channels)+
+
+public void setQuery(ParseQuery<ParseInstallation> query)+
+
query
- A query to which this push should target. This must be a ParseInstallation query.+public void setExpirationTime(long time)+
ParsePush.setExpirationTimeInterval(long)
.
++
+public void setExpirationTimeInterval(long timeInterval)+
+
+public void clearExpiration()+
+
+@Deprecated +public void setPushToIOS(boolean pushToIOS)+
+
+@Deprecated +public void setPushToAndroid(boolean pushToAndroid)+
+
+public void setData(JSONObject data)+
ParsePush.setMessage(String)
.
++
+public void setMessage(String message)+
ParsePush.setData(JSONObject)
.
++
+public void send() + throws ParseException+
ParsePush.sendInBackground()
+ instead of this, unless you are managing your own threading.
++
ParseException
- Throws an exception if the server is inaccessible.+public void sendInBackground(SendCallback callback)+
send()
, unless your code is already running from a background thread.
++
callback
- callback.done(e) is called when the send completes.+public void sendInBackground()+
+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | ++DETAIL: ENUM CONSTANTS | FIELD | METHOD | +
+Object ++Enum<ParseQuery.CachePolicy> +
com.parse.ParseQuery.CachePolicy +
public static enum ParseQuery.CachePolicy
+
+Enum Constant Summary | +|
---|---|
CACHE_ELSE_NETWORK
+
++ |
+|
CACHE_ONLY
+
++ |
+|
CACHE_THEN_NETWORK
+
++ |
+|
IGNORE_CACHE
+
++ |
+|
NETWORK_ELSE_CACHE
+
++ |
+|
NETWORK_ONLY
+
++ |
+
+Method Summary | +|
---|---|
+static ParseQuery.CachePolicy |
+valueOf(String name)
+
++ Returns the enum constant of this type with the specified name. |
+
+static ParseQuery.CachePolicy[] |
+values()
+
++ Returns an array containing the constants of this enum type, in +the order they are declared. |
+
Methods inherited from class Enum | +
---|
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
+
Methods inherited from class Object | +
---|
getClass, notify, notifyAll, wait, wait, wait |
+
+Enum Constant Detail | +
---|
+public static final ParseQuery.CachePolicy IGNORE_CACHE+
+public static final ParseQuery.CachePolicy CACHE_ONLY+
+public static final ParseQuery.CachePolicy NETWORK_ONLY+
+public static final ParseQuery.CachePolicy CACHE_ELSE_NETWORK+
+public static final ParseQuery.CachePolicy NETWORK_ELSE_CACHE+
+public static final ParseQuery.CachePolicy CACHE_THEN_NETWORK+
+Method Detail | +
---|
+public static ParseQuery.CachePolicy[] values()+
+for (ParseQuery.CachePolicy c : ParseQuery.CachePolicy.values()) + System.out.println(c); ++
+
+public static ParseQuery.CachePolicy valueOf(String name)+
+
name
- the name of the enum constant to be returned.
+IllegalArgumentException
- if this enum type has no constant
+with the specified name
+NullPointerException
- if the argument is null
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | ++DETAIL: ENUM CONSTANTS | FIELD | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.ParseQuery<T> +
public class ParseQuery<T extends ParseObject>
+The ParseQuery class defines a query that is used to fetch ParseObjects. The most common use case
+ is finding all objects that match a query through the findInBackground
+ method, using a FindCallback
. For example, this sample code fetches all objects of class
+ "MyClass"
. It calls a different function depending on whether the fetch succeeded or
+ not.
+
+
+ ParseQuery<ParseObject> query = ParseQuery.getQuery("MyClass"); + query.findInBackground(new FindCallback<ParseObject>() { + public void done(List<ParseObject> objects, ParseException e) { + if (e == null) { + objectsWereRetrievedSuccessfully(objects); + } else { + objectRetrievalFailed(); + } + } + } ++ + A ParseQuery can also be used to retrieve a single object whose id is known, through the +
getInBackground
method, using a GetCallback
. For example, this
+ sample code fetches an object of class "MyClass"
and id myId
. It calls
+ a different function depending on whether the fetch succeeded or not.
+
+ + ParseQuery<ParseObject> query = ParseQuery.getQuery("MyClass"); + query.getInBackground(myId, new GetCallback<ParseObject>() { + public void done(ParseObject object, ParseException e) { + if (e == null) { + objectWasRetrievedSuccessfully(object); + } else { + objectRetrievalFailed(); + } + } + } ++ + A ParseQuery can also be used to count the number of objects that match the query without + retrieving all of those objects. For example, this sample code counts the number of objects of + the class
"MyClass"
.
+
+ + ParseQuery<ParseObject> query = ParseQuery.getQuery("MyClass"); + query.countInBackground(new CountCallback() { + public void done(int count, ParseException e) { + if (e == null) { + objectsWereCounted(count); + } else { + objectCountFailed(); + } + } + } ++ + 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
find
,
+ get
or count
calls, 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.
++ +
+
+Nested Class Summary | +|
---|---|
+static class |
+ParseQuery.CachePolicy
+
++ |
+
+Constructor Summary | +|
---|---|
ParseQuery(Class<T> subclass)
+
++ Constructs a query for a ParseObject subclass type. |
+|
ParseQuery(String theClassName)
+
++ Constructs a query. |
+
+Method Summary | +||
---|---|---|
+ ParseQuery<T> |
+addAscendingOrder(String key)
+
++ Also sorts the results in ascending order by the given key. |
+|
+ ParseQuery<T> |
+addDescendingOrder(String key)
+
++ Also sorts the results in descending order by the given key. |
+|
+ void |
+cancel()
+
++ Cancels the current network request (if one is running). |
+|
+static void |
+clearAllCachedResults()
+
++ Clears the cached result for all queries. |
+|
+ void |
+clearCachedResult()
+
++ Removes the previously cached result for this query, forcing the next find() to hit the + network. |
+|
+ int |
+count()
+
++ Counts the number of objects that match this query. |
+|
+ void |
+countInBackground(CountCallback callback)
+
++ Counts the number of objects that match this query in a background thread. |
+|
+ List<T> |
+find()
+
++ Retrieves a list of ParseObjects that satisfy this query. |
+|
+ void |
+findInBackground(FindCallback<T> callback)
+
++ Retrieves a list of ParseObjects that satisfy this query from the server in a background + thread. |
+|
+ T |
+get(String objectId)
+
++ Constructs a ParseObject whose id is already known by fetching data from the server. |
+|
+ ParseQuery.CachePolicy |
+getCachePolicy()
+
++ Accessor for the caching policy. |
+|
+ String |
+getClassName()
+
++ Accessor for the class name. |
+|
+ T |
+getFirst()
+
++ Retrieves at most one ParseObject that satisfies this query. |
+|
+ void |
+getFirstInBackground(GetCallback<T> callback)
+
++ Retrieves at most one ParseObject that satisfies this query from the server in a background + thread. |
+|
+ void |
+getInBackground(String objectId,
+ GetCallback<T> callback)
+
++ Constructs a ParseObject whose id is already known by fetching data from the server in a + background thread. |
+|
+ int |
+getLimit()
+
++ Accessor for the limit. |
+|
+ long |
+getMaxCacheAge()
+
++ Gets the maximum age of cached data that will be considered in this query. |
+|
+static
+ |
+getQuery(Class<T> subclass)
+
++ Creates a new query for the given ParseObject subclass type. |
+|
+static
+ |
+getQuery(String className)
+
++ Creates a new query for the given class name. |
+|
+ int |
+getSkip()
+
++ Accessor for the skip value. |
+|
+static ParseQuery<ParseUser> |
+getUserQuery()
+
++ Deprecated. Please use ParseUser.getQuery() instead. |
+|
+ boolean |
+hasCachedResult()
+
++ Returns whether or not this query has a cached result. |
+|
+ void |
+include(String key)
+
++ Include nested ParseObjects for the provided key. |
+|
+static
+ |
+or(List<ParseQuery<T>> queries)
+
++ Constructs a query that is the or of the given queries. |
+|
+ ParseQuery<T> |
+orderByAscending(String key)
+
++ Sorts the results in ascending order by the given key. |
+|
+ ParseQuery<T> |
+orderByDescending(String key)
+
++ Sorts the results in descending order by the given key. |
+|
+ void |
+selectKeys(Collection<String> keys)
+
++ Restrict the fields of returned ParseObjects to only include the provided keys. |
+|
+ void |
+setCachePolicy(ParseQuery.CachePolicy newCachePolicy)
+
++ Change the caching policy of this query. |
+|
+ void |
+setLimit(int newLimit)
+
++ Controls the maximum number of results that are returned. |
+|
+ void |
+setMaxCacheAge(long maxAgeInMilliseconds)
+
++ Sets the maximum age of cached data that will be considered in this query. |
+|
+ void |
+setSkip(int newSkip)
+
++ Controls the number of results to skip before returning any results. |
+|
+ void |
+setTrace(boolean shouldTrace)
+
++ Turn on performance tracing of finds. |
+|
+ ParseQuery<T> |
+whereContainedIn(String key,
+ Collection<? extends Object> values)
+
++ Add a constraint to the query that requires a particular key's value to be contained in the + provided list of values. |
+|
+ ParseQuery<T> |
+whereContains(String key,
+ String substring)
+
++ Add a constraint for finding string values that contain a provided string. |
+|
+ ParseQuery<T> |
+whereContainsAll(String key,
+ Collection<?> values)
+
++ Add a constraint to the query that requires a particular key's value match another ParseQuery. |
+|
+ ParseQuery<T> |
+whereDoesNotExist(String key)
+
++ Add a constraint for finding objects that do not contain a given key. |
+|
+ ParseQuery<T> |
+whereDoesNotMatchKeyInQuery(String key,
+ String keyInQuery,
+ ParseQuery<?> query)
+
++ Add a constraint to the query that requires a particular key's value does not match any value + for a key in the results of another ParseQuery. |
+|
+ ParseQuery<T> |
+whereDoesNotMatchQuery(String key,
+ ParseQuery<?> query)
+
++ Add a constraint to the query that requires a particular key's value does not match another + ParseQuery. |
+|
+ ParseQuery<T> |
+whereEndsWith(String key,
+ String suffix)
+
++ Add a constraint for finding string values that end with a provided string. |
+|
+ ParseQuery<T> |
+whereEqualTo(String key,
+ Object value)
+
++ Add a constraint to the query that requires a particular key's value to be equal to the + provided value. |
+|
+ ParseQuery<T> |
+whereExists(String key)
+
++ Add a constraint for finding objects that contain the given key. |
+|
+ ParseQuery<T> |
+whereGreaterThan(String key,
+ Object value)
+
++ Add a constraint to the query that requires a particular key's value to be greater than the + provided value. |
+|
+ ParseQuery<T> |
+whereGreaterThanOrEqualTo(String key,
+ Object value)
+
++ Add a constraint to the query that requires a particular key's value to be greater than or + equal to the provided value. |
+|
+ ParseQuery<T> |
+whereLessThan(String key,
+ Object value)
+
++ Add a constraint to the query that requires a particular key's value to be less than the + provided value. |
+|
+ ParseQuery<T> |
+whereLessThanOrEqualTo(String key,
+ Object value)
+
++ Add a constraint to the query that requires a particular key's value to be less than or equal + to the provided value. |
+|
+ ParseQuery<T> |
+whereMatches(String key,
+ String regex)
+
++ Add a regular expression constraint for finding string values that match the provided regular + expression. |
+|
+ ParseQuery<T> |
+whereMatches(String key,
+ String regex,
+ String modifiers)
+
++ Add a regular expression constraint for finding string values that match the provided regular + expression. |
+|
+ ParseQuery<T> |
+whereMatchesKeyInQuery(String key,
+ String keyInQuery,
+ ParseQuery<?> query)
+
++ Add a constraint to the query that requires a particular key's value matches a value for a key + in the results of another ParseQuery |
+|
+ ParseQuery<T> |
+whereMatchesQuery(String key,
+ ParseQuery<?> query)
+
++ Add a constraint to the query that requires a particular key's value match another ParseQuery. |
+|
+ ParseQuery<T> |
+whereNear(String key,
+ ParseGeoPoint point)
+
++ Add a proximity based constraint for finding objects with key point values near the point + given. |
+|
+ ParseQuery<T> |
+whereNotContainedIn(String key,
+ Collection<? extends Object> values)
+
++ Add a constraint to the query that requires a particular key's value not be contained in the + provided list of values. |
+|
+ ParseQuery<T> |
+whereNotEqualTo(String key,
+ Object value)
+
++ Add a constraint to the query that requires a particular key's value to be not equal to the + provided value. |
+|
+ ParseQuery<T> |
+whereStartsWith(String key,
+ String prefix)
+
++ Add a constraint for finding string values that start with a provided string. |
+|
+ ParseQuery<T> |
+whereWithinGeoBox(String key,
+ ParseGeoPoint southwest,
+ ParseGeoPoint northeast)
+
++ Add a constraint to the query that requires a particular key's coordinates be contained within + a given rectangular geographic bounding box. |
+|
+ ParseQuery<T> |
+whereWithinKilometers(String key,
+ ParseGeoPoint point,
+ double maxDistance)
+
++ Add a proximity based constraint for finding objects with key point values near the point given + and within the maximum distance given. |
+|
+ ParseQuery<T> |
+whereWithinMiles(String key,
+ ParseGeoPoint point,
+ double maxDistance)
+
++ Add a proximity based constraint for finding objects with key point values near the point given + and within the maximum distance given. |
+|
+ ParseQuery<T> |
+whereWithinRadians(String key,
+ ParseGeoPoint point,
+ double maxDistance)
+
++ Add a proximity based constraint for finding objects with key point values near the point given + and within the maximum distance given. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public ParseQuery(Class<T> subclass)+
+
subclass
- The ParseObject subclass type to retrieve.+public ParseQuery(String theClassName)+
+
theClassName
- The name of the class to retrieve ParseObjects for.+Method Detail | +
---|
+public static <T extends ParseObject> ParseQuery<T> or(List<ParseQuery<T>> queries)+
+
queries
- The list of ParseQuerys to 'or' together
++public static <T extends ParseObject> ParseQuery<T> getQuery(Class<T> subclass)+
+
subclass
- The ParseObject subclass type to retrieve.
++public static <T extends ParseObject> ParseQuery<T> getQuery(String className)+
+
className
- The name of the class to retrieve ParseObjects for.
++@Deprecated +public static ParseQuery<ParseUser> getUserQuery()+
ParseUser.getQuery()
instead.
++
+
+public void cancel()+
+
+public List<T> find() + throws ParseException+
+
ParseException
+public T getFirst() + throws ParseException+
+
ParseException
- Throws a ParseException if no object is found.+public void setCachePolicy(ParseQuery.CachePolicy newCachePolicy)+
+
+public ParseQuery.CachePolicy getCachePolicy()+
+
+public void setMaxCacheAge(long maxAgeInMilliseconds)+
+
+public long getMaxCacheAge()+
+
+public void findInBackground(FindCallback<T> callback)+
+
callback
- callback.done(objectList, e) is called when the find completes.+public void getFirstInBackground(GetCallback<T> callback)+
+
callback
- callback.done(object, e) is called when the find completes.+public int count() + throws ParseException+
+
ParseException
- Throws an exception when the network connection fails or when the query is invalid.+public void countInBackground(CountCallback callback)+
+
callback
- callback.done(count, e) will be called when the count completes.+public T get(String objectId) + throws ParseException+
+
objectId
- Object id of the ParseObject to fetch.
+ParseException
- Throws an exception when there is no such object or when the network connection
+ fails.+public boolean hasCachedResult()+
+
+public void clearCachedResult()+
+
+public static void clearAllCachedResults()+
+
+public void getInBackground(String objectId, + GetCallback<T> callback)+
+
objectId
- Object id of the ParseObject to fetch.callback
- callback.done(object, e) will be called when the fetch completes.+public ParseQuery<T> whereEqualTo(String key, + Object value)+
+
key
- The key to check.value
- The value that the ParseObject must contain.
++public ParseQuery<T> whereLessThan(String key, + Object value)+
+
key
- The key to check.value
- The value that provides an upper bound.
++public ParseQuery<T> whereNotEqualTo(String key, + Object value)+
+
key
- The key to check.value
- The value that must not be equalled.
++public ParseQuery<T> whereGreaterThan(String key, + Object value)+
+
key
- The key to check.value
- The value that provides an lower bound.
++public ParseQuery<T> whereLessThanOrEqualTo(String key, + Object value)+
+
key
- The key to check.value
- The value that provides an upper bound.
++public ParseQuery<T> whereGreaterThanOrEqualTo(String key, + Object value)+
+
key
- The key to check.value
- The value that provides an lower bound.
++public ParseQuery<T> whereContainedIn(String key, + Collection<? extends Object> values)+
+
key
- The key to check.values
- The values that will match.
++public ParseQuery<T> whereContainsAll(String key, + Collection<?> values)+
+
key
- The key to check. This key's value must be an array.values
- The values that will match.
++public ParseQuery<T> whereMatchesQuery(String key, + ParseQuery<?> query)+
+
key
- The key to check.query
- The query that the value should match
++public ParseQuery<T> whereDoesNotMatchQuery(String key, + ParseQuery<?> query)+
+
key
- The key to check.query
- The query that the value should not match
++public ParseQuery<T> whereMatchesKeyInQuery(String key, + String keyInQuery, + ParseQuery<?> query)+
+
key
- The key whose value is being checkedkeyInQuery
- The key in the objects from the sub query to look inquery
- The sub query to run
++public ParseQuery<T> whereDoesNotMatchKeyInQuery(String key, + String keyInQuery, + ParseQuery<?> query)+
+
key
- The key whose value is being checked and excludedkeyInQuery
- The key in the objects from the sub query to look inquery
- The sub query to run
++public ParseQuery<T> whereNotContainedIn(String key, + Collection<? extends Object> values)+
+
key
- The key to check.values
- The values that will not match.
++public ParseQuery<T> whereNear(String key, + ParseGeoPoint point)+
+
key
- The key that the ParseGeoPoint is stored in.point
- The reference ParseGeoPoint that is used.
++public ParseQuery<T> whereWithinMiles(String key, + ParseGeoPoint point, + double maxDistance)+
+
key
- The key that the ParseGeoPoint is stored in.point
- The reference ParseGeoPoint that is used.maxDistance
- Maximum distance (in miles) of results to return.
++public ParseQuery<T> whereWithinKilometers(String key, + ParseGeoPoint point, + double maxDistance)+
+
key
- The key that the ParseGeoPoint is stored in.point
- The reference ParseGeoPoint that is used.maxDistance
- Maximum distance (in kilometers) of results to return.
++public ParseQuery<T> whereWithinRadians(String key, + ParseGeoPoint point, + double maxDistance)+
+
key
- The key that the ParseGeoPoint is stored in.point
- The reference ParseGeoPoint that is used.maxDistance
- Maximum distance (in radians) of results to return.
++public ParseQuery<T> whereWithinGeoBox(String key, + ParseGeoPoint southwest, + ParseGeoPoint northeast)+
+
key
- The key to be constrained.southwest
- The lower-left inclusive corner of the box.northeast
- The upper-right inclusive corner of the box.
++public ParseQuery<T> whereMatches(String key, + String regex)+
+
key
- The key that the string to match is stored in.regex
- The regular expression pattern to match.
++public ParseQuery<T> whereMatches(String key, + String regex, + String modifiers)+
+
key
- The key that the string to match is stored in.regex
- The regular expression pattern to match.modifiers
- Any of the following supported PCRE modifiers:i
- Case insensitive searchm
- Search across multiple lines of input+public ParseQuery<T> whereContains(String key, + String substring)+
+
key
- The key that the string to match is stored in.substring
- The substring that the value must contain.
++public ParseQuery<T> whereStartsWith(String key, + String prefix)+
+
key
- The key that the string to match is stored in.prefix
- The substring that the value must start with.
++public ParseQuery<T> whereEndsWith(String key, + String suffix)+
+
key
- The key that the string to match is stored in.suffix
- The substring that the value must end with.
++public void include(String key)+
+
key
- The key that should be included.+public void selectKeys(Collection<String> keys)+
+
keys
- The set of keys to include in the result.+public ParseQuery<T> whereExists(String key)+
+
key
- The key that should exist.+public ParseQuery<T> whereDoesNotExist(String key)+
+
key
- The key that should not exist+public ParseQuery<T> orderByAscending(String key)+
+
key
- The key to order by.
++public ParseQuery<T> addAscendingOrder(String key)+
+
key
- The key to order by
++public ParseQuery<T> orderByDescending(String key)+
+
key
- The key to order by.
++public ParseQuery<T> addDescendingOrder(String key)+
+
key
- The key to order by
++public void setLimit(int newLimit)+
+
newLimit
- +public void setTrace(boolean shouldTrace)+
+
+public int getLimit()+
+
+public void setSkip(int newSkip)+
+
newSkip
- +public int getSkip()+
+
+public String getClassName()+
+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
public static interface ParseQueryAdapter.OnQueryLoadListener<T extends ParseObject>
+Implement with logic that is called before and after objects are fetched from Parse by the + adapter. +
+ +
+
+Method Summary | +|
---|---|
+ void |
+onLoaded(List<T> objects,
+ Exception e)
+
++ |
+
+ void |
+onLoading()
+
++ |
+
+Method Detail | +
---|
+void onLoading()+
+void onLoaded(List<T> objects, + Exception e)+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
public static interface ParseQueryAdapter.QueryFactory<T extends ParseObject>
+Implement to construct your own custom ParseQuery
for fetching objects.
+
+ +
+
+Method Summary | +|
---|---|
+ ParseQuery<T> |
+create()
+
++ |
+
+Method Detail | +
---|
+ParseQuery<T> create()+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++android.widget.BaseAdapter +
com.parse.ParseQueryAdapter<T> +
public class ParseQueryAdapter<T extends ParseObject>
+A ParseQueryAdapter handles the fetching of objects by page, and displaying objects as views in a + ListView. +
+ This class is highly configurable, but also intended to be easy to get started with. See below
+ for an example of using a ParseQueryAdapter inside an Activity's onCreate
:
+
+
+ final ParseQueryAdapter adapter = new ParseQueryAdapter(this, "TestObject"); + adapter.setTextKey("name"); + + ListView listView = (ListView) findViewById(R.id.listview); + listView.setAdapter(adapter); ++ + Below, an example showing off the level of configuration available with this class: + +
+ // Instantiate a QueryFactory to define the ParseQuery to be used for fetching items in this + // Adapter. + ParseQueryAdapter.QueryFactory<ParseObject> factory = + new ParseQueryAdapter.QueryFactory<ParseObject>() { + public ParseQuery create() { + ParseQuery query = new ParseQuery("Customer"); + query.whereEqualTo("activated", true); + query.orderByDescending("moneySpent"); + return query; + } + }; + + // Pass the factory into the ParseQueryAdapter's constructor. + ParseQueryAdapter<ParseObject> adapter = new ParseQueryAdapter<ParseObject>(this, factory); + adapter.setTextKey("name"); + + // Perhaps set a callback to be fired upon successful loading of a new set of ParseObjects. + adapter.addOnQueryLoadListener(new OnQueryLoadListener<ParseObject>() { + public void onLoading() { + // Trigger any "loading" UI + } + + public void onLoaded(List<ParseObject> objects, ParseException e) { + // Execute any post-loading logic, hide "loading" UI + } + }); + + // Attach it to your ListView, as in the example above + ListView listView = (ListView) findViewById(R.id.listview); + listView.setAdapter(adapter); ++
+ +
+
+Nested Class Summary | +|
---|---|
+static interface |
+ParseQueryAdapter.OnQueryLoadListener<T extends ParseObject>
+
++ Implement with logic that is called before and after objects are fetched from Parse by the + adapter. |
+
+static interface |
+ParseQueryAdapter.QueryFactory<T extends ParseObject>
+
++ Implement to construct your own custom ParseQuery for fetching objects. |
+
+Field Summary | +
---|
Fields inherited from interface android.widget.Adapter | +
---|
IGNORE_ITEM_VIEW_TYPE, NO_SELECTION |
+
+Constructor Summary | +|
---|---|
ParseQueryAdapter(Context context,
+ Class<? extends ParseObject> clazz)
+
++ Constructs a ParseQueryAdapter. |
+|
ParseQueryAdapter(Context context,
+ Class<? extends ParseObject> clazz,
+ int itemViewResource)
+
++ Constructs a ParseQueryAdapter. |
+|
ParseQueryAdapter(Context context,
+ ParseQueryAdapter.QueryFactory<T> queryFactory)
+
++ Constructs a ParseQueryAdapter. |
+|
ParseQueryAdapter(Context context,
+ ParseQueryAdapter.QueryFactory<T> queryFactory,
+ int itemViewResource)
+
++ Constructs a ParseQueryAdapter. |
+|
ParseQueryAdapter(Context context,
+ String className)
+
++ Constructs a ParseQueryAdapter. |
+|
ParseQueryAdapter(Context context,
+ String className,
+ int itemViewResource)
+
++ Constructs a ParseQueryAdapter. |
+
+Method Summary | +|
---|---|
+ void |
+addOnQueryLoadListener(ParseQueryAdapter.OnQueryLoadListener<T> listener)
+
++ |
+
+ void |
+clear()
+
++ Remove all elements from the list. |
+
+ Context |
+getContext()
+
++ Return the context provided by the Activity utilizing this ParseQueryAdapter . |
+
+ int |
+getCount()
+
++ Overrides Adapter 's ParseQueryAdapter.getCount() method to return the number of cells to
+ display. |
+
+ T |
+getItem(int index)
+
++ |
+
+ long |
+getItemId(int position)
+
++ |
+
+ View |
+getItemView(T object,
+ View v,
+ ViewGroup parent)
+
++ Override this method to customize each cell given a ParseObject . |
+
+ int |
+getItemViewType(int position)
+
++ |
+
+ View |
+getNextPageView(View v,
+ ViewGroup parent)
+
++ Override this method to customize the "Load Next Page" cell, visible when pagination is turned + on and there may be more results to display. |
+
+ int |
+getObjectsPerPage()
+
++ |
+
+ View |
+getView(int position,
+ View convertView,
+ ViewGroup parent)
+
++ The base class, Adapter , defines a getView method intended to display data at
+ the specified position in the data set. |
+
+ int |
+getViewTypeCount()
+
++ |
+
+ void |
+loadNextPage()
+
++ Loads the next page of objects, appends to table, and notifies the UI that the model has + changed. |
+
+ void |
+loadObjects()
+
++ Clears the table and loads the first page of objects asynchronously. |
+
+ void |
+registerDataSetObserver(DataSetObserver observer)
+
++ |
+
+ void |
+removeOnQueryLoadListener(ParseQueryAdapter.OnQueryLoadListener<T> listener)
+
++ |
+
+ void |
+setAutoload(boolean autoload)
+
++ Enable or disable the automatic loading of results upon attachment to an AdapterView . |
+
+ void |
+setImageKey(String imageKey)
+
++ |
+
+ void |
+setObjectsPerPage(int objectsPerPage)
+
++ |
+
+protected void |
+setPageOnQuery(int page,
+ ParseQuery<T> query)
+
++ Override this method to manually paginate the provided ParseQuery . |
+
+ void |
+setPaginationEnabled(boolean paginationEnabled)
+
++ Enable or disable pagination of results. |
+
+ void |
+setPlaceholder(Drawable placeholder)
+
++ Sets a placeholder image to be used when fetching data for each item in the AdapterView
+ . |
+
+ void |
+setTextKey(String textKey)
+
++ |
+
+ void |
+unregisterDataSetObserver(DataSetObserver observer)
+
++ |
+
Methods inherited from class android.widget.BaseAdapter | +
---|
areAllItemsEnabled, getDropDownView, hasStableIds, isEmpty, isEnabled, notifyDataSetChanged, notifyDataSetInvalidated |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public ParseQueryAdapter(Context context, + Class<? extends ParseObject> clazz)+
+
context
- The activity utilizing this adapter.clazz
- The ParseObject
subclass type to fetch and display.+public ParseQueryAdapter(Context context, + String className)+
+
context
- The activity utilizing this adapter.className
- The name of the Parse class of ParseObject
s to display.+public ParseQueryAdapter(Context context, + Class<? extends ParseObject> clazz, + int itemViewResource)+
+
context
- The activity utilizing this adapter.clazz
- The ParseObject
subclass type to fetch and display.itemViewResource
- A resource id that represents the layout for an item in the AdapterView.+public ParseQueryAdapter(Context context, + String className, + int itemViewResource)+
+
context
- The activity utilizing this adapter.className
- The name of the Parse class of ParseObject
s to display.itemViewResource
- A resource id that represents the layout for an item in the AdapterView.+public ParseQueryAdapter(Context context, + ParseQueryAdapter.QueryFactory<T> queryFactory)+
ParseQuery
to be used when fetching items from Parse.
++
context
- The activity utilizing this adapter.queryFactory
- A ParseQueryAdapter.QueryFactory
to build a ParseQuery
for fetching objects.+public ParseQueryAdapter(Context context, + ParseQueryAdapter.QueryFactory<T> queryFactory, + int itemViewResource)+
ParseQuery
to be used when fetching items from Parse.
++
context
- The activity utilizing this adapter.queryFactory
- A ParseQueryAdapter.QueryFactory
to build a ParseQuery
for fetching objects.itemViewResource
- A resource id that represents the layout for an item in the AdapterView.+Method Detail | +
---|
+public Context getContext()+
Activity
utilizing this ParseQueryAdapter
.
++
+public T getItem(int index)+
+
+public long getItemId(int position)+
+
+public int getItemViewType(int position)+
getItemViewType
in interface Adapter
getItemViewType
in class BaseAdapter
+public int getViewTypeCount()+
getViewTypeCount
in interface Adapter
getViewTypeCount
in class BaseAdapter
+public void registerDataSetObserver(DataSetObserver observer)+
registerDataSetObserver
in interface Adapter
registerDataSetObserver
in class BaseAdapter
+public void unregisterDataSetObserver(DataSetObserver observer)+
unregisterDataSetObserver
in interface Adapter
unregisterDataSetObserver
in class BaseAdapter
+public void clear()+
+
+public void loadObjects()+
Adapter
is attached to an AdapterView
.
+
+ loadObjects()
should only need to be called if ParseQueryAdapter.setAutoload(boolean)
is set to
+ false
.
++
+public void loadNextPage()+
+
+public int getCount()+
Adapter
's ParseQueryAdapter.getCount()
method to return the number of cells to
+ display. If pagination is turned on, this count will include an extra +1 count for the
+ pagination cell row.
++
+public View getItemView(T object, + View v, + ViewGroup parent)+
ParseObject
.
+
+ If a view is not provided, a default view will be created based upon
+ android.R.layout.activity_list_item
.
+
+ This method expects a TextView
with id android.R.id.text1
in your object views.
+ If ParseQueryAdapter.setImageKey(String)
was used, this method also expects an ImageView
with id
+ android.R.id.icon
.
+
+ This method displays the text value specified by the text key (set via
+ ParseQueryAdapter.setTextKey(String)
) and an image (described by a ParseFile
, under the key set
+ via ParseQueryAdapter.setImageKey(String)
) if applicable. If the text key is not set, the value for
+ ParseObject.getObjectId()
will be displayed instead.
++
object
- The ParseObject associated with this item.v
- The View
associated with this row. This view, if non-null, is being recycled
+ and intended to be used for displaying this item.parent
- The parent that this view will eventually be attached to
++public View getNextPageView(View v, + ViewGroup parent)+
TextView
with id android.R.id.text1
.
++
v
- The view object associated with this row + type (a "Next Page" view, instead of an
+ "Item" view).parent
- The parent that this view will eventually be attached to
++public final View getView(int position, + View convertView, + ViewGroup parent)+
Adapter
, defines a getView
method intended to display data at
+ the specified position in the data set. We override it here in order to toggle between
+ ParseQueryAdapter.getNextPageView(View, ViewGroup)
and
+ ParseQueryAdapter.getItemView(ParseObject, View, ViewGroup)
depending on the value of
+ ParseQueryAdapter.getItemViewType(int)
.
++
+protected void setPageOnQuery(int page, + ParseQuery<T> query)+
ParseQuery
. By default, this
+ method will set the limit
value to ParseQueryAdapter.getObjectsPerPage()
and the skip
+ value to ParseQueryAdapter.getObjectsPerPage()
* page
.
+ + Overriding this method will not be necessary, in most cases. +
+
page
- the page number of results to fetch from Parse.query
- the ParseQuery
used to fetch items from Parse. This query will be mutated and
+ used in its mutated form.+public void setTextKey(String textKey)+
+public void setImageKey(String imageKey)+
+public void setObjectsPerPage(int objectsPerPage)+
+public int getObjectsPerPage()+
+public void setPaginationEnabled(boolean paginationEnabled)+
+
paginationEnabled
- Defaults to true.+public void setPlaceholder(Drawable placeholder)+
AdapterView
+ . Will not be used if ParseQueryAdapter.setImageKey(String)
was not used to define which images to
+ display.
++
placeholder
- A Drawable
to be displayed while the remote image data is being fetched. This
+ value can be null, and ImageView
s in this AdapterView will simply be blank
+ while data is being fetched.+public void setAutoload(boolean autoload)+
AdapterView
.
+ Defaults to true.
++
autoload
- Defaults to true.+public void addOnQueryLoadListener(ParseQueryAdapter.OnQueryLoadListener<T> listener)+
+public void removeOnQueryLoadListener(ParseQueryAdapter.OnQueryLoadListener<T> listener)+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.ParseRelation<T> +
public class ParseRelation<T extends ParseObject>
+A class that is used to access all of the children of a many-to-many relationship. Each instance + of Parse.Relation is associated with a particular parent object and key. +
+ +
+
+Method Summary | +|
---|---|
+ void |
+add(T object)
+
++ Adds an object to this relation. |
+
+ ParseQuery<T> |
+getQuery()
+
++ Gets a query that can be used to query the objects in this relation. |
+
+ void |
+remove(T object)
+
++ Removes an object from this relation. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Method Detail | +
---|
+public void add(T object)+
+
object
- The object to add to this relation.+public void remove(T object)+
+
object
- The object to remove from this relation.+public ParseQuery<T> getQuery()+
+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.ParseObject +
com.parse.ParseRole +
public class ParseRole
+Represents a Role on the Parse server. ParseRole
s represent groupings of
+ ParseUsers
for the purposes of granting permissions (e.g. specifying a ParseACL
+ for a ParseObject
). Roles are specified by their sets of child users and child roles, all
+ of which are granted any permissions that the parent role has.
+
+ Roles must have a name (which cannot be changed after creation of the role), and must specify an
+ ACL.
+
+ +
+
+Constructor Summary | +|
---|---|
ParseRole(String name)
+
++ Constructs a new ParseRole with the given name. |
+|
ParseRole(String name,
+ ParseACL acl)
+
++ Constructs a new ParseRole with the given name. |
+
+Method Summary | +|
---|---|
+ String |
+getName()
+
++ Gets the name of the role. |
+
+static ParseQuery<ParseRole> |
+getQuery()
+
++ Gets a ParseQuery over the Role collection. |
+
+ ParseRelation<ParseRole> |
+getRoles()
+
++ Gets the ParseRelation for the ParseRole s that are direct children of this
+ role. |
+
+ ParseRelation<ParseUser> |
+getUsers()
+
++ Gets the ParseRelation for the ParseUser s that are direct children of this
+ role. |
+
+ void |
+put(String key,
+ Object value)
+
++ Add a key-value pair to this object. |
+
+ void |
+setName(String name)
+
++ Sets the name for a role. |
+
+protected void |
+validateSave()
+
++ |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public ParseRole(String name)+
+
name
- The name of the Role to create.+public ParseRole(String name, + ParseACL acl)+
+
name
- The name of the Role to create.acl
- The ACL for this role. Roles must have an ACL.+Method Detail | +
---|
+public void setName(String name)+
+
name
- The name of the role.
+IllegalStateException
- if the object has already been saved to the server.+public String getName()+
+
+public ParseRelation<ParseUser> getUsers()+
ParseRelation
for the ParseUser
s that are direct children of this
+ role. These users are granted any privileges that this role has been granted (e.g. read or
+ write access through ACLs). You can add or remove users from the role through this relation.
++
+public ParseRelation<ParseRole> getRoles()+
ParseRelation
for the ParseRole
s that are direct children of this
+ role. These roles' users are granted any privileges that this role has been granted (e.g. read
+ or write access through ACLs). You can add or remove child roles from this role through this
+ relation.
++
+protected void validateSave()+
+public void put(String key, + Object value)+
ParseObject
+
put
in class ParseObject
key
- Keys must be alphanumerical plus underscore, and start with a letter.value
- Values may be numerical, String, JSONObject, JSONArray, JSONObject.NULL, or other
+ ParseObjects. value may not be null
.+public static ParseQuery<ParseRole> getQuery()+
ParseQuery
over the Role collection.
++
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.ParseTwitterUtils +
public final class ParseTwitterUtils
+
+Method Summary | +|
---|---|
+static com.parse.twitter.Twitter |
+getTwitter()
+
++ Gets the shared Twitter singleton that Parse is using. |
+
+static void |
+initialize(String consumerKey,
+ String consumerSecret)
+
++ Initializes Twitter for use with Parse. |
+
+static boolean |
+isLinked(ParseUser user)
+
++ Returns true if the user is linked to a Twitter account. |
+
+static void |
+link(ParseUser user,
+ Context context)
+
++ |
+
+static void |
+link(ParseUser user,
+ Context context,
+ SaveCallback callback)
+
++ Links a ParseUser to a Twitter account, allowing you to use Twitter for authentication, and + providing access to Twitter data for the user. |
+
+static void |
+link(ParseUser user,
+ String twitterId,
+ String screenName,
+ String authToken,
+ String authTokenSecret)
+
++ |
+
+static void |
+link(ParseUser user,
+ String twitterId,
+ String screenName,
+ String authToken,
+ String authTokenSecret,
+ SaveCallback callback)
+
++ Links a ParseUser to a Twitter account, allowing you to use Twitter for authentication, and + providing access to Twitter data for the user. |
+
+static void |
+logIn(Context context,
+ LogInCallback callback)
+
++ Logs in a ParseUser using Twitter for authentication. |
+
+static void |
+logIn(String twitterId,
+ String screenName,
+ String authToken,
+ String authTokenSecret,
+ LogInCallback callback)
+
++ Logs in a ParseUser using Twitter for authentication. |
+
+static void |
+unlink(ParseUser user)
+
++ Unlinks a user from a Twitter account. |
+
+static void |
+unlinkInBackground(ParseUser user)
+
++ |
+
+static void |
+unlinkInBackground(ParseUser user,
+ SaveCallback callback)
+
++ Unlinks a user from a Twitter account in the background. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Method Detail | +
---|
+public static com.parse.twitter.Twitter getTwitter()+
Twitter
singleton that Parse is using.
++
+public static void initialize(String consumerKey, + String consumerSecret)+
ParseTwitterUtils.link(ParseUser, Context, SaveCallback)
and ParseTwitterUtils.logIn(Context, LogInCallback)
.
++
consumerKey
- Your Twitter consumer key.consumerSecret
- Your Twitter consumer secret.+public static boolean isLinked(ParseUser user)+
true
if the user is linked to a Twitter account.
++
+public static void link(ParseUser user, + Context context)+
ParseTwitterUtils.link(ParseUser, Context, SaveCallback)
+public static void link(ParseUser user, + Context context, + SaveCallback callback)+
+
user
- The user to link to a Twitter account.context
- An Android context from which the login dialog can be launched.callback
- Callback for notifying the calling application when the Twitter authentication has
+ completed, failed, or been canceled.+public static void link(ParseUser user, + String twitterId, + String screenName, + String authToken, + String authTokenSecret)+
ParseTwitterUtils.link(ParseUser, String, String, String, String, SaveCallback)
+public static void link(ParseUser user, + String twitterId, + String screenName, + String authToken, + String authTokenSecret, + SaveCallback callback)+
+
user
- The user to link to a Twitter account.twitterId
- The user's Twitter ID.screenName
- The user's Twitter screen name.authToken
- The auth token for the session.authTokenSecret
- The auth token secret for the session.callback
- Callback for notifying that the authentication data has been saved to the ParseUser.+public static void logIn(String twitterId, + String screenName, + String authToken, + String authTokenSecret, + LogInCallback callback)+
+
twitterId
- The user's Twitter ID.screenName
- The user's Twitter screen name.authToken
- The auth token for the session.authTokenSecret
- The auth token secret for the session.callback
- Callback for notifying that the authentication data has been saved to the ParseUser.+public static void logIn(Context context, + LogInCallback callback)+
+
context
- An Android context from which the login dialog can be launched.callback
- Callback for notifying the calling application when the Twitter authentication has
+ completed, failed, or been canceled.+public static void unlink(ParseUser user) + throws ParseException+
+
ParseException
+public static void unlinkInBackground(ParseUser user)+
ParseTwitterUtils.unlinkInBackground(ParseUser)
+public static void unlinkInBackground(ParseUser user, + SaveCallback callback)+
+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.ParseObject +
com.parse.ParseUser +
public class ParseUser
+
+Constructor Summary | +|
---|---|
ParseUser()
+
++ Constructs a new ParseUser with no data in it. |
+
+Method Summary | +|
---|---|
+static ParseUser |
+become(String sessionToken)
+
++ Authorize a user with a session token. |
+
+static void |
+becomeInBackground(String sessionToken,
+ LogInCallback callback)
+
++ Authorize a user with a session token. |
+
+static void |
+enableAutomaticUser()
+
++ Enables automatic creation of anonymous users. |
+
+ ParseUser |
+fetch()
+
++ Fetches this object with the data from the server. |
+
+ ParseUser |
+fetchIfNeeded()
+
++ If this ParseObject has not been fetched (i.e. |
+
+static ParseUser |
+getCurrentUser()
+
++ This retrieves the currently logged in ParseUser with a valid session, either from memory or + disk if necessary. |
+
+ String |
+getEmail()
+
++ Retrieves the email address. |
+
+static ParseQuery<ParseUser> |
+getQuery()
+
++ Constructs a query for ParseUsers. |
+
+ String |
+getSessionToken()
+
++ Retrieves the session token for a user, if they are logged in. |
+
+ String |
+getUsername()
+
++ Retrieves the username. |
+
+ boolean |
+isAuthenticated()
+
++ Whether the ParseUser has been authenticated on this device. |
+
+ boolean |
+isNew()
+
++ Indicates whether this ParseUser was created during this session through a call to
+ ParseUser.signUp() or by logging in with a linked service such as Facebook. |
+
+static ParseUser |
+logIn(String username,
+ String password)
+
++ Logs in a user with a username and password. |
+
+static void |
+logInInBackground(String username,
+ String password,
+ LogInCallback callback)
+
++ Logs in a user with a username and password. |
+
+static void |
+logOut()
+
++ Logs out the currently logged in user session. |
+
+ void |
+put(String key,
+ Object value)
+
++ Add a key-value pair to this object. |
+
+ void |
+remove(String key)
+
++ Removes a key from this object's data if it exists. |
+
+static void |
+requestPasswordReset(String email)
+
++ Requests a password reset email to be sent to the specified email address associated with the + user account. |
+
+static void |
+requestPasswordResetInBackground(String email,
+ RequestPasswordResetCallback callback)
+
++ Requests a password reset email to be sent in a background thread to the specified email + address associated with the user account. |
+
+ void |
+setEmail(String email)
+
++ Sets the email address. |
+
+ void |
+setPassword(String password)
+
++ Sets the password. |
+
+ void |
+setUsername(String username)
+
++ Sets the username. |
+
+ void |
+signUp()
+
++ Signs up a new user. |
+
+ void |
+signUpInBackground(SignUpCallback callback)
+
++ Signs up a new user. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public ParseUser()+
ParseUser.signUp()
is called.
++
+Method Detail | +
---|
+public boolean isAuthenticated()+
+
+public void remove(String key)+
ParseObject
+
remove
in class ParseObject
key
- The key to remove.+public void setUsername(String username)+
+
username
- The username to set.+public String getUsername()+
+
+public void setPassword(String password)+
+
password
- The password to set.+public void setEmail(String email)+
+
email
- The email address to set.+public String getEmail()+
+
+public void put(String key, + Object value)+
ParseObject
+
put
in class ParseObject
key
- Keys must be alphanumerical plus underscore, and start with a letter.value
- Values may be numerical, String, JSONObject, JSONArray, JSONObject.NULL, or other
+ ParseObjects. value may not be null
.+public String getSessionToken()+
+
+public ParseUser fetch() + throws ParseException+
ParseObject
+
fetch
in class ParseObject
ParseException
- Throws an exception if the server is inaccessible.+public void signUp() + throws ParseException+
ParseObject.save()
for new ParseUsers. This
+ will create a new ParseUser on the server, and also persist the session on disk so that you can
+ access the user using ParseUser.getCurrentUser()
.
+ + A username and password must be set before calling signUp. +
+
+ Typically, you should use ParseUser.signUpInBackground(com.parse.SignUpCallback)
instead of this, unless you are managing
+ your own threading.
+
+
ParseException
- Throws an exception if the server is inaccessible, or if the username has already
+ been taken.+public void signUpInBackground(SignUpCallback callback)+
ParseObject.save()
for new ParseUsers. This
+ will create a new ParseUser on the server, and also persist the session on disk so that you can
+ access the user using ParseUser.getCurrentUser()
.
+ + A username and password must be set before calling signUp. +
+
+ This is preferable to using ParseUser.signUp()
, unless your code is already running from a
+ background thread.
+
+
callback
- callback.done(user, e) is called when the signUp completes.
+ParseException
- Throws an exception if the server is inaccessible, or if the username has already
+ been taken.+public static ParseUser logIn(String username, + String password) + throws ParseException+
ParseUser.getCurrentUser()
+
+ Typically, you should use ParseUser.logInInBackground(java.lang.String, java.lang.String, com.parse.LogInCallback)
instead of this, unless you are managing
+ your own threading.
+
+
username
- The username to log in with.password
- The password to log in with.
+ParseException
- Throws an exception if the login was unsuccessful.+public static void logInInBackground(String username, + String password, + LogInCallback callback)+
ParseUser.getCurrentUser()
+
+ This is preferable to using ParseUser.logIn(java.lang.String, java.lang.String)
, unless your code is already running from a
+ background thread.
+
+
username
- The username to log in with.password
- The password to log in with.callback
- callback.done(user, e) is called when the login completes.+public static ParseUser become(String sessionToken) + throws ParseException+
ParseUser.getCurrentUser()
+
+ Typically, you should use ParseUser.becomeInBackground(java.lang.String, com.parse.LogInCallback)
instead of this, unless you are managing
+ your own threading.
+
+
sessionToken
- The session token to authorize with.
+ParseException
- Throws an exception if the authorization was unsuccessful.+public static void becomeInBackground(String sessionToken, + LogInCallback callback)+
ParseUser.getCurrentUser()
+
+ This is preferable to using ParseUser.become(java.lang.String)
, unless your code is already running from a
+ background thread.
+
+
sessionToken
- The session token to authorize with.callback
- callback.done(user, e) is called when the authorization completes.+public static ParseUser getCurrentUser()+
+
+public static void logOut()+
ParseUser.getCurrentUser()
will return null.
++
+public static void requestPasswordReset(String email) + throws ParseException+
+ Typically, you should use ParseUser.requestPasswordResetInBackground(java.lang.String, com.parse.RequestPasswordResetCallback)
instead of this, unless you
+ are managing your own threading.
+
+
email
- The email address associated with the user that forgot their password.
+ParseException
- Throws an exception if the server is inaccessible, or if an account with that email
+ doesn't exist.+public static void requestPasswordResetInBackground(String email, + RequestPasswordResetCallback callback)+
+ This is preferable to using requestPasswordReset(), unless your code is already running from a + background thread. +
++
email
- The email address associated with the user that forgot their password.callback
- callback.done(e) is called when the request completes.+public ParseUser fetchIfNeeded() + throws ParseException+
ParseObject
ParseObject.isDataAvailable()
returns false),
+ fetches this object with the data from the server.
++
fetchIfNeeded
in class ParseObject
ParseException
- Throws an exception if the server is inaccessible.+public boolean isNew()+
ParseUser
was created during this session through a call to
+ ParseUser.signUp()
or by logging in with a linked service such as Facebook.
++
+public static void enableAutomaticUser()+
ParseUser.getCurrentUser()
will always have a value. The user will only be created on
+ the server once the user has been saved, or once an object with a relation to that user or an
+ ACL that refers to the user has been saved. Note: saveEventually will not work if an item being
+ saved has a relation to an automatic user that has never been saved.
++
+public static ParseQuery<ParseUser> getQuery()+
+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.ProgressCallback +
public abstract class ProgressCallback
+A ProgressCallback is used to get progress of an operation. +
+ The easiest way to use a ProgressCallback is through an anonymous inner class. +
+ +
+
+Constructor Summary | +|
---|---|
ProgressCallback()
+
++ |
+
+Method Summary | +|
---|---|
+abstract void |
+done(Integer percentDone)
+
++ Override this function with your desired callback. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public ProgressCallback()+
+Method Detail | +
---|
+public abstract void done(Integer percentDone)+
+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++android.content.Context +
android.content.ContextWrapper +
android.app.Service +
com.parse.PushService +
public final class PushService
+A service to listen for push notifications. This operates in the same process as the parent
+ application.
+
+ The PushService can listen to pushes from two different sources: Google Cloud Messaging (GCM) or
+ the Parse Push Notification Service (PPNS). Parse will inspect your application's manifest at
+ runtime and determine which service to use for push. We recommend using GCM for push on devices
+ that have Google Play Store support. PPNS support is provided for apps that want to avoid a
+ dependency on the Google Play Store, and for devices (like Kindles) which do not have Play Store
+ support.
+
+ To configure the PushService for GCM, ensure these permission declarations are present in your
+ AndroidManifest.xml as children of the <manifest>
element:
+
+
+ <uses-permission android:name="android.permission.INTERNET" /> + <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> + <uses-permission android:name="android.permission.VIBRATE" /> + <uses-permission android:name="android.permission.WAKE_LOCK" /> + <uses-permission android:name="android.permission.GET_ACCOUNTS" /> + <uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" /> + <permission android:name="YOUR_PACKAGE_NAME.permission.C2D_MESSAGE" + android:protectionLevel="signature" /> + <uses-permission android:name="YOUR_PACKAGE_NAME.permission.C2D_MESSAGE" /> ++ + Replace YOUR_PACKAGE_NAME in the declarations above with your application's package name. Also, + make sure that com.parse.GcmBroadcastReceiver and com.parse.PushService are declared as children + of the<application>
element: + ++ <service android:name="com.parse.PushService" /> + <receiver android:name="com.parse.GcmBroadcastReceiver" + android:permission="com.google.android.c2dm.permission.SEND"> + <intent-filter> + <action android:name="com.google.android.c2dm.intent.RECEIVE" /> + <action android:name="com.google.android.c2dm.intent.REGISTRATION" /> + <category android:name="YOUR_PACKAGE_NAME" /> + </intent-filter> + </receiver> ++ + Again, replace YOUR_PACKAGE_NAME with your application's package name. + + To configure the PushService for PPNS, ensure these permission declarations are present in your + AndroidManifest.xml as children of the<manifest>
element: + ++ <uses-permission android:name="android.permission.INTERNET" /> + <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> + <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" /> + <uses-permission android:name="android.permission.VIBRATE" /> + <uses-permission android:name="android.permission.WAKE_LOCK" /> ++ + Also, make sure that com.parse.ParseBroadcastReceiver and com.parse.PushService are declared as + children of the<application>
element: + + <service android:name="com.parse.PushService" /> + <receiver android:name="com.parse.ParseBroadcastReceiver"> + <intent-filter> + <action android:name="android.intent.action.BOOT_COMPLETED" /> + <action android:name="android.intent.action.USER_PRESENT" /> + </intent-filter> + </receiver> + + Note that you can configure the push service for both GCM and PPNS by adding all the declarations + above to your application's manifest. In this case, Parse will use GCM on devices with Play + Store support and fall back to using PPNS on devices without Play Store support. + + Once push notifications are configured in the manifest, you can subscribe to a push channel by + calling: + ++ PushService.subscribe(context, "the_channel_name", YourActivity.class); ++ + When the client receives a push message, a notification will appear in the system tray. When the + user taps the notification, they will enter the application through a new instance of + YourActivity. ++ +
+
+ +
+Field Summary | +
---|
Fields inherited from class android.app.Service | +
---|
START_CONTINUATION_MASK, START_FLAG_REDELIVERY, START_FLAG_RETRY, START_NOT_STICKY, START_REDELIVER_INTENT, START_STICKY, START_STICKY_COMPATIBILITY |
+
+Constructor Summary | +|
---|---|
PushService()
+
++ Client code should not construct a PushService directly. |
+
+Method Summary | +|
---|---|
+static Set<String> |
+getSubscriptions(Context context)
+
++ Accesses the current set of channels for which the current installation is subscribed. |
+
+ IBinder |
+onBind(Intent intent)
+
++ onBind should not be called directly. |
+
+ void |
+onCreate()
+
++ Client code should not call onCreate directly. |
+
+ void |
+onDestroy()
+
++ Client code should not call onDestroy directly. |
+
+ int |
+onStartCommand(Intent intent,
+ int flags,
+ int startId)
+
++ |
+
+static void |
+setDefaultPushCallback(Context context,
+ Class<? extends Activity> cls)
+
++ Provides a default Activity class to handle pushes. |
+
+static void |
+setDefaultPushCallback(Context context,
+ Class<? extends Activity> cls,
+ int icon)
+
++ Provides a default Activity class to handle pushes. |
+
+static void |
+startServiceIfRequired(Context context)
+
++ |
+
+static void |
+subscribe(Context context,
+ String channel,
+ Class<? extends Activity> cls)
+
++ Helper function to subscribe to push notifications with the default application icon. |
+
+static void |
+subscribe(Context context,
+ String channel,
+ Class<? extends Activity> cls,
+ int icon)
+
++ Call this function when the user should be subscribed to a new push channel. |
+
+static void |
+unsubscribe(Context context,
+ String channel)
+
++ Cancels a previous call to subscribe. |
+
Methods inherited from class android.app.Service | +
---|
dump, finalize, getApplication, onConfigurationChanged, onLowMemory, onRebind, onStart, onUnbind, setForeground, startForeground, stopForeground, stopSelf, stopSelf, stopSelfResult |
+
Methods inherited from class android.content.Context | +
---|
getString, getString, getText, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes |
+
Methods inherited from class Object | +
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public PushService()+
+
+Method Detail | +
---|
+public static void startServiceIfRequired(Context context)+
+public static void subscribe(Context context, + String channel, + Class<? extends Activity> cls)+
+
context
- This is used to access local storage to cache the subscription, so it must currently
+ be a viable context.channel
- A string identifier that determines which messages will cause a push notification to
+ be sent to this client. The channel name must start with a letter and contain only
+ letters, numbers, dashes, and underscores.cls
- This should be a subclass of Activity. An instance of this Activity is started when
+ the user responds to this push notification. If you are not sure what to use here,
+ just use your application's main Activity subclass.
+IllegalArgumentException
- if the channel name is not valid.+public static void subscribe(Context context, + String channel, + Class<? extends Activity> cls, + int icon)+
+
context
- This is used to access local storage to cache the subscription, so it must currently
+ be a viable context.channel
- A string identifier that determines which messages will cause a push notification to
+ be sent to this client. The channel name must start with a letter and contain only
+ letters, numbers, dashes, and underscores.cls
- This should be a subclass of Activity. An instance of this Activity is started when
+ the user responds to this push notification. If you are not sure what to use here,
+ just use your application's main Activity subclass.icon
- The icon to show for the notification.
+IllegalArgumentException
- if the channel name is not valid.+public static void unsubscribe(Context context, + String channel)+
+
context
- A currently viable Context.channel
- The string defining the channel to unsubscribe from.+public static void setDefaultPushCallback(Context context, + Class<? extends Activity> cls)+
+
context
- This is used to access local storage to cache the subscription, so it must currently
+ be a viable context.cls
- This should be a subclass of Activity. An instance of this Activity is started when
+ the user responds to this push notification. If you are not sure what to use here,
+ just use your application's main Activity subclass.+public static void setDefaultPushCallback(Context context, + Class<? extends Activity> cls, + int icon)+
+
context
- This is used to access local storage to cache the subscription, so it must currently
+ be a viable context.cls
- This should be a subclass of Activity. An instance of this Activity is started when
+ the user responds to this push notification. If you are not sure what to use here,
+ just use your application's main Activity subclass.icon
- The icon to show for the notification.+public static Set<String> getSubscriptions(Context context)+
+
context
- A currently viable Context.
++public void onCreate()+
+
onCreate
in class Service
+public int onStartCommand(Intent intent, + int flags, + int startId)+
onStartCommand
in class Service
+public IBinder onBind(Intent intent)+
+
onBind
in class Service
+public void onDestroy()+
+
onDestroy
in class Service
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.RefreshCallback +
public abstract class RefreshCallback
+A RefreshCallback is used to run code after refresh is used to update a ParseObject
in a
+ background thread.
+
+ The easiest way to use a RefreshCallback is through an anonymous inner class. Override the
+ done
function to specify what the callback should do after the refresh is complete.
+ The done
function will be run in the UI thread, while the refresh happens in a
+ background thread. This ensures that the UI does not freeze while the refresh happens.
+
+ For example, this sample code refreshes an object of class "MyClass"
and id
+ myId
. It calls a different function depending on whether the refresh succeeded or
+ not.
+
+ +
+ object.refreshInBackground(new RefreshCallback() { + public void done(ParseObject object, ParseException e) { + if (e == null) { + objectWasRefreshedSuccessfully(object); + } else { + objectRefreshFailed(); + } + } + }); ++
+ +
+
+Constructor Summary | +|
---|---|
RefreshCallback()
+
++ |
+
+Method Summary | +|
---|---|
+abstract void |
+done(ParseObject object,
+ ParseException e)
+
++ Override this function with the code you want to run after the save is complete. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public RefreshCallback()+
+Method Detail | +
---|
+public abstract void done(ParseObject object, + ParseException e)+
+
e
- The exception raised by the save, or null if it succeeded.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.RequestPasswordResetCallback +
public abstract class RequestPasswordResetCallback
+A RequestPasswordResetCallback is used to run code requesting a password reset for a user. +
+ The easiest way to use a RequestPasswordResetCallback is through an anonymous inner class.
+ Override the done
function to specify what the callback should do after the request
+ is complete. The done
function will be run in the UI thread, while the request
+ happens in a background thread. This ensures that the UI does not freeze while the request
+ happens.
+
+ For example, this sample code requests a password reset for a user and calls a different function + depending on whether the request succeeded or not. +
+ +
+ ParseUser.requestPasswordResetInBackground("forgetful@example.com", + new RequestPasswordResetCallback() { + public void done(ParseException e) { + if (e == null) { + requestedSuccessfully(); + } else { + requestDidNotSucceed(); + } + } + }); ++
+ +
+
+Constructor Summary | +|
---|---|
RequestPasswordResetCallback()
+
++ |
+
+Method Summary | +|
---|---|
+abstract void |
+done(ParseException e)
+
++ Override this function with the code you want to run after the request is complete. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public RequestPasswordResetCallback()+
+Method Detail | +
---|
+public abstract void done(ParseException e)+
+
e
- The exception raised by the save, or null if no account is associated with the email
+ address.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.SaveCallback +
public abstract class SaveCallback
+A SaveCallback is used to run code after saving a ParseObject
in a background thread.
+
+ The easiest way to use a SaveCallback is through an anonymous inner class. Override the
+ done
function to specify what the callback should do after the save is complete. The
+ done
function will be run in the UI thread, while the save happens in a background
+ thread. This ensures that the UI does not freeze while the save happens.
+
+ For example, this sample code saves the object myObject
and calls a different
+ function depending on whether the save succeeded or not.
+
+ +
+ myObject.saveInBackground(new SaveCallback() { + public void done(ParseException e) { + if (e == null) { + myObjectSavedSuccessfully(); + } else { + myObjectSaveDidNotSucceed(); + } + } + }); ++
+ +
+
+Constructor Summary | +|
---|---|
SaveCallback()
+
++ |
+
+Method Summary | +|
---|---|
+abstract void |
+done(ParseException e)
+
++ Override this function with the code you want to run after the save is complete. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public SaveCallback()+
+Method Detail | +
---|
+public abstract void done(ParseException e)+
+
e
- The exception raised by the save, or null if it succeeded.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.SendCallback +
public abstract class SendCallback
+A SendCallback is used to run code after sending a ParsePush
in a background thread.
+
+ The easiest way to use a SendCallback is through an anonymous inner class. Override the
+ done
function to specify what the callback should do after the send is complete. The
+ done
function will be run in the UI thread, while the send happens in a background
+ thread. This ensures that the UI does not freeze while the send happens.
+
+ For example, this sample code sends the message "Hello world"
on the
+ "hello"
channel and logs whether the send succeeded.
+
+ +
+ ParsePush push = new ParsePush(); + push.setChannel("hello"); + push.setMessage("Hello world!"); + push.sendInBackground(new SendCallback() { + public void done(ParseException e) { + if (e == null) { + Log.d("push", "success!"); + } else { + Log.d("push", "failure"); + } + } + }); ++
+ +
+
+Constructor Summary | +|
---|---|
SendCallback()
+
++ |
+
+Method Summary | +|
---|---|
+abstract void |
+done(ParseException e)
+
++ Override this function with the code you want to run after the send is complete. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public SendCallback()+
+Method Detail | +
---|
+public abstract void done(ParseException e)+
+
e
- The exception raised by the send, or null if it succeeded.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+Object ++com.parse.SignUpCallback +
public abstract class SignUpCallback
+A SignUpCallback is used to run code after signing up a ParseUser
in a background thread.
+
+ The easiest way to use a SignUpCallback is through an anonymous inner class. Override the
+ done
function to specify what the callback should do after the save is complete. The
+ done
function will be run in the UI thread, while the signup happens in a background
+ thread. This ensures that the UI does not freeze while the signup happens.
+
+ For example, this sample code signs up the object myUser
and calls a different
+ function depending on whether the signup succeeded or not.
+
+ +
+ myUser.signUpInBackground(new SignUpCallback() { + public void done(ParseException e) { + if (e == null) { + myUserSignedUpSuccessfully(); + } else { + myUserSignUpDidNotSucceed(); + } + } + }); ++
+ +
+
+Constructor Summary | +|
---|---|
SignUpCallback()
+
++ |
+
+Method Summary | +|
---|---|
+abstract void |
+done(ParseException e)
+
++ Override this function with the code you want to run after the signUp is complete. |
+
Methods inherited from class Object | +
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
+Constructor Detail | +
---|
+public SignUpCallback()+
+Method Detail | +
---|
+public abstract void done(ParseException e)+
+
e
- The exception raised by the signUp, or null if it succeeded.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of CountCallback in com.parse | +
---|
+ +
Methods in com.parse with parameters of type CountCallback | +|
---|---|
+ void |
+ParseQuery.countInBackground(CountCallback callback)
+
++ Counts the number of objects that match this query in a background thread. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of DeleteCallback in com.parse | +
---|
+ +
Methods in com.parse with parameters of type DeleteCallback | +|
---|---|
+static void |
+ParseObject.deleteAllInBackground(List<ParseObject> objects,
+ DeleteCallback callback)
+
++ Deletes each object in the provided list. |
+
+ void |
+ParseObject.deleteEventually(DeleteCallback callback)
+
++ Deletes this object from the server at some unspecified time in the future, even if Parse is + currently inaccessible. |
+
+ void |
+ParseObject.deleteInBackground(DeleteCallback callback)
+
++ Deletes this object on the server in a background thread. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of FindCallback in com.parse | +
---|
+ +
Methods in com.parse with parameters of type FindCallback | +||
---|---|---|
+static
+ |
+ParseObject.fetchAllIfNeededInBackground(List<T> objects,
+ FindCallback<T> callback)
+
++ Fetches all the objects that don't have data in the provided list in the background |
+|
+static
+ |
+ParseObject.fetchAllInBackground(List<T> objects,
+ FindCallback<T> callback)
+
++ Fetches all the objects in the provided list in the background |
+|
+ void |
+ParseQuery.findInBackground(FindCallback<T> callback)
+
++ Retrieves a list of ParseObjects that satisfy this query from the server in a background + thread. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of FunctionCallback in com.parse | +
---|
+ +
Methods in com.parse with parameters of type FunctionCallback | +||
---|---|---|
+static
+ |
+ParseCloud.callFunctionInBackground(String name,
+ Map<String,?> params,
+ FunctionCallback<T> callback)
+
++ Calls a cloud function in the background. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of GetCallback in com.parse | +
---|
+ +
Methods in com.parse with parameters of type GetCallback | +||
---|---|---|
+
+ |
+ParseObject.fetchIfNeededInBackground(GetCallback<T> callback)
+
++ If this ParseObject has not been fetched (i.e. |
+|
+
+ |
+ParseObject.fetchInBackground(GetCallback<T> callback)
+
++ Fetches this object with the data from the server in a background thread. |
+|
+ void |
+ParseQuery.getFirstInBackground(GetCallback<T> callback)
+
++ Retrieves at most one ParseObject that satisfies this query from the server in a background + thread. |
+|
+ void |
+ParseQuery.getInBackground(String objectId,
+ GetCallback<T> callback)
+
++ Constructs a ParseObject whose id is already known by fetching data from the server in a + background thread. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of GetDataCallback in com.parse | +
---|
+ +
Methods in com.parse with parameters of type GetDataCallback | +|
---|---|
+ void |
+ParseFile.getDataInBackground(GetDataCallback dataCallback)
+
++ Gets the data for this object in a background thread. |
+
+ void |
+ParseFile.getDataInBackground(GetDataCallback dataCallback,
+ ProgressCallback progressCallback)
+
++ Gets the data for this object in a background thread. |
+
+ void |
+ParseImageView.loadInBackground(GetDataCallback completionCallback)
+
++ Kick off downloading of remote image. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of LocationCallback in com.parse | +
---|
+ +
Methods in com.parse with parameters of type LocationCallback | +|
---|---|
+static void |
+ParseGeoPoint.getCurrentLocationInBackground(long timeout,
+ Criteria criteria,
+ LocationCallback callback)
+
++ Fetches the user's current location and returns a new ParseGeoPoint via the provided + LocationCallback. |
+
+static void |
+ParseGeoPoint.getCurrentLocationInBackground(long timeout,
+ LocationCallback callback)
+
++ Fetches the user's current location and returns a new ParseGeoPoint via the provided + LocationCallback. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of LogInCallback in com.parse | +
---|
+ +
Methods in com.parse with parameters of type LogInCallback | +|
---|---|
+static void |
+ParseUser.becomeInBackground(String sessionToken,
+ LogInCallback callback)
+
++ Authorize a user with a session token. |
+
+static void |
+ParseFacebookUtils.logIn(Activity activity,
+ int activityCode,
+ LogInCallback callback)
+
++ |
+
+static void |
+ParseFacebookUtils.logIn(Activity activity,
+ LogInCallback callback)
+
++ |
+
+static void |
+ParseFacebookUtils.logIn(Collection<String> permissions,
+ Activity activity,
+ int activityCode,
+ LogInCallback callback)
+
++ Logs in a ParseUser using Facebook for authentication. |
+
+static void |
+ParseFacebookUtils.logIn(Collection<String> permissions,
+ Activity activity,
+ LogInCallback callback)
+
++ Logs in a user using the default activity code if single sign-on is enabled. |
+
+static void |
+ParseTwitterUtils.logIn(Context context,
+ LogInCallback callback)
+
++ Logs in a ParseUser using Twitter for authentication. |
+
+static void |
+ParseAnonymousUtils.logIn(LogInCallback callback)
+
++ Creates an anonymous user. |
+
+static void |
+ParseFacebookUtils.logIn(String facebookId,
+ String accessToken,
+ Date expirationDate,
+ LogInCallback callback)
+
++ Logs in a ParseUser using Facebook for authentication. |
+
+static void |
+ParseTwitterUtils.logIn(String twitterId,
+ String screenName,
+ String authToken,
+ String authTokenSecret,
+ LogInCallback callback)
+
++ Logs in a ParseUser using Twitter for authentication. |
+
+static void |
+ParseUser.logInInBackground(String username,
+ String password,
+ LogInCallback callback)
+
++ Logs in a user with a username and password. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of ParseACL in com.parse | +
---|
+ +
Methods in com.parse that return ParseACL | +|
---|---|
+ ParseACL |
+ParseObject.getACL()
+
++ Access the ParseACL governing this object. |
+
+ +
Methods in com.parse with parameters of type ParseACL | +|
---|---|
+ void |
+ParseObject.setACL(ParseACL acl)
+
++ Set the ParseACL governing this object. |
+
+static void |
+ParseACL.setDefaultACL(ParseACL acl,
+ boolean withAccessForCurrentUser)
+
++ Sets a default ACL that will be applied to all ParseObject s when they are created. |
+
+ +
Constructors in com.parse with parameters of type ParseACL | +|
---|---|
ParseRole(String name,
+ ParseACL acl)
+
++ Constructs a new ParseRole with the given name. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of ParseClassName in com.parse | +
---|
+ +
Classes in com.parse with annotations of type ParseClassName | +|
---|---|
+ class |
+ParseInstallation
+
++ |
+
+ class |
+ParseRole
+
++ Represents a Role on the Parse server. |
+
+ class |
+ParseUser
+
++ |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of ParseException in com.parse | +
---|
+ +
Methods in com.parse with parameters of type ParseException | +|
---|---|
+abstract void |
+GetDataCallback.done(byte[] data,
+ ParseException e)
+
++ |
+
+abstract void |
+CountCallback.done(int count,
+ ParseException e)
+
++ Override this function with the code you want to run after the count is complete. |
+
+abstract void |
+FindCallback.done(List<T> objects,
+ ParseException e)
+
++ Override this function with the code you want to run after the fetch is complete. |
+
+abstract void |
+SignUpCallback.done(ParseException e)
+
++ Override this function with the code you want to run after the signUp is complete. |
+
+abstract void |
+SendCallback.done(ParseException e)
+
++ Override this function with the code you want to run after the send is complete. |
+
+abstract void |
+SaveCallback.done(ParseException e)
+
++ Override this function with the code you want to run after the save is complete. |
+
+abstract void |
+RequestPasswordResetCallback.done(ParseException e)
+
++ Override this function with the code you want to run after the request is complete. |
+
+abstract void |
+DeleteCallback.done(ParseException e)
+
++ Override this function with the code you want to run after the delete is complete. |
+
+abstract void |
+LocationCallback.done(ParseGeoPoint geoPoint,
+ ParseException e)
+
++ Override this function with the code you want to run after the location fetch is complete. |
+
+abstract void |
+RefreshCallback.done(ParseObject object,
+ ParseException e)
+
++ Override this function with the code you want to run after the save is complete. |
+
+abstract void |
+LogInCallback.done(ParseUser user,
+ ParseException e)
+
++ Override this function with the code you want to run after the save is complete. |
+
+abstract void |
+GetCallback.done(T object,
+ ParseException e)
+
++ Override this function with the code you want to run after the fetch is complete. |
+
+abstract void |
+FunctionCallback.done(T object,
+ ParseException e)
+
++ Override this function with the code you want to run after the cloud function is complete. |
+
+ +
Methods in com.parse that throw ParseException | +||
---|---|---|
+static ParseUser |
+ParseUser.become(String sessionToken)
+
++ Authorize a user with a session token. |
+|
+static
+ |
+ParseCloud.callFunction(String name,
+ Map<String,?> params)
+
++ Calls a cloud function. |
+|
+ int |
+ParseQuery.count()
+
++ Counts the number of objects that match this query. |
+|
+ void |
+ParseObject.delete()
+
++ Deletes this object on the server. |
+|
+static void |
+ParseObject.deleteAll(List<ParseObject> objects)
+
++ Deletes each object in the provided list. |
+|
+ ParseUser |
+ParseUser.fetch()
+
++ |
+|
+
+ |
+ParseObject.fetch()
+
++ Fetches this object with the data from the server. |
+|
+static List<ParseObject> |
+ParseObject.fetchAll(List<ParseObject> objects)
+
++ Fetches all the objects in the provided list. |
+|
+static
+ |
+ParseObject.fetchAllIfNeeded(List<T> objects)
+
++ Fetches all the objects that don't have data in the provided list. |
+|
+ ParseUser |
+ParseUser.fetchIfNeeded()
+
++ |
+|
+
+ |
+ParseObject.fetchIfNeeded()
+
++ If this ParseObject has not been fetched (i.e. |
+|
+ List<T> |
+ParseQuery.find()
+
++ Retrieves a list of ParseObjects that satisfy this query. |
+|
+ T |
+ParseQuery.get(String objectId)
+
++ Constructs a ParseObject whose id is already known by fetching data from the server. |
+|
+ byte[] |
+ParseFile.getData()
+
++ Synchronously gets the data for this object. |
+|
+ T |
+ParseQuery.getFirst()
+
++ Retrieves at most one ParseObject that satisfies this query. |
+|
+static ParseUser |
+ParseUser.logIn(String username,
+ String password)
+
++ Logs in a user with a username and password. |
+|
+ void |
+ParseObject.refresh()
+
++ Refreshes this object with the data from the server. |
+|
+static void |
+ParseUser.requestPasswordReset(String email)
+
++ Requests a password reset email to be sent to the specified email address associated with the + user account. |
+|
+ void |
+ParseObject.save()
+
++ Saves this object to the server. |
+|
+ void |
+ParseFile.save()
+
++ Saves the file to the Parse cloud synchronously. |
+|
+static void |
+ParseObject.saveAll(List<ParseObject> objects)
+
++ Saves each object in the provided list. |
+|
+ void |
+ParsePush.send()
+
++ Sends this push notification while blocking this thread until the push notification has + successfully reached the Parse servers. |
+|
+ void |
+ParseUser.signUp()
+
++ Signs up a new user. |
+|
+static void |
+ParseTwitterUtils.unlink(ParseUser user)
+
++ Unlinks a user from a Twitter account. |
+|
+static void |
+ParseFacebookUtils.unlink(ParseUser user)
+
++ Unlinks a user from a Facebook account. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of ParseFile in com.parse | +
---|
+ +
Methods in com.parse that return ParseFile | +|
---|---|
+ ParseFile |
+ParseObject.getParseFile(String key)
+
++ Access a ParseFile value. |
+
+ +
Methods in com.parse with parameters of type ParseFile | +|
---|---|
+ void |
+ParseImageView.setParseFile(ParseFile file)
+
++ Sets the remote file on Parse's server that stores the image. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of ParseGeoPoint in com.parse | +
---|
+ +
Methods in com.parse that return ParseGeoPoint | +|
---|---|
+ ParseGeoPoint |
+ParseObject.getParseGeoPoint(String key)
+
++ Access a ParseGeoPoint value. |
+
+ +
Methods in com.parse with parameters of type ParseGeoPoint | +|
---|---|
+ double |
+ParseGeoPoint.distanceInKilometersTo(ParseGeoPoint point)
+
++ Get distance between this point and another geopoint in kilometers. |
+
+ double |
+ParseGeoPoint.distanceInMilesTo(ParseGeoPoint point)
+
++ Get distance between this point and another geopoint in kilometers. |
+
+ double |
+ParseGeoPoint.distanceInRadiansTo(ParseGeoPoint point)
+
++ Get distance in radians between this point and another GeoPoint. |
+
+abstract void |
+LocationCallback.done(ParseGeoPoint geoPoint,
+ ParseException e)
+
++ Override this function with the code you want to run after the location fetch is complete. |
+
+ ParseQuery<T> |
+ParseQuery.whereNear(String key,
+ ParseGeoPoint point)
+
++ Add a proximity based constraint for finding objects with key point values near the point + given. |
+
+ ParseQuery<T> |
+ParseQuery.whereWithinGeoBox(String key,
+ ParseGeoPoint southwest,
+ ParseGeoPoint northeast)
+
++ Add a constraint to the query that requires a particular key's coordinates be contained within + a given rectangular geographic bounding box. |
+
+ ParseQuery<T> |
+ParseQuery.whereWithinKilometers(String key,
+ ParseGeoPoint point,
+ double maxDistance)
+
++ Add a proximity based constraint for finding objects with key point values near the point given + and within the maximum distance given. |
+
+ ParseQuery<T> |
+ParseQuery.whereWithinMiles(String key,
+ ParseGeoPoint point,
+ double maxDistance)
+
++ Add a proximity based constraint for finding objects with key point values near the point given + and within the maximum distance given. |
+
+ ParseQuery<T> |
+ParseQuery.whereWithinRadians(String key,
+ ParseGeoPoint point,
+ double maxDistance)
+
++ Add a proximity based constraint for finding objects with key point values near the point given + and within the maximum distance given. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of ParseInstallation in com.parse | +
---|
+ +
Methods in com.parse that return ParseInstallation | +|
---|---|
+static ParseInstallation |
+ParseInstallation.getCurrentInstallation()
+
++ |
+
+ +
Methods in com.parse that return types with arguments of type ParseInstallation | +|
---|---|
+static ParseQuery<ParseInstallation> |
+ParseInstallation.getQuery()
+
++ Constructs a query for ParseInstallations. |
+
+ +
Method parameters in com.parse with type arguments of type ParseInstallation | +|
---|---|
+static void |
+ParsePush.sendDataInBackground(JSONObject data,
+ ParseQuery<ParseInstallation> query)
+
++ A helper method to concisely send a push to a query. |
+
+static void |
+ParsePush.sendDataInBackground(JSONObject data,
+ ParseQuery<ParseInstallation> query,
+ SendCallback callback)
+
++ A helper method to concisely send a push to a query. |
+
+static void |
+ParsePush.sendMessageInBackground(String message,
+ ParseQuery<ParseInstallation> query)
+
++ A helper method to concisely send a push message to a query. |
+
+static void |
+ParsePush.sendMessageInBackground(String message,
+ ParseQuery<ParseInstallation> query,
+ SendCallback callback)
+
++ A helper method to concisely send a push message to a query. |
+
+ void |
+ParsePush.setQuery(ParseQuery<ParseInstallation> query)
+
++ Sets the query for this push for which this push notification will be sent. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of ParseObject in com.parse | +
---|
+ +
Classes in com.parse with type parameters of type ParseObject | +|
---|---|
+ class |
+FindCallback<T extends ParseObject>
+
++ A FindCallback is used to run code after a ParseQuery is used to fetch a list of
+ ParseObject s in a background thread. |
+
+ class |
+GetCallback<T extends ParseObject>
+
++ A GetCallback is used to run code after a ParseQuery is used to fetch a
+ ParseObject in a background thread. |
+
+ class |
+ParseQuery<T extends ParseObject>
+
++ The ParseQuery class defines a query that is used to fetch ParseObjects. |
+
+ class |
+ParseQueryAdapter<T extends ParseObject>
+
++ A ParseQueryAdapter handles the fetching of objects by page, and displaying objects as views in a + ListView. |
+
+static interface |
+ParseQueryAdapter.OnQueryLoadListener<T extends ParseObject>
+
++ Implement with logic that is called before and after objects are fetched from Parse by the + adapter. |
+
+static interface |
+ParseQueryAdapter.QueryFactory<T extends ParseObject>
+
++ Implement to construct your own custom ParseQuery for fetching objects. |
+
+ class |
+ParseRelation<T extends ParseObject>
+
++ A class that is used to access all of the children of a many-to-many relationship. |
+
+ +
Subclasses of ParseObject in com.parse | +|
---|---|
+ class |
+ParseInstallation
+
++ |
+
+ class |
+ParseRole
+
++ Represents a Role on the Parse server. |
+
+ class |
+ParseUser
+
++ |
+
+ +
Methods in com.parse with type parameters of type ParseObject | +||
---|---|---|
+static
+ |
+ParseObject.create(Class<T> subclass)
+
++ Creates a new ParseObject based upon a subclass type. |
+|
+static
+ |
+ParseObject.createWithoutData(Class<T> subclass,
+ String objectId)
+
++ Creates a reference to an existing ParseObject for use in creating associations between + ParseObjects. |
+|
+
+ |
+ParseObject.fetch()
+
++ Fetches this object with the data from the server. |
+|
+static
+ |
+ParseObject.fetchAllIfNeeded(List<T> objects)
+
++ Fetches all the objects that don't have data in the provided list. |
+|
+static
+ |
+ParseObject.fetchAllIfNeededInBackground(List<T> objects,
+ FindCallback<T> callback)
+
++ Fetches all the objects that don't have data in the provided list in the background |
+|
+static
+ |
+ParseObject.fetchAllInBackground(List<T> objects,
+ FindCallback<T> callback)
+
++ Fetches all the objects in the provided list in the background |
+|
+
+ |
+ParseObject.fetchIfNeeded()
+
++ If this ParseObject has not been fetched (i.e. |
+|
+
+ |
+ParseObject.fetchIfNeededInBackground(GetCallback<T> callback)
+
++ If this ParseObject has not been fetched (i.e. |
+|
+
+ |
+ParseObject.fetchInBackground(GetCallback<T> callback)
+
++ Fetches this object with the data from the server in a background thread. |
+|
+static
+ |
+ParseQuery.getQuery(Class<T> subclass)
+
++ Creates a new query for the given ParseObject subclass type. |
+|
+static
+ |
+ParseQuery.getQuery(String className)
+
++ Creates a new query for the given class name. |
+|
+
+ |
+ParseObject.getRelation(String key)
+
++ Access or create a Relation value for a key |
+|
+static
+ |
+ParseQuery.or(List<ParseQuery<T>> queries)
+
++ Constructs a query that is the or of the given queries. |
+
+ +
Methods in com.parse that return ParseObject | +|
---|---|
+static ParseObject |
+ParseObject.create(String className)
+
++ Creates a new ParseObject based upon a class name. |
+
+static ParseObject |
+ParseObject.createWithoutData(String className,
+ String objectId)
+
++ Creates a reference to an existing ParseObject for use in creating associations between + ParseObjects. |
+
+ ParseObject |
+ParseObject.getParseObject(String key)
+
++ Access a ParseObject value. |
+
+ +
Methods in com.parse that return types with arguments of type ParseObject | +|
---|---|
+static List<ParseObject> |
+ParseObject.fetchAll(List<ParseObject> objects)
+
++ Fetches all the objects in the provided list. |
+
+ +
Methods in com.parse with parameters of type ParseObject | +|
---|---|
+abstract void |
+RefreshCallback.done(ParseObject object,
+ ParseException e)
+
++ Override this function with the code you want to run after the save is complete. |
+
+ boolean |
+ParseObject.hasSameId(ParseObject other)
+
++ |
+
+ +
Method parameters in com.parse with type arguments of type ParseObject | +|
---|---|
+static void |
+ParseObject.deleteAll(List<ParseObject> objects)
+
++ Deletes each object in the provided list. |
+
+static void |
+ParseObject.deleteAllInBackground(List<ParseObject> objects,
+ DeleteCallback callback)
+
++ Deletes each object in the provided list. |
+
+static List<ParseObject> |
+ParseObject.fetchAll(List<ParseObject> objects)
+
++ Fetches all the objects in the provided list. |
+
+static void |
+ParseObject.registerSubclass(Class<? extends ParseObject> subclass)
+
++ Registers a custom subclass type with the Parse SDK, enabling strong-typing of those + ParseObjects whenever they appear. |
+
+static void |
+ParseObject.saveAll(List<ParseObject> objects)
+
++ Saves each object in the provided list. |
+
+static void |
+ParseObject.saveAllInBackground(List<ParseObject> objects)
+
++ Saves each object to the server in a background thread. |
+
+static void |
+ParseObject.saveAllInBackground(List<ParseObject> objects,
+ SaveCallback callback)
+
++ Saves each object in the provided list to the server in a background thread. |
+
+ +
Constructor parameters in com.parse with type arguments of type ParseObject | +|
---|---|
ParseQueryAdapter(Context context,
+ Class<? extends ParseObject> clazz)
+
++ Constructs a ParseQueryAdapter. |
+|
ParseQueryAdapter(Context context,
+ Class<? extends ParseObject> clazz,
+ int itemViewResource)
+
++ Constructs a ParseQueryAdapter. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of ParseQuery.CachePolicy in com.parse | +
---|
+ +
Methods in com.parse that return ParseQuery.CachePolicy | +|
---|---|
+ ParseQuery.CachePolicy |
+ParseQuery.getCachePolicy()
+
++ Accessor for the caching policy. |
+
+static ParseQuery.CachePolicy |
+ParseQuery.CachePolicy.valueOf(String name)
+
++ Returns the enum constant of this type with the specified name. |
+
+static ParseQuery.CachePolicy[] |
+ParseQuery.CachePolicy.values()
+
++ Returns an array containing the constants of this enum type, in +the order they are declared. |
+
+ +
Methods in com.parse with parameters of type ParseQuery.CachePolicy | +|
---|---|
+ void |
+ParseQuery.setCachePolicy(ParseQuery.CachePolicy newCachePolicy)
+
++ Change the caching policy of this query. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of ParseQuery in com.parse | +
---|
+ +
Methods in com.parse that return ParseQuery | +||
---|---|---|
+ ParseQuery<T> |
+ParseQuery.addAscendingOrder(String key)
+
++ Also sorts the results in ascending order by the given key. |
+|
+ ParseQuery<T> |
+ParseQuery.addDescendingOrder(String key)
+
++ Also sorts the results in descending order by the given key. |
+|
+ ParseQuery<T> |
+ParseQueryAdapter.QueryFactory.create()
+
++ |
+|
+static ParseQuery<ParseUser> |
+ParseUser.getQuery()
+
++ Constructs a query for ParseUsers. |
+|
+static ParseQuery<ParseRole> |
+ParseRole.getQuery()
+
++ Gets a ParseQuery over the Role collection. |
+|
+ ParseQuery<T> |
+ParseRelation.getQuery()
+
++ Gets a query that can be used to query the objects in this relation. |
+|
+static ParseQuery<ParseInstallation> |
+ParseInstallation.getQuery()
+
++ Constructs a query for ParseInstallations. |
+|
+static
+ |
+ParseQuery.getQuery(Class<T> subclass)
+
++ Creates a new query for the given ParseObject subclass type. |
+|
+static
+ |
+ParseQuery.getQuery(String className)
+
++ Creates a new query for the given class name. |
+|
+static ParseQuery<ParseUser> |
+ParseQuery.getUserQuery()
+
++ Deprecated. Please use ParseUser.getQuery() instead. |
+|
+static
+ |
+ParseQuery.or(List<ParseQuery<T>> queries)
+
++ Constructs a query that is the or of the given queries. |
+|
+ ParseQuery<T> |
+ParseQuery.orderByAscending(String key)
+
++ Sorts the results in ascending order by the given key. |
+|
+ ParseQuery<T> |
+ParseQuery.orderByDescending(String key)
+
++ Sorts the results in descending order by the given key. |
+|
+ ParseQuery<T> |
+ParseQuery.whereContainedIn(String key,
+ Collection<? extends Object> values)
+
++ Add a constraint to the query that requires a particular key's value to be contained in the + provided list of values. |
+|
+ ParseQuery<T> |
+ParseQuery.whereContains(String key,
+ String substring)
+
++ Add a constraint for finding string values that contain a provided string. |
+|
+ ParseQuery<T> |
+ParseQuery.whereContainsAll(String key,
+ Collection<?> values)
+
++ Add a constraint to the query that requires a particular key's value match another ParseQuery. |
+|
+ ParseQuery<T> |
+ParseQuery.whereDoesNotExist(String key)
+
++ Add a constraint for finding objects that do not contain a given key. |
+|
+ ParseQuery<T> |
+ParseQuery.whereDoesNotMatchKeyInQuery(String key,
+ String keyInQuery,
+ ParseQuery<?> query)
+
++ Add a constraint to the query that requires a particular key's value does not match any value + for a key in the results of another ParseQuery. |
+|
+ ParseQuery<T> |
+ParseQuery.whereDoesNotMatchQuery(String key,
+ ParseQuery<?> query)
+
++ Add a constraint to the query that requires a particular key's value does not match another + ParseQuery. |
+|
+ ParseQuery<T> |
+ParseQuery.whereEndsWith(String key,
+ String suffix)
+
++ Add a constraint for finding string values that end with a provided string. |
+|
+ ParseQuery<T> |
+ParseQuery.whereEqualTo(String key,
+ Object value)
+
++ Add a constraint to the query that requires a particular key's value to be equal to the + provided value. |
+|
+ ParseQuery<T> |
+ParseQuery.whereExists(String key)
+
++ Add a constraint for finding objects that contain the given key. |
+|
+ ParseQuery<T> |
+ParseQuery.whereGreaterThan(String key,
+ Object value)
+
++ Add a constraint to the query that requires a particular key's value to be greater than the + provided value. |
+|
+ ParseQuery<T> |
+ParseQuery.whereGreaterThanOrEqualTo(String key,
+ Object value)
+
++ Add a constraint to the query that requires a particular key's value to be greater than or + equal to the provided value. |
+|
+ ParseQuery<T> |
+ParseQuery.whereLessThan(String key,
+ Object value)
+
++ Add a constraint to the query that requires a particular key's value to be less than the + provided value. |
+|
+ ParseQuery<T> |
+ParseQuery.whereLessThanOrEqualTo(String key,
+ Object value)
+
++ Add a constraint to the query that requires a particular key's value to be less than or equal + to the provided value. |
+|
+ ParseQuery<T> |
+ParseQuery.whereMatches(String key,
+ String regex)
+
++ Add a regular expression constraint for finding string values that match the provided regular + expression. |
+|
+ ParseQuery<T> |
+ParseQuery.whereMatches(String key,
+ String regex,
+ String modifiers)
+
++ Add a regular expression constraint for finding string values that match the provided regular + expression. |
+|
+ ParseQuery<T> |
+ParseQuery.whereMatchesKeyInQuery(String key,
+ String keyInQuery,
+ ParseQuery<?> query)
+
++ Add a constraint to the query that requires a particular key's value matches a value for a key + in the results of another ParseQuery |
+|
+ ParseQuery<T> |
+ParseQuery.whereMatchesQuery(String key,
+ ParseQuery<?> query)
+
++ Add a constraint to the query that requires a particular key's value match another ParseQuery. |
+|
+ ParseQuery<T> |
+ParseQuery.whereNear(String key,
+ ParseGeoPoint point)
+
++ Add a proximity based constraint for finding objects with key point values near the point + given. |
+|
+ ParseQuery<T> |
+ParseQuery.whereNotContainedIn(String key,
+ Collection<? extends Object> values)
+
++ Add a constraint to the query that requires a particular key's value not be contained in the + provided list of values. |
+|
+ ParseQuery<T> |
+ParseQuery.whereNotEqualTo(String key,
+ Object value)
+
++ Add a constraint to the query that requires a particular key's value to be not equal to the + provided value. |
+|
+ ParseQuery<T> |
+ParseQuery.whereStartsWith(String key,
+ String prefix)
+
++ Add a constraint for finding string values that start with a provided string. |
+|
+ ParseQuery<T> |
+ParseQuery.whereWithinGeoBox(String key,
+ ParseGeoPoint southwest,
+ ParseGeoPoint northeast)
+
++ Add a constraint to the query that requires a particular key's coordinates be contained within + a given rectangular geographic bounding box. |
+|
+ ParseQuery<T> |
+ParseQuery.whereWithinKilometers(String key,
+ ParseGeoPoint point,
+ double maxDistance)
+
++ Add a proximity based constraint for finding objects with key point values near the point given + and within the maximum distance given. |
+|
+ ParseQuery<T> |
+ParseQuery.whereWithinMiles(String key,
+ ParseGeoPoint point,
+ double maxDistance)
+
++ Add a proximity based constraint for finding objects with key point values near the point given + and within the maximum distance given. |
+|
+ ParseQuery<T> |
+ParseQuery.whereWithinRadians(String key,
+ ParseGeoPoint point,
+ double maxDistance)
+
++ Add a proximity based constraint for finding objects with key point values near the point given + and within the maximum distance given. |
+
+ +
Methods in com.parse with parameters of type ParseQuery | +|
---|---|
+static void |
+ParsePush.sendDataInBackground(JSONObject data,
+ ParseQuery<ParseInstallation> query)
+
++ A helper method to concisely send a push to a query. |
+
+static void |
+ParsePush.sendDataInBackground(JSONObject data,
+ ParseQuery<ParseInstallation> query,
+ SendCallback callback)
+
++ A helper method to concisely send a push to a query. |
+
+static void |
+ParsePush.sendMessageInBackground(String message,
+ ParseQuery<ParseInstallation> query)
+
++ A helper method to concisely send a push message to a query. |
+
+static void |
+ParsePush.sendMessageInBackground(String message,
+ ParseQuery<ParseInstallation> query,
+ SendCallback callback)
+
++ A helper method to concisely send a push message to a query. |
+
+protected void |
+ParseQueryAdapter.setPageOnQuery(int page,
+ ParseQuery<T> query)
+
++ Override this method to manually paginate the provided ParseQuery . |
+
+ void |
+ParsePush.setQuery(ParseQuery<ParseInstallation> query)
+
++ Sets the query for this push for which this push notification will be sent. |
+
+ ParseQuery<T> |
+ParseQuery.whereDoesNotMatchKeyInQuery(String key,
+ String keyInQuery,
+ ParseQuery<?> query)
+
++ Add a constraint to the query that requires a particular key's value does not match any value + for a key in the results of another ParseQuery. |
+
+ ParseQuery<T> |
+ParseQuery.whereDoesNotMatchQuery(String key,
+ ParseQuery<?> query)
+
++ Add a constraint to the query that requires a particular key's value does not match another + ParseQuery. |
+
+ ParseQuery<T> |
+ParseQuery.whereMatchesKeyInQuery(String key,
+ String keyInQuery,
+ ParseQuery<?> query)
+
++ Add a constraint to the query that requires a particular key's value matches a value for a key + in the results of another ParseQuery |
+
+ ParseQuery<T> |
+ParseQuery.whereMatchesQuery(String key,
+ ParseQuery<?> query)
+
++ Add a constraint to the query that requires a particular key's value match another ParseQuery. |
+
+ +
Method parameters in com.parse with type arguments of type ParseQuery | +||
---|---|---|
+static
+ |
+ParseQuery.or(List<ParseQuery<T>> queries)
+
++ Constructs a query that is the or of the given queries. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of ParseQueryAdapter.OnQueryLoadListener in com.parse | +
---|
+ +
Methods in com.parse with parameters of type ParseQueryAdapter.OnQueryLoadListener | +|
---|---|
+ void |
+ParseQueryAdapter.addOnQueryLoadListener(ParseQueryAdapter.OnQueryLoadListener<T> listener)
+
++ |
+
+ void |
+ParseQueryAdapter.removeOnQueryLoadListener(ParseQueryAdapter.OnQueryLoadListener<T> listener)
+
++ |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of ParseQueryAdapter.QueryFactory in com.parse | +
---|
+ +
Constructors in com.parse with parameters of type ParseQueryAdapter.QueryFactory | +|
---|---|
ParseQueryAdapter(Context context,
+ ParseQueryAdapter.QueryFactory<T> queryFactory)
+
++ Constructs a ParseQueryAdapter. |
+|
ParseQueryAdapter(Context context,
+ ParseQueryAdapter.QueryFactory<T> queryFactory,
+ int itemViewResource)
+
++ Constructs a ParseQueryAdapter. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of ParseRelation in com.parse | +
---|
+ +
Methods in com.parse that return ParseRelation | +||
---|---|---|
+
+ |
+ParseObject.getRelation(String key)
+
++ Access or create a Relation value for a key |
+|
+ ParseRelation<ParseRole> |
+ParseRole.getRoles()
+
++ Gets the ParseRelation for the ParseRole s that are direct children of this
+ role. |
+|
+ ParseRelation<ParseUser> |
+ParseRole.getUsers()
+
++ Gets the ParseRelation for the ParseUser s that are direct children of this
+ role. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of ParseRole in com.parse | +
---|
+ +
Methods in com.parse that return types with arguments of type ParseRole | +|
---|---|
+static ParseQuery<ParseRole> |
+ParseRole.getQuery()
+
++ Gets a ParseQuery over the Role collection. |
+
+ ParseRelation<ParseRole> |
+ParseRole.getRoles()
+
++ Gets the ParseRelation for the ParseRole s that are direct children of this
+ role. |
+
+ +
Methods in com.parse with parameters of type ParseRole | +|
---|---|
+ boolean |
+ParseACL.getRoleReadAccess(ParseRole role)
+
++ Get whether users belonging to the given role are allowed to read this object. |
+
+ boolean |
+ParseACL.getRoleWriteAccess(ParseRole role)
+
++ Get whether users belonging to the given role are allowed to write this object. |
+
+ void |
+ParseACL.setRoleReadAccess(ParseRole role,
+ boolean allowed)
+
++ Set whether users belonging to the given role are allowed to read this object. |
+
+ void |
+ParseACL.setRoleWriteAccess(ParseRole role,
+ boolean allowed)
+
++ Set whether users belonging to the given role are allowed to write this object. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of ParseUser in com.parse | +
---|
+ +
Methods in com.parse that return ParseUser | +|
---|---|
+static ParseUser |
+ParseUser.become(String sessionToken)
+
++ Authorize a user with a session token. |
+
+ ParseUser |
+ParseUser.fetch()
+
++ |
+
+ ParseUser |
+ParseUser.fetchIfNeeded()
+
++ |
+
+static ParseUser |
+ParseUser.getCurrentUser()
+
++ This retrieves the currently logged in ParseUser with a valid session, either from memory or + disk if necessary. |
+
+ ParseUser |
+ParseObject.getParseUser(String key)
+
++ Access a ParseUser value. |
+
+static ParseUser |
+ParseUser.logIn(String username,
+ String password)
+
++ Logs in a user with a username and password. |
+
+ +
Methods in com.parse that return types with arguments of type ParseUser | +|
---|---|
+static ParseQuery<ParseUser> |
+ParseUser.getQuery()
+
++ Constructs a query for ParseUsers. |
+
+static ParseQuery<ParseUser> |
+ParseQuery.getUserQuery()
+
++ Deprecated. Please use ParseUser.getQuery() instead. |
+
+ ParseRelation<ParseUser> |
+ParseRole.getUsers()
+
++ Gets the ParseRelation for the ParseUser s that are direct children of this
+ role. |
+
+ +
Methods in com.parse with parameters of type ParseUser | +|
---|---|
+abstract void |
+LogInCallback.done(ParseUser user,
+ ParseException e)
+
++ Override this function with the code you want to run after the save is complete. |
+
+static void |
+ParseFacebookUtils.extendAccessToken(ParseUser user,
+ Context context,
+ SaveCallback callback)
+
++ Deprecated. |
+
+static boolean |
+ParseFacebookUtils.extendAccessTokenIfNeeded(ParseUser user,
+ Context context,
+ SaveCallback callback)
+
++ Deprecated. |
+
+ boolean |
+ParseACL.getReadAccess(ParseUser user)
+
++ Get whether the given user id is *explicitly* allowed to read this object. |
+
+ boolean |
+ParseACL.getWriteAccess(ParseUser user)
+
++ Get whether the given user id is *explicitly* allowed to write this object. |
+
+static boolean |
+ParseTwitterUtils.isLinked(ParseUser user)
+
++ Returns true if the user is linked to a Twitter account. |
+
+static boolean |
+ParseFacebookUtils.isLinked(ParseUser user)
+
++ Returns true if the user is linked to a Facebook account. |
+
+static boolean |
+ParseAnonymousUtils.isLinked(ParseUser user)
+
++ Whether the user is logged in anonymously. |
+
+static void |
+ParseFacebookUtils.link(ParseUser user,
+ Activity activity)
+
++ |
+
+static void |
+ParseFacebookUtils.link(ParseUser user,
+ Activity activity,
+ int activityCode)
+
++ |
+
+static void |
+ParseFacebookUtils.link(ParseUser user,
+ Activity activity,
+ int activityCode,
+ SaveCallback callback)
+
++ |
+
+static void |
+ParseFacebookUtils.link(ParseUser user,
+ Activity activity,
+ SaveCallback callback)
+
++ |
+
+static void |
+ParseFacebookUtils.link(ParseUser user,
+ Collection<String> permissions,
+ Activity activity)
+
++ |
+
+static void |
+ParseFacebookUtils.link(ParseUser user,
+ Collection<String> permissions,
+ Activity activity,
+ int activityCode)
+
++ |
+
+static void |
+ParseFacebookUtils.link(ParseUser user,
+ Collection<String> permissions,
+ Activity activity,
+ int activityCode,
+ SaveCallback callback)
+
++ Links a ParseUser to a Facebook account, allowing you to use Facebook for authentication, and + providing access to Facebook data for the user. |
+
+static void |
+ParseFacebookUtils.link(ParseUser user,
+ Collection<String> permissions,
+ Activity activity,
+ SaveCallback callback)
+
++ Links a user using the default activity code if single sign-on is enabled. |
+
+static void |
+ParseTwitterUtils.link(ParseUser user,
+ Context context)
+
++ |
+
+static void |
+ParseTwitterUtils.link(ParseUser user,
+ Context context,
+ SaveCallback callback)
+
++ Links a ParseUser to a Twitter account, allowing you to use Twitter for authentication, and + providing access to Twitter data for the user. |
+
+static void |
+ParseFacebookUtils.link(ParseUser user,
+ String facebookId,
+ String accessToken,
+ Date expirationDate)
+
++ |
+
+static void |
+ParseFacebookUtils.link(ParseUser user,
+ String facebookId,
+ String accessToken,
+ Date expirationDate,
+ SaveCallback callback)
+
++ Links a ParseUser to a Facebook account, allowing you to use Facebook for authentication, and + providing access to Facebook data for the user. |
+
+static void |
+ParseTwitterUtils.link(ParseUser user,
+ String twitterId,
+ String screenName,
+ String authToken,
+ String authTokenSecret)
+
++ |
+
+static void |
+ParseTwitterUtils.link(ParseUser user,
+ String twitterId,
+ String screenName,
+ String authToken,
+ String authTokenSecret,
+ SaveCallback callback)
+
++ Links a ParseUser to a Twitter account, allowing you to use Twitter for authentication, and + providing access to Twitter data for the user. |
+
+static void |
+ParseFacebookUtils.saveLatestSessionData(ParseUser user)
+
++ |
+
+static void |
+ParseFacebookUtils.saveLatestSessionData(ParseUser user,
+ SaveCallback callback)
+
++ Saves the latest session data to the user. |
+
+ void |
+ParseACL.setReadAccess(ParseUser user,
+ boolean allowed)
+
++ Set whether the given user is allowed to read this object. |
+
+ void |
+ParseACL.setWriteAccess(ParseUser user,
+ boolean allowed)
+
++ Set whether the given user is allowed to write this object. |
+
+static boolean |
+ParseFacebookUtils.shouldExtendAccessToken(ParseUser user)
+
++ Deprecated. |
+
+static void |
+ParseTwitterUtils.unlink(ParseUser user)
+
++ Unlinks a user from a Twitter account. |
+
+static void |
+ParseFacebookUtils.unlink(ParseUser user)
+
++ Unlinks a user from a Facebook account. |
+
+static void |
+ParseTwitterUtils.unlinkInBackground(ParseUser user)
+
++ |
+
+static void |
+ParseFacebookUtils.unlinkInBackground(ParseUser user)
+
++ |
+
+static void |
+ParseTwitterUtils.unlinkInBackground(ParseUser user,
+ SaveCallback callback)
+
++ Unlinks a user from a Twitter account in the background. |
+
+static void |
+ParseFacebookUtils.unlinkInBackground(ParseUser user,
+ SaveCallback callback)
+
++ Unlinks a user from a Facebook account in the background. |
+
+ +
Constructors in com.parse with parameters of type ParseUser | +|
---|---|
ParseACL(ParseUser owner)
+
++ Creates an ACL where only the provided user has access. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of ProgressCallback in com.parse | +
---|
+ +
Methods in com.parse with parameters of type ProgressCallback | +|
---|---|
+ void |
+ParseFile.getDataInBackground(GetDataCallback dataCallback,
+ ProgressCallback progressCallback)
+
++ Gets the data for this object in a background thread. |
+
+ void |
+ParseFile.saveInBackground(SaveCallback saveCallback,
+ ProgressCallback progressCallback)
+
++ Saves the file to the Parse cloud in a background thread. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of RefreshCallback in com.parse | +
---|
+ +
Methods in com.parse with parameters of type RefreshCallback | +|
---|---|
+ void |
+ParseObject.refreshInBackground(RefreshCallback callback)
+
++ Refreshes this object with the data from the server in a background thread. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of RequestPasswordResetCallback in com.parse | +
---|
+ +
Methods in com.parse with parameters of type RequestPasswordResetCallback | +|
---|---|
+static void |
+ParseUser.requestPasswordResetInBackground(String email,
+ RequestPasswordResetCallback callback)
+
++ Requests a password reset email to be sent in a background thread to the specified email + address associated with the user account. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of SaveCallback in com.parse | +
---|
+ +
Methods in com.parse with parameters of type SaveCallback | +|
---|---|
+static void |
+ParseFacebookUtils.extendAccessToken(ParseUser user,
+ Context context,
+ SaveCallback callback)
+
++ Deprecated. |
+
+static boolean |
+ParseFacebookUtils.extendAccessTokenIfNeeded(ParseUser user,
+ Context context,
+ SaveCallback callback)
+
++ Deprecated. |
+
+static void |
+ParseFacebookUtils.link(ParseUser user,
+ Activity activity,
+ int activityCode,
+ SaveCallback callback)
+
++ |
+
+static void |
+ParseFacebookUtils.link(ParseUser user,
+ Activity activity,
+ SaveCallback callback)
+
++ |
+
+static void |
+ParseFacebookUtils.link(ParseUser user,
+ Collection<String> permissions,
+ Activity activity,
+ int activityCode,
+ SaveCallback callback)
+
++ Links a ParseUser to a Facebook account, allowing you to use Facebook for authentication, and + providing access to Facebook data for the user. |
+
+static void |
+ParseFacebookUtils.link(ParseUser user,
+ Collection<String> permissions,
+ Activity activity,
+ SaveCallback callback)
+
++ Links a user using the default activity code if single sign-on is enabled. |
+
+static void |
+ParseTwitterUtils.link(ParseUser user,
+ Context context,
+ SaveCallback callback)
+
++ Links a ParseUser to a Twitter account, allowing you to use Twitter for authentication, and + providing access to Twitter data for the user. |
+
+static void |
+ParseFacebookUtils.link(ParseUser user,
+ String facebookId,
+ String accessToken,
+ Date expirationDate,
+ SaveCallback callback)
+
++ Links a ParseUser to a Facebook account, allowing you to use Facebook for authentication, and + providing access to Facebook data for the user. |
+
+static void |
+ParseTwitterUtils.link(ParseUser user,
+ String twitterId,
+ String screenName,
+ String authToken,
+ String authTokenSecret,
+ SaveCallback callback)
+
++ Links a ParseUser to a Twitter account, allowing you to use Twitter for authentication, and + providing access to Twitter data for the user. |
+
+static void |
+ParseObject.saveAllInBackground(List<ParseObject> objects,
+ SaveCallback callback)
+
++ Saves each object in the provided list to the server in a background thread. |
+
+ void |
+ParseObject.saveEventually(SaveCallback callback)
+
++ Saves this object to the server at some unspecified time in the future, even if Parse is + currently inaccessible. |
+
+ void |
+ParseInstallation.saveEventually(SaveCallback callback)
+
++ |
+
+ void |
+ParseObject.saveInBackground(SaveCallback callback)
+
++ Saves this object to the server in a background thread. |
+
+ void |
+ParseFile.saveInBackground(SaveCallback callback)
+
++ Saves the file to the Parse cloud in a background thread. |
+
+ void |
+ParseFile.saveInBackground(SaveCallback saveCallback,
+ ProgressCallback progressCallback)
+
++ Saves the file to the Parse cloud in a background thread. |
+
+static void |
+ParseFacebookUtils.saveLatestSessionData(ParseUser user,
+ SaveCallback callback)
+
++ Saves the latest session data to the user. |
+
+static void |
+ParseTwitterUtils.unlinkInBackground(ParseUser user,
+ SaveCallback callback)
+
++ Unlinks a user from a Twitter account in the background. |
+
+static void |
+ParseFacebookUtils.unlinkInBackground(ParseUser user,
+ SaveCallback callback)
+
++ Unlinks a user from a Facebook account in the background. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of SendCallback in com.parse | +
---|
+ +
Methods in com.parse with parameters of type SendCallback | +|
---|---|
+static void |
+ParsePush.sendDataInBackground(JSONObject data,
+ ParseQuery<ParseInstallation> query,
+ SendCallback callback)
+
++ A helper method to concisely send a push to a query. |
+
+ void |
+ParsePush.sendInBackground(SendCallback callback)
+
++ Sends this push notification in a background thread. |
+
+static void |
+ParsePush.sendMessageInBackground(String message,
+ ParseQuery<ParseInstallation> query,
+ SendCallback callback)
+
++ A helper method to concisely send a push message to a query. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of SignUpCallback in com.parse | +
---|
+ +
Methods in com.parse with parameters of type SignUpCallback | +|
---|---|
+ void |
+ParseUser.signUpInBackground(SignUpCallback callback)
+
++ Signs up a new user. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Interfaces
+
+ +ParseQueryAdapter.OnQueryLoadListener + +ParseQueryAdapter.QueryFactory |
+
+Classes
+
+ +CountCallback + +DeleteCallback + +FindCallback + +FunctionCallback + +GetCallback + +GetDataCallback + +LocationCallback + +LogInCallback + +Parse + +ParseACL + +ParseAnalytics + +ParseAnonymousUtils + +ParseCloud + +ParseFacebookUtils + +ParseFile + +ParseGeoPoint + +ParseImageView + +ParseInstallation + +ParseObject + +ParsePush + +ParseQuery + +ParseQueryAdapter + +ParseRelation + +ParseRole + +ParseTwitterUtils + +ParseUser + +ProgressCallback + +PushService + +RefreshCallback + +RequestPasswordResetCallback + +SaveCallback + +SendCallback + +SignUpCallback |
+
+Enums
+
+ +ParseQuery.CachePolicy |
+
+Exceptions
+
+ +ParseException |
+
+Annotation Types
+
+ +ParseClassName |
+
+
+
|
++ + | +||||||||
+ PREV PACKAGE + NEXT PACKAGE | ++ FRAMES + NO FRAMES + + + + + | +
+Interface Summary | +|
---|---|
ParseQueryAdapter.OnQueryLoadListener<T extends ParseObject> | +Implement with logic that is called before and after objects are fetched from Parse by the + adapter. | +
ParseQueryAdapter.QueryFactory<T extends ParseObject> | +Implement to construct your own custom ParseQuery for fetching objects. |
+
+ +
+Class Summary | +|
---|---|
CountCallback | +A CountCallback is used to run code after a ParseQuery is used to count objects matching
+ a query in a background thread. |
+
DeleteCallback | +A DeleteCallback is used to run code after saving a ParseObject in a background thread. |
+
FindCallback<T extends ParseObject> | +A FindCallback is used to run code after a ParseQuery is used to fetch a list of
+ ParseObject s in a background thread. |
+
FunctionCallback<T> | +A FunctionCallback is used to run code after ParseCloud.callFunction(java.lang.String, java.util.Map is used to run a
+ Cloud Function in a background thread. |
+
GetCallback<T extends ParseObject> | +A GetCallback is used to run code after a ParseQuery is used to fetch a
+ ParseObject in a background thread. |
+
GetDataCallback | +A GetDataCallback is used to run code after a ParseFile fetches its data on a background
+ thread. |
+
LocationCallback | +A LocationCallback is used to run code after a Location has been fetched by some + LocationProvider. | +
LogInCallback | +A LogInCallback is used to run code after logging in a user. | +
Parse | +The Parse class contains static functions that handle global configuration for the Parse library. | +
ParseACL | +A ParseACL is used to control which users can access or modify a particular object. | +
ParseAnalytics | +The ParseAnalytics class provides an interface to Parse's logging and analytics backend. | +
ParseAnonymousUtils | +Provides utility functions for working with Anonymously logged-in users. | +
ParseCloud | +The ParseCloud class defines provides methods for interacting with Parse Cloud Functions. | +
ParseFacebookUtils | +Provides a set of utilities for using Parse with Facebook. | +
ParseFile | +ParseFile is a local representation of a file that is saved to the Parse cloud. | +
ParseGeoPoint | +ParseGeoPoint represents a latitude / longitude point that may be associated with a key in a + ParseObject or used as a reference point for geo queries. | +
ParseImageView | +A specialized ImageView that downloads and displays remote images stored on Parse's
+ servers. |
+
ParseInstallation | ++ |
ParseObject | +The ParseObject is a local representation of data that can be saved and retrieved from the Parse + cloud. | +
ParsePush | +The ParsePush is a local representation of data that can be sent as a push notification. | +
ParseQuery<T extends ParseObject> | +The ParseQuery class defines a query that is used to fetch ParseObjects. | +
ParseQueryAdapter<T extends ParseObject> | +A ParseQueryAdapter handles the fetching of objects by page, and displaying objects as views in a + ListView. | +
ParseRelation<T extends ParseObject> | +A class that is used to access all of the children of a many-to-many relationship. | +
ParseRole | +Represents a Role on the Parse server. | +
ParseTwitterUtils | ++ |
ParseUser | ++ |
ProgressCallback | +A ProgressCallback is used to get progress of an operation. | +
PushService | +A service to listen for push notifications. | +
RefreshCallback | +A RefreshCallback is used to run code after refresh is used to update a ParseObject in a
+ background thread. |
+
RequestPasswordResetCallback | +A RequestPasswordResetCallback is used to run code requesting a password reset for a user. | +
SaveCallback | +A SaveCallback is used to run code after saving a ParseObject in a background thread. |
+
SendCallback | +A SendCallback is used to run code after sending a ParsePush in a background thread. |
+
SignUpCallback | +A SignUpCallback is used to run code after signing up a ParseUser in a background thread. |
+
+ +
+Enum Summary | +|
---|---|
ParseQuery.CachePolicy | ++ |
+ +
+Exception Summary | +|
---|---|
ParseException | +A ParseException gets raised whenever a ParseObject issues an invalid request, such as
+ deleting or editing an object that no longer exists on the server, or when there is a network
+ failure preventing communication with the Parse server. |
+
+ +
+Annotation Types Summary | +|
---|---|
ParseClassName | +Associates a class name for a subclass of ParseObject. | +
+
+
+
|
++ + | +||||||||
+ PREV PACKAGE + NEXT PACKAGE | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Classes in com.parse used by com.parse | +|
---|---|
CountCallback
+
+ + A CountCallback is used to run code after a ParseQuery is used to count objects matching
+ a query in a background thread. |
+|
DeleteCallback
+
+ + A DeleteCallback is used to run code after saving a ParseObject in a background thread. |
+|
FindCallback
+
+ + A FindCallback is used to run code after a ParseQuery is used to fetch a list of
+ ParseObject s in a background thread. |
+|
FunctionCallback
+
+ + A FunctionCallback is used to run code after ParseCloud.callFunction(java.lang.String, java.util.Map is used to run a
+ Cloud Function in a background thread. |
+|
GetCallback
+
+ + A GetCallback is used to run code after a ParseQuery is used to fetch a
+ ParseObject in a background thread. |
+|
GetDataCallback
+
+ + A GetDataCallback is used to run code after a ParseFile fetches its data on a background
+ thread. |
+|
LocationCallback
+
+ + A LocationCallback is used to run code after a Location has been fetched by some + LocationProvider. |
+|
LogInCallback
+
+ + A LogInCallback is used to run code after logging in a user. |
+|
ParseACL
+
+ + A ParseACL is used to control which users can access or modify a particular object. |
+|
ParseClassName
+
+ + Associates a class name for a subclass of ParseObject. |
+|
ParseException
+
+ + A ParseException gets raised whenever a ParseObject issues an invalid request, such as
+ deleting or editing an object that no longer exists on the server, or when there is a network
+ failure preventing communication with the Parse server. |
+|
ParseFile
+
+ + ParseFile is a local representation of a file that is saved to the Parse cloud. |
+|
ParseGeoPoint
+
+ + ParseGeoPoint represents a latitude / longitude point that may be associated with a key in a + ParseObject or used as a reference point for geo queries. |
+|
ParseInstallation
+
+ + |
+|
ParseObject
+
+ + The ParseObject is a local representation of data that can be saved and retrieved from the Parse + cloud. |
+|
ParseQuery
+
+ + The ParseQuery class defines a query that is used to fetch ParseObjects. |
+|
ParseQuery.CachePolicy
+
+ + |
+|
ParseQueryAdapter.OnQueryLoadListener
+
+ + Implement with logic that is called before and after objects are fetched from Parse by the + adapter. |
+|
ParseQueryAdapter.QueryFactory
+
+ + Implement to construct your own custom ParseQuery for fetching objects. |
+|
ParseRelation
+
+ + A class that is used to access all of the children of a many-to-many relationship. |
+|
ParseRole
+
+ + Represents a Role on the Parse server. |
+|
ParseUser
+
+ + |
+|
ProgressCallback
+
+ + A ProgressCallback is used to get progress of an operation. |
+|
RefreshCallback
+
+ + A RefreshCallback is used to run code after refresh is used to update a ParseObject in a
+ background thread. |
+|
RequestPasswordResetCallback
+
+ + A RequestPasswordResetCallback is used to run code requesting a password reset for a user. |
+|
SaveCallback
+
+ + A SaveCallback is used to run code after saving a ParseObject in a background thread. |
+|
SendCallback
+
+ + A SendCallback is used to run code after sending a ParsePush in a background thread. |
+|
SignUpCallback
+
+ + A SignUpCallback is used to run code after signing up a ParseUser in a background thread. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+com.parse.* | +
---|
+ +
com.parse.Parse | +||
---|---|---|
+public static final int |
+LOG_LEVEL_DEBUG |
+3 |
+
+public static final int |
+LOG_LEVEL_ERROR |
+6 |
+
+public static final int |
+LOG_LEVEL_INFO |
+4 |
+
+public static final int |
+LOG_LEVEL_NONE |
+2147483647 |
+
+public static final int |
+LOG_LEVEL_VERBOSE |
+2 |
+
+public static final int |
+LOG_LEVEL_WARNING |
+5 |
+
+ +
+ +
com.parse.ParseException | +||
---|---|---|
+public static final int |
+ACCOUNT_ALREADY_LINKED |
+208 |
+
+public static final int |
+CACHE_MISS |
+120 |
+
+public static final int |
+COMMAND_UNAVAILABLE |
+108 |
+
+public static final int |
+CONNECTION_FAILED |
+100 |
+
+public static final int |
+DUPLICATE_VALUE |
+137 |
+
+public static final int |
+EMAIL_MISSING |
+204 |
+
+public static final int |
+EMAIL_NOT_FOUND |
+205 |
+
+public static final int |
+EMAIL_TAKEN |
+203 |
+
+public static final int |
+EXCEEDED_QUOTA |
+140 |
+
+public static final int |
+FILE_DELETE_ERROR |
+153 |
+
+public static final int |
+INCORRECT_TYPE |
+111 |
+
+public static final int |
+INTERNAL_SERVER_ERROR |
+1 |
+
+public static final int |
+INVALID_ACL |
+123 |
+
+public static final int |
+INVALID_CHANNEL_NAME |
+112 |
+
+public static final int |
+INVALID_CLASS_NAME |
+103 |
+
+public static final int |
+INVALID_EMAIL_ADDRESS |
+125 |
+
+public static final int |
+INVALID_FILE_NAME |
+122 |
+
+public static final int |
+INVALID_JSON |
+107 |
+
+public static final int |
+INVALID_KEY_NAME |
+105 |
+
+public static final int |
+INVALID_LINKED_SESSION |
+251 |
+
+public static final int |
+INVALID_NESTED_KEY |
+121 |
+
+public static final int |
+INVALID_POINTER |
+106 |
+
+public static final int |
+INVALID_QUERY |
+102 |
+
+public static final int |
+INVALID_ROLE_NAME |
+139 |
+
+public static final int |
+LINKED_ID_MISSING |
+250 |
+
+public static final int |
+MISSING_OBJECT_ID |
+104 |
+
+public static final int |
+MUST_CREATE_USER_THROUGH_SIGNUP |
+207 |
+
+public static final int |
+NOT_INITIALIZED |
+109 |
+
+public static final int |
+OBJECT_NOT_FOUND |
+101 |
+
+public static final int |
+OBJECT_TOO_LARGE |
+116 |
+
+public static final int |
+OPERATION_FORBIDDEN |
+119 |
+
+public static final int |
+OTHER_CAUSE |
+-1 |
+
+public static final int |
+PASSWORD_MISSING |
+201 |
+
+public static final int |
+PUSH_MISCONFIGURED |
+115 |
+
+public static final int |
+SCRIPT_ERROR |
+141 |
+
+public static final int |
+SESSION_MISSING |
+206 |
+
+public static final int |
+TIMEOUT |
+124 |
+
+public static final int |
+UNSUPPORTED_SERVICE |
+252 |
+
+public static final int |
+USERNAME_MISSING |
+200 |
+
+public static final int |
+USERNAME_TAKEN |
+202 |
+
+public static final int |
+VALIDATION_ERROR |
+142 |
+
+ +
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Deprecated Methods | +|
---|---|
com.parse.ParseFacebookUtils.extendAccessToken(ParseUser, Context, SaveCallback)
+ + |
+|
com.parse.ParseFacebookUtils.extendAccessTokenIfNeeded(ParseUser, Context, SaveCallback)
+ + |
+|
com.parse.ParseFacebookUtils.getFacebook()
+ + |
+|
com.parse.ParseQuery.getUserQuery()
+ + Please use ParseUser.getQuery() instead. |
+|
com.parse.ParsePush.setPushToAndroid(boolean)
+ + |
+|
com.parse.ParsePush.setPushToIOS(boolean)
+ + |
+|
com.parse.ParseFacebookUtils.shouldExtendAccessToken(ParseUser)
+ + |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+ +++Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:
+
+- Interfaces (italic)
- Classes
- Enums
- Exceptions
- Errors
- Annotation Types
+ ++ ++Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.- Class inheritance diagram
- Direct Subclasses
- All Known Subinterfaces
- All Known Implementing Classes
- Class/interface declaration
- Class/interface description +
+
- Nested Class Summary
- Field Summary
- Constructor Summary
- Method Summary +
+
- Field Detail
- Constructor Detail
- Method Detail
+ ++ ++Each annotation type has its own separate page with the following sections:
+
+- Annotation Type declaration
- Annotation Type description
- Required Element Summary
- Optional Element Summary
- Element Detail
+ +++Each enum has its own separate page with the following sections:
+
+- Enum declaration
- Enum description
- Enum Constant Summary
- Enum Constant Detail
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.+
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with+java.lang.Object
. The interfaces do not inherit fromjava.lang.Object
.+
+- When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
- When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.+
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.+
+
+
+
+
+This help file applies to API documentation generated using the standard doclet.
+
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
Collection
to the end of the array
+ associated with a given key.
+Collection
to the array associated with a
+ given key, only adding elements which are not already present in the array.
+ParseQuery
is used to count objects matching
+ a query in a background thread.ParseObject
in a background thread.ParseQuery
is used to fetch a list of
+ ParseObject
s in a background thread.ParseCloud.callFunction(java.lang.String, java.util.Map)
is used to run a
+ Cloud Function in a background thread.ParseQuery
is used to fetch a
+ ParseObject
in a background thread.Activity
utilizing this ParseQueryAdapter
.
+Adapter
's ParseQueryAdapter.getCount()
method to return the number of cells to
+ display.
+ParseFile
fetches its data on a background
+ thread.ParseObject
.
+ParseQuery
over the Role collection.
+ParseRelation
for the ParseRole
s that are direct children of this
+ role.
+Twitter
singleton that Parse is using.
+ParseUser.getQuery()
instead.
+ParseRelation
for the ParseUser
s that are direct children of this
+ role.
+Adapter
, defines a getView
method intended to display data at
+ the specified position in the data set.
+true
if the user is linked to a Facebook account.
+true
if the user is linked to a Twitter account.
+ParseUser
was created during this session through a call to
+ ParseUser.signUp()
or by logging in with a linked service such as Facebook.
+ParseObject
issues an invalid request, such as
+ deleting or editing an object that no longer exists on the server, or when there is a network
+ failure preventing communication with the Parse server.ImageView
that downloads and displays remote images stored on Parse's
+ servers.ParseImageView
from code.
+ParseImageView
from XML.
+ParseQuery
for fetching objects.ParseObject
in a
+ background thread.Collection
from the
+ array associated with a given key.
+ParseObject
in a background thread.ParsePush
in a background thread.AdapterView
.
+ParseObject
s when they are created.
+ParseQuery
.
+AdapterView
+ .
+ParseUser
in a background thread.
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Package com.parse | +
---|
+Class com.parse.ParseException extends Exception implements Serializable | +
---|
+serialVersionUID: 1L + +
+Serialized Fields | +
---|
+int code+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +