parse_server_sdk 1.0.17 copy "parse_server_sdk: ^1.0.17" to clipboard
parse_server_sdk: ^1.0.17 copied to clipboard

outdated

Flutter plugin for Parse Server, (https://parseplatform.org), (https://back4app.com)

enter image description here enter image description here

Parse For Flutter! #

Hi, this is a Flutter plugin that allows communication with a Parse Server, (https://parseplatform.org) either hosted on your own server or another, like (http://Back4App.com).

This is a work in project and we are consistently updating it. Please let us know if you think anything needs changing/adding, and more than ever, please do join in on this project (Even if it is just to improve our documentation.

Join in! #

Want to get involved? Join our Slack channel and help out! (http://flutter-parse-sdk.slack.com)

Getting Started #

To install, either add to your pubspec.yaml

dependencies:  
    parse_server_sdk: ^1.0.17

or clone this repository and add to your project. As this is an early development with multiple contributors, it is probably best to download/clone and keep updating as an when a new feature is added.

Once you have the library added to your project, upon first call to your app (Similar to what your application class would be) add the following...

Parse().initialize(
        ApplicationConstants.keyApplicationId,
        ApplicationConstants.keyParseServerUrl);

It's possible to add other params, such as ...

Parse().initialize(
        ApplicationConstants.keyApplicationId,
        ApplicationConstants.keyParseServerUrl,
        masterKey: ApplicationConstants.keyParseMasterKey,
        clientKey: ApplicationConstants.keyParseClientKey,
        debug: true,
        liveQueryUrl: ApplicationConstants.keyLiveQueryUrl,
        autoSendSessionId: true,
        securityContext: securityContext);

Objects #

You can create custom objects by calling:

var dietPlan = ParseObject('DietPlan')
	..set('Name', 'Ketogenic')
	..set('Fat', 65);

You then have the ability to do the following with that object: The features available are:-

  • Get
  • GetAll
  • Create
  • Save
  • Query - By object Id
  • Delete
  • Complex queries as shown above
  • Pin
  • Plenty more
  • Counters
  • Array Operators

Custom Objects #

You can create your own ParseObjects or convert your existing objects into Parse Objects by doing the following:

class DietPlan extends ParseObject implements ParseCloneable {

  DietPlan() : super(_keyTableName);
  DietPlan.clone(): this();

  /// Looks strangely hacky but due to Flutter not using reflection, we have to
  /// mimic a clone
  @override clone(Map map) => DietPlan.clone()..fromJson(map);

  static const String _keyTableName = 'Diet_Plans';
  static const String keyName = 'Name';
  
  String get name => get<String>(keyName);
  set name(String name) => set<String>(keyName, name);
}
  

Add new values to objects #

To add a variable to an object call and retrieve it, call

dietPlan.set<int>('RandomInt', 8);
var randomInt = dietPlan.get<int>('RandomInt');

Save objects using pins #

You can now save an object by calling .pin() on an instance of an object

dietPlan.pin();

and to retrieve it

var dietPlan = DietPlan().fromPin('OBJECT ID OF OBJECT');

Increment Counter values in objects #

Retrieve it, call

var response = await dietPlan.increment("count", 1);

Array Operator in objects #

Retrieve it, call

var response = await dietPlan.add("listKeywords", ["a", "a","d"]);

var response = await dietPlan.addUnique("listKeywords", ["a", "a","d"]);

var response = await dietPlan.remove("listKeywords", ["a"]);

Queries #

Once you have setup the project and initialised the instance, you can then retreive data from your server by calling:

var apiResponse = await ParseObject('ParseTableName').getAll();

    if (apiResponse.success){
      for (var testObject in apiResponse.result) {
        print(ApplicationConstants.APP_NAME + ": " + testObject.toString());
      }
    }

Or you can get an object by its objectId:

var dietPlan = await DietPlan().getObject('R5EonpUDWy');

    if (dietPlan.success) {
      print(ApplicationConstants.keyAppName + ": " + (dietPlan.result as DietPlan).toString());
    } else {
      print(ApplicationConstants.keyAppName + ": " + dietPlan.exception.message);
    }

Complex queries #

You can create complex queries to really put your database to the test:

    var queryBuilder = QueryBuilder<DietPlan>(DietPlan())
      ..startsWith(DietPlan.keyName, "Keto")
      ..greaterThan(DietPlan.keyFat, 64)
      ..lessThan(DietPlan.keyFat, 66)
      ..equals(DietPlan.keyCarbs, 5);

    var response = await queryBuilder.query();

    if (response.success) {
      print(ApplicationConstants.keyAppName + ": " + ((response.result as List<dynamic>).first as DietPlan).toString());
    } else {
      print(ApplicationConstants.keyAppName + ": " + response.exception.message);
    }

The features available are:-

  • Equals
  • Contains
  • LessThan
  • LessThanOrEqualTo
  • GreaterThan
  • GreaterThanOrEqualTo
  • NotEqualTo
  • StartsWith
  • EndsWith
  • Exists
  • Near
  • WithinMiles
  • WithinKilometers
  • WithinRadians
  • WithinGeoBox
  • Regex
  • Order
  • Limit
  • Skip
  • Ascending
  • Descending
  • Plenty more!

Relational queries #

If you want to retrieve objects where a field contains an object that matches another query, you can use the whereMatchesQuery condition. For example, imagine you have Post class and a Comment class, where each Comment has a pointer to its parent Post. You can find comments on posts with images by doing:

  QueryBuilder<ParseObject> queryPost =
      QueryBuilder<ParseObject>(ParseObject('Post'))
        ..whereValueExists('image', true);

  QueryBuilder<ParseObject> queryComment =
      QueryBuilder<ParseObject>(ParseObject('Comment'))
        ..whereMatchesQuery('post', queryPost);

  var apiResponse = await queryComment.query();

If you want to retrieve objects where a field contains an object that does not match another query, you can use the whereDoesNotMatchQuery condition. Imagine you have Post class and a Comment class, where each Comment has a pointer to its parent Post. You can find comments on posts without images by doing:

  QueryBuilder<ParseObject> queryPost =
      QueryBuilder<ParseObject>(ParseObject('Post'))
        ..whereValueExists('image', true);

  QueryBuilder<ParseObject> queryComment =
      QueryBuilder<ParseObject>(ParseObject('Comment'))
        ..whereDoesNotMatchQuery('post', queryPost);

  var apiResponse = await queryComment.query();

Counting Objects #

If you only care about the number of games played by a particular player:

  QueryBuilder<ParseObject> queryPlayers =
      QueryBuilder<ParseObject>(ParseObject('GameScore'))
        ..whereEqualTo('playerName', 'Jonathan Walsh');
  var apiResponse = await queryPlayers.count();
  if (apiResponse.success && apiResponse.result != null) {
    int countGames = apiResponse.count;
  }

Live Queries #

This tool allows you to subscribe to a QueryBuilder you are interested in. Once subscribed, the server will notify clients whenever a ParseObject that matches the QueryBuilder is created or updated, in real-time.

Parse LiveQuery contains two parts, the LiveQuery server and the LiveQuery clients. In order to use live queries, you need to set up both of them.

The Parse Server configuration guide on the server is found here https://docs.parseplatform.org/parse-server/guide/#live-queries and is not part of this documentation.

Initialize the Parse Live Query by entering the parameter liveQueryUrl in Parse().initialize:

  Parse().initialize(
        ApplicationConstants.keyApplicationId,
        ApplicationConstants.keyParseServerUrl,
        clientKey: ApplicationConstants.keyParseClientKey,
        debug: true,
        liveQueryUrl: ApplicationConstants.keyLiveQueryUrl,
        autoSendSessionId: true);

Declare LiveQuery:

  final LiveQuery liveQuery = LiveQuery();

Set the QueryBuilder that will be monitored by LiveQuery:

  QueryBuilder<ParseObject> query =
    QueryBuilder<ParseObject>(ParseObject('TestAPI'))
    ..whereEqualTo('intNumber', 1);

Create a subscription You’ll get the LiveQuery events through this subscription. The first time you call subscribe, we’ll try to open the WebSocket connection to the LiveQuery server for you.

  await liveQuery.subscribe(query);

Event Handling We define several types of events you’ll get through a subscription object:

Create event When a new ParseObject is created and it fulfills the QueryBuilder you subscribe, you’ll get this event. The object is the ParseObject which was created.

  liveQuery.on(LiveQueryEvent.create, (value) {
      print('*** CREATE ***: ${DateTime.now().toString()}\n $value ');
      print((value as ParseObject).objectId);
      print((value as ParseObject).updatedAt);
      print((value as ParseObject).createdAt);
      print((value as ParseObject).get('objectId'));
      print((value as ParseObject).get('updatedAt'));
      print((value as ParseObject).get('createdAt'));
    });

Update event When an existing ParseObject which fulfills the QueryBuilder you subscribe is updated (The ParseObject fulfills the QueryBuilder before and after changes), you’ll get this event. The object is the ParseObject which was updated. Its content is the latest value of the ParseObject.

  liveQuery.on(LiveQueryEvent.update, (value) {
      print('*** UPDATE ***: ${DateTime.now().toString()}\n $value ');
      print((value as ParseObject).objectId);
      print((value as ParseObject).updatedAt);
      print((value as ParseObject).createdAt);
      print((value as ParseObject).get('objectId'));
      print((value as ParseObject).get('updatedAt'));
      print((value as ParseObject).get('createdAt'));
    });

Enter event When an existing ParseObject’s old value does not fulfill the QueryBuilder but its new value fulfills the QueryBuilder, you’ll get this event. The object is the ParseObject which enters the QueryBuilder. Its content is the latest value of the ParseObject.

  liveQuery.on(LiveQueryEvent.enter, (value) {
      print('*** ENTER ***: ${DateTime.now().toString()}\n $value ');
      print((value as ParseObject).objectId);
      print((value as ParseObject).updatedAt);
      print((value as ParseObject).createdAt);
      print((value as ParseObject).get('objectId'));
      print((value as ParseObject).get('updatedAt'));
      print((value as ParseObject).get('createdAt'));
    });

Leave event When an existing ParseObject’s old value fulfills the QueryBuilder but its new value doesn’t fulfill the QueryBuilder, you’ll get this event. The object is the ParseObject which leaves the QueryBuilder. Its content is the latest value of the ParseObject.

  liveQuery.on(LiveQueryEvent.leave, (value) {
      print('*** LEAVE ***: ${DateTime.now().toString()}\n $value ');
      print((value as ParseObject).objectId);
      print((value as ParseObject).updatedAt);
      print((value as ParseObject).createdAt);
      print((value as ParseObject).get('objectId'));
      print((value as ParseObject).get('updatedAt'));
      print((value as ParseObject).get('createdAt'));
    });

Delete event When an existing ParseObject which fulfills the QueryBuilder is deleted, you’ll get this event. The object is the ParseObject which is deleted

  liveQuery.on(LiveQueryEvent.delete, (value) {
      print('*** DELETE ***: ${DateTime.now().toString()}\n $value ');
      print((value as ParseObject).objectId);
      print((value as ParseObject).updatedAt);
      print((value as ParseObject).createdAt);
      print((value as ParseObject).get('objectId'));
      print((value as ParseObject).get('updatedAt'));
      print((value as ParseObject).get('createdAt'));
    });

Unsubscribe If you would like to stop receiving events from a QueryBuilder, you can just unsubscribe the subscription. After that, you won’t get any events from the subscription object and will close the WebSocket connection to the LiveQuery server.

  await liveQuery.unSubscribe();

Users #

You can create and control users just as normal using this SDK.

To register a user, first create one :

var user =  ParseUser().create("TestFlutter", "TestPassword123", "TestFlutterSDK@gmail.com");

Then have the user sign up:

var response = await user.signUp();
if (response.success) user = response.result;

You can also logout and login with the user:

var response = await user.login();
if (response.success) user = response.result;

Also, once logged in you can manage sessions tokens. This feature can be called after Parse().init() on startup to check for a logged in user.

user = ParseUser.currentUser();

Other user features are:-

  • Request Password Reset
  • Verification Email Request
  • Get all users
  • Save
  • Destroy user
  • Queries

Config #

The SDK now supports Parse Config. A map of all configs can be grabbed from the server by calling :

var response = await ParseConfig().getConfigs();

and to add a config:

ParseConfig().addConfig('TestConfig', 'testing');

Other Features of this library #

Main:

  • Installation
  • GeoPoints
  • Files
  • Persistent storage
  • Debug Mode - Logging API calls
  • Manage Session ID's tokens

User:

  • Create
  • Login
  • Logout
  • CurrentUser
  • RequestPasswordReset
  • VerificationEmailRequest
  • AllUsers
  • Save
  • Destroy
  • Queries
  • Anonymous
  • 3rd Party Authentication

Objects:

  • Create new object
  • Extend Parse Object and create local objects that can be saved and retreived
  • Queries

Author:- #

This project was authored by Phill Wiggins. You can contact me at phill.wiggins@gmail.com

140
likes
0
pub points
87%
popularity

Publisher

verified publisherparseplatform.org

Flutter plugin for Parse Server, (https://parseplatform.org), (https://back4app.com)

Repository (GitHub)
View/report issues

License

unknown (LICENSE)

Dependencies

devicelocale, flutter, http, package_info, path_provider, shared_preferences, uuid, web_socket_channel

More

Packages that depend on parse_server_sdk