altogic_dart 0.0.1

Dart client for Altogic. Altogic is a backend application development and execution platform, enabling people and businesses to design, deploy and manage scalable applications.

Altogic Client Library

Javascript client for Altogic backend apps.

Altogic is a backend application development and execution platform, enabling people and businesses to design, deploy and manage scalable applications. It simplifies application development by eliminating repetitive tasks, providing pre-integrated and ready-to-use execution environments, and automating key stages in the application development process.

For detailed API documentation go to Client API reference

Installation

In order to use the Altogic client library you need to . Additionally, if you will be using the Authentication module of this library, you might need to do additional configuration in your app settings.

dart pub add altogic-dart

And import it

import 'package:altogic-dart/altogic-dart.dart';

Quick start

This guide will show you how to use the key modules of the client library to execute commands in your backend app. For more in-depth coverage, see the Client API reference.

Tested

Section / Platform Tests

Section	Implemented	IO	Browser
Auth	☑	☑	☐
Auth Providers	☐	☐	☐
Database	☑	☑	☐
Storage	☑	☐	☐
Endpoint	☑	☐	☐
Queue	☑	☐	☐
Task	☑	☐	☐

TODO

• ✅ Write Base Implementation
• ❌ Implement Cookie
• ❌ Implement auth provider
• ❌ Create local storage package for flutter
• ❌ Test all platforms
• ❌ Write new readme.md
• ❌ Check all documentation
• ❌ Publish version 1.0

Authentication

Sign up new users with email:

If email confirmation is enabled in your app authentication settings then a confirm sign up email will be sent to the user with a link to click and this method will return the user data with a null session. Until the user clicks this link, the email address will not be verified and a session will not be created. After user clicks on the link in confirmation email, Altogic verifies the verification token sent in the email and if the email is verified successfully redirects the user to the redirect URL specified in app authentication settings with an access_token in query string parameter. You can use this access_token token to get authentication grants, namely the user data and a new session object by calling the getAuthGrant method.

authFunctions() async {
  //Sign up a new user with email and password
  var errors = await altogic.auth.signUpWithEmail(email, password);

  if (errors != null) {
    // success
  }

  //... after email address verified, you can get user and session data using the accessToken
  var authGrant = await altogic.auth.getAuthGrant(accessToken);

  //After the users are created and their email verified, the next time the users wants to sign in to their account, you can use the sign in method to authenticate them
  var userSession = await altogic.auth.signInWithEmail(email, password);
}

Sign up new users with mobile phone number:

If phone number confirmation is enabled in your app authentication settings then a confirmation code SMS will be sent to the phone. Until the user validates this code by calling verifyPhone, the phone number will not be verified.

authFunction() async {
  //Sign up a new user with mobile phonec number and password
  var errors = await altogic.auth.signUpWithPhone(phone, password);

  if (errors != null) {
    // success
  }

//Verify the phone number using code sent in SMS and and return the auth grants (e.g., session)
  var userSession = await altogic.auth.verifyPhone(phone, code);

//After the users are created and their phones numbers are verified, the next time the users wants to sign in to their account, you can use the sign in method to authenticate them
  var errors = await altogic.auth.signInWithPhone(phone, password);
}

Database

Create a new object:

To create a new object in one of your models in the database, you have two options. You can use the query manager shown below:

createObject() async {
  //Insert a new top-level model object to the database using the query builder
  var response = await altogic.db.model('userOrders').create({
    productId: 'prd000234',
    quantity: 12,
    customerId: '61fbf6ceeeed063ab062ac05',
    createdAt: '2022-02-09T10:55:34.562+00:00',
  });

  if (response != null) {
    //success
    print(response.data);
  }
}

Learn more

You can use the following resources to learn more and get help

• 🚀 Quick start
• 📜 Altogic Docs
• 💬 Discord community

Bugs Report

Think you’ve found a bug? Please, send us an email [e-mail]

Support / Feedback

For issues with, questions about, feedback for the client library, or want to see a new feature please, send us an email [e-mail] or reach out to our community forums https://community.altogic.com