backendless_sdk 0.0.2

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • new68

Backendless SDK for Flutter #

pub package

A Flutter plugin enabling integration with Backendless.

Note: This plugin is still under active development. Some APIs may not be available yet while others may change. We will be updating the release history of the plugin and as soon as it reaches the general availability (GA) state, the APIs will be consistent for backward-compatibility.

Feedback and Pull Requests are most welcome!

Getting Started #

Follow the steps below to get started with Backendless Flutter SDK:

STEP 1. Register the plugin #

To use this plugin in your Flutter project, add backendless_sdk as a dependency in your pubspec.yaml file:

dependencies:
  backendless_sdk: ^0.0.1

STEP 2. Import the Backendless SDK: #

Add the following import to your Dart code

import 'package:backendless_sdk/backendless_sdk.dart';

STEP 3: Initialize the Backendless SDK #

Use the following call in your code:

@override
void initState() {
  super.initState();
  Backendless.initApp(APPLICATION_ID, ANDROID_API_KEY, IOS_API_KEY);
}

The APPLICATION_ID, ANDROID_API_KEY and IOS_API_KEY values must be obtained in Backendless Console:

  1. Login to your Backendless account and select the application.
  2. Click the Manage icon from the vertical icon-menu on the left.
  3. The App Settings section is selected by default. The interface contains values for Application ID and API keys for each supported client-side environment.
  4. Use the Copy icon to copy the value into the system clipboard.

STEP 4. Use the Backendless APIs. #

For example, here is a sample code which stores an object in Backendless database:

Backendless.initApp(APPLICATION_ID, ANDROID_API_KEY, IOS_API_KEY);
// create a Map object. This will become a record in a database table
Map testObject = new Map();

// add a property to the object. 
// The property name ("foo") will become a column in the database table
// The property value ("bar") will be stored as a value for the stored record
testObject["foo"] = "bar";

// Save the object in the database. The name of the database table is "TestTable".
Backendless.Data.of("TestTable").save(testObject).then(
  (response) => print("Object is saved in Backendless. Please check in the console."));

Known Issues #

  • The plugin does not support custom classes for Backendless database integration

Release History #

  • May 9, 2019: Initial release 0.0.1

0.0.2 #

  • Fix all analyzer hints.

0.0.1 #

  • Initial version for Android.

example/README.md

backendless_sdk_example #

Demonstrates how to use the backendless_sdk plugin.

Getting Started #

The sample code to store an object in Backendless database:

Backendless.initApp(APPLICATION_ID, ANDROID_API_KEY, IOS_API_KEY);
// create a Map object. This will become a record in a database table
Map testObject = new Map();

// add a property to the object. 
// The property name ("foo") will become a column in the database table
// The property value ("bar") will be stored as a value for the stored record
testObject["foo"] = "bar";

// Save the object in the database. The name of the database table is "TestTable".
Backendless.Data.of("TestTable").save(testObject).then(
  (response) => print("Object is saved in Backendless. Please check in the console."));

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  backendless_sdk: ^0.0.2

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter packages get

Alternatively, your editor might support flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:backendless_sdk/backendless_sdk.dart';
  
Version Uploaded Documentation Archive
0.0.2 May 9, 2019 Go to the documentation of backendless_sdk 0.0.2 Download backendless_sdk 0.0.2 archive
0.0.1 May 9, 2019 Go to the documentation of backendless_sdk 0.0.1 Download backendless_sdk 0.0.1 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
44
Health:
Code health derived from static analysis. [more]
93
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
90
Overall:
Weighted score of the above. [more]
68
Learn more about scoring.

We analyzed this package on May 17, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.3.0
  • pana: 0.12.15
  • Flutter: 1.5.8

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health issues and suggestions

Document public APIs. (-1 points)

26 out of 26 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Fix lib/backendless_sdk.dart. (-5.84 points)

Analysis of lib/backendless_sdk.dart reported 12 hints, including:

line 7 col 16: Name non-constant identifiers using lowerCamelCase.

line 8 col 16: Name non-constant identifiers using lowerCamelCase.

line 9 col 16: Name non-constant identifiers using lowerCamelCase.

line 10 col 16: Name non-constant identifiers using lowerCamelCase.

line 11 col 16: Name non-constant identifiers using lowerCamelCase.

Fix lib/src/modules/geo.dart. (-0.50 points)

Analysis of lib/src/modules/geo.dart reported 1 hint:

line 311 col 20: The value of the field '_serialVersionUID' isn't used.

Maintenance suggestions

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
collection ^1.14.11 1.14.11
flutter 0.0.0
Transitive dependencies
meta 1.1.6 1.1.7
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test