Requirements

• A VPS Server, minimum 2GB RAM, 1 vCPUs, 20GB Disk Storage, Ubuntu 18.04 - Amazon AWS Lightsail or AlibabaCloud are the best choices in terms of speed, reliability and price. This API has been fully tested on AWS Lightsail and AlibabaCloud.
• Sublime Text (recommended), or any other HTML/text editor of your choice.
• An FTP account confgured in FileZilla, needed to upload/edit files in your server
• Chrome Web Browser (recommended), and/or Safari or Firefox

Installation

How to configure an Ubuntu instance on AWS Lightsail to make HelloDB work

• In the Home page of your Lightsail account, click the Create instance button.
  
  
  
• On the next page, select the instance location closer to your place, select the OS only button and choose Ubuntu 18.04 LTS.
  
  
  
• Choose the instance plan you desire (the $10 one is recommended) and give a name to your instance.
  
  
  
• Scroll down and click the Create instancebutton. You will be redirected to the Home page where you'll have to wait for a few seconds to get your new instance ready and running.
  
  
  
• Once your instance is ready, click on its name to enter its details.
  
  
• Click the Networking tab.
  
  
  
• You have to create a Static IP, so click the + Create static IP button.
  
  
  
• Give a name to your IP and click the Create button.
  
  
  
• Take note of the new Static IP address that the system generated, and click the Home button.
  
  
  
• Back to the Home page, click the little terminal icon to connect to your instance via SSH.
  
  
  
• It's time to run some Linux commands to configure your server. Don't worry, it's super easy, just follow the steps below.
  
  In the terminal window, type this command and hit Enter:

   sudo apt update
  

  Wait until you get the cursor ready again
  
  
  
• Now this command and hit Enter:

   sudo apt upgrade
  

  You'll be asked to continue, type Y and hit Enter again, then wait for the upgrade to be done and the cursor to be visible again.
  
  
  
• If you will get the following alerts, just always hit Enter:
  
  
  
  
  
  
  
• Once the upgrade of your instance is done, install Apache2 by running this command:

   sudo apt install apache2
  

  You'll have to type 'Y' and hit Enter again to consitnue with the installation.
  
  
• Now that Apache2 is installed, install PHP with this command:

   sudo apt install php
  

• Restart Apache2 with this command:

   sudo systemctl restart apache2
  

• Install cURL with this command:

   sudo apt-get install php-curl
  

• The last thing to install is Pear PHP mail. Run this first command:

   sudo apt-get install yum
  

• When the installation of Yum is done, run this other command:

   sudo apt-get install php-pear
  

• When Pear is installed, run this other command:

   sudo pear install mail
  

• Then, run this command:

   sudo pear install Net_SMTP
  

• Finally, run the last command to restart Apache2:

   sudo systemctl restart apache2
  

• You can close the SSH window now, and go back to your Lightsail page. Click the Account button and enter the SSH keys tab.
  
  
  
• Click the Download button to download the SSH key to get connected to your instance via FileZilla. Save that file in a safe place, you'll need it soon.
  
  
  
• Go back to Home, copy the Static IP of your instance, open a new tab in your browser and paste it, then hit Enter.
  
  
  
• You should get a page like the one below, which means that your server is running smoothly and it's ready top host the HelloDB files.
  
  
  
• Download Filezilla and install it on your computer.
  Open it and click the icon on the top-left corner. Click the New site button and give a name to your FTP connection
  
  
  
• In the Site Manager popup, select the SFTP - SSH protocol, paste your Static IP address in the Host field, Select the Key file as Logon Type, type ubuntu in the User field and upload the Key file you downloaded from your lightsail account a while ago.
  
  
  
• Enter the Advanced tab and type:

   /var/www/html/

  Then cick the Connect button.
  
  
  
• If you did everything correctly, you should see an index.html file in the list.
  You have to enter the SSH terminal of your instance on Lightsail in order to run the command that sets the writing permissions to the html folder, so you'll be able to upload the HelloDB files.
  Type this command in the terminal and hit Enter:

  sudo chmod -R 777 /wav/www/html

• You can finally delete the index.html file and upload the api folder in your server.
  Simply drag and drop that folder and wait for Filezilla to upload all files
  
  
  

Configurations

Sublime Text

• Protect JSON data files from being viewed by Web browsers

 <Directory /var/www/html/>
    <Files "*.json">
      Order allow,deny
      Deny from all
    </Files>
 </Directory>

 sudo systemctl restart apache2

 sudo chmod -R 777 /etc/apache2

• HelloDB Database path

 $DATABASE_PATH = "http://1.2.3.4/api/";

 $DATABASE_PATH = "http://1.60.156.165/api/";

 $DATABASE_PATH = "http://1.60.156.165/abc123def456/";

• App name

 $APP_NAME = "MyApp";

• Admin login credentials

 $ADMIN_USERNAME = "admin";
 $ADMIN_PASSWORD = "admin";

• Admin email address

 $ADMIN_EMAIL = "myemail@address.com";

• Google Sign In [Web OAuth Key]

 $GOOGLE_SIGNIN_KEY = '';

• Apple Sign In and iOS Push Notifications

• Register your app's Bundle Identifier (the App ID) on your Apple Developer Account -> Certificates, Identifiers & Profiles -> Identifiers section
• Click the Keys option from the left menu, then the (+) blue button to add a new Key.
  
• Type a key name, enable the Apple Push Notifications service (APNs) and Sign In with Apple options in the Register a New Key section.
• Click the Configure button next to the Sign In with Apple option and select your Bundle Identifier from the Primary App ID dropdown menu. Lastly, click the Save button.
• Download the AuthKey.p8 file on your computer - pay attention, you'll be able to download it only once, so save it in a safe place.
• On the Configure key page, click the Continue and then the Save button.
• Delete the existing AuthKey_2NDC475ZK3.p8 file from the _Push folder and upload your own one inside it.

$AUTH_KEY_FILE = 'AuthKey_ABC123DEF4.p8'; // Your p8 Key file name
$APN_KEY_ID = 'ABC123DEF4';    // Your Apple Push Notification Key ID
$TEAM_ID = 'ZABC345QWE67';   // Your Team ID (see Apple Developer Portal -> Membership)
$BUNDLE_ID = 'com.myname.appname';    // Your iOS App's Bundle Identifier, the one you've set in Xcode
$APN_URL = 'https://api.development.push.apple.com';  // OR: http://api.push.apple.com  [for Production environment]

• Android Push Notifications

 $FCM_SERVER_KEY = 'AAAALIIuEYQ:APA91bFzOf-yDRyp7Idb1AcweD6DQUVLr5zrbWVnB-uVTy0w6dt0UUXKDXthiHzqm...';

• Email Verification

 $IS_EMAIL_VERIFICATION = false;

Using PEAR Mail.php to send emails

  host' => 'your_smtp_host',	// <-- YOUR SMTP HOST
 'username' => 'your@email.com', // <-- YOUR EMAIL ADDRESS
 'password' => 'your_password' 	// <-- YOUR PASSWORD

  'host' => 'ssl://smtp.gmail.com',
  'port' => '465',
  'auth' => true,
  'username' => 'youremail@gmail.com',
  'password' => 'your_gmail_password' 

• Utility Functions

// UTILITY FUNCTIONS AND GLOBAL VARIABLES

The Dashboard

• About Data Tables

• Add a Table

• Import Tables

• Add a Column

• Column Types

• ID | composed by ID_ prefix and id suffix
  This is the object Identifier of each row of the Table. It cannot be created manually, it gets automatically created by the API and its key is always ID_id. It also cannot be edited, but it can be copied by a double-click on its cell.
  
  
• String | composed by ST_ prefix | the suffix will be the name you assigned to it
  This is a String to host and display text
  
  
• Number | composed by NU_ prefix | the suffix will be the name you assigned to it
  It supports integer and decimal numbers. PLEASE NOTE that decimal numbers must have the dot (.) as separator, not the comma (,).
  Example: 123.45
  
  
• Array | composed by AR_ prefix | the suffix will be the name you assigned to it
  This type is usually used to store arrays of Strings like object IDs or other text.
  It's comma-separated, so be careful while storing an array, put commas where they are needed and do not use the array [""] brackets, just type values separated by commas in the array's input field.
  Example: lorem,ipsum,dolor,sit
  
  
• File | composed by FL_ prefix | the suffix will be the name you assigned to it
  This type hosts the URL of an uploaded file. Physical files get stored inside the uploads folder
  
  
• Boolean | composed by BL_ prefix | the suffix will be the name you assigned to it
  It's either true or false, as per standard JSON syntax.
  Just keep in mind that if you use an input text field instead of a Checkbox or Switch button, the values you must pass are either "0" or "1" (True or False)
  
  
• GPS | composed by GPS_ prefix | the suffix will be the name you assigned to it
  This type is an array of 2 decimal numbers, the latitude and longitude coordinates, usually used for location purposes.
  Like the Number data type, the decimal separator of the coordinates must be a dot (.), and the separator of the 2 coordinates must be a comma (,)
  Example: 12.236548,-45.845987
  
  
• Pointer | composed by PO_ prefix | the suffix will be the name you assigned to it
  This type hosts the ID of an object taken from another Table. For instance, a user's ID from the Users table.
  It's clickable in the Dashboard, it opens the selected object's row
  
  
• Date | composed by DT_ prefix | the suffix will be the name you assigned to it
  The Date format is YYYY-MM-DDTHH:mm:ss and it's a String
  
  

• Rename a Table

• Delete a Table

• Add a row

• Edit cells data

• Delete rows

• Copy a row

• Rename a column

• Delete a column

• Search data

• Sort data

• Order Columns

• Send Push Notifications

• Background Jobs

$(function () {
 //------------------------------------------------
 // BACKGROUND JOB - DELETE ROWS WITH PASSED DATE
 //------------------------------------------------
 setInterval(function() {
   // Search Date in Posts.json
   $.getJSON("Posts.json", function(Posts){
     for (var i=0; i < Posts.length; i++) {
       var obj = Posts[i];
       var aDate = new Date(obj['DT_aDate']);
       var now = new Date();
       if (aDate <= now) {
         var rowID = obj['ID_id']; 
         var tableName = 'Posts';

         // Delete row with passed Date
         $.ajax({
           url:"delete-row.php?tableName=Posts&rowID=" + rowID,
           success:function(data) {
             console.log('row deleted!');
           }
         });
        }// ./ If
	}// ./ For
  });// ./ getJSON
 }, 5 *1000); // execute every 5 seconds
});// ./ on page load

[Web SDK]

• Configurations

 $DATABASE_PATH = 'https://1.2.3.4/api/';

• Current User - HDBCurrentUser

 <script>
 var currentUser = HDBCurrentUser();
 if (currentUser != null) {
   console.log(currentUser['ID_id']);
   console.log(currentUser['ST_username']);
   console.log(currentUser['ST_email']);
 // currentuser IS NOT LOGGED IN...
 } else {
   console.log('currentUser is not logged in...');
   // You may redirect the browser to the Login page:
   window.location.replace("login.php");
 }
 </script>

• Sign In - HDBSignIn

 <!-- Sing in form -->
 <input id="username" name="username" type="text" placeholder="Username">
 <input id="password" name="password" type="password" placeholder="Password">
 <!-- Sign In Button -->
 <button id="loginButton" onclick="signIn()">Sign In</button>
 <script>
   function signIn() { 
     HDBSignIn();
   });
 </script>

• Sign Up - HDBSignUp

var p2 = { 'tableName': 'Users' };
p2['ID_id'] = cuArr[0];

// Additional data (optional)
p2['BL_bool'] = '0';
p2['ST_fullname'] = $('#fullName').val();
p2['FL_file'] = 'https://yourserver.com/assets/img/profilepic.png';

HDBObject(p2);

 <!-- Inputs to pass data -->
 <input id="username" name="username" type="text">
 <input id="password" name="password" type="password">
 <input id="email" name="email" type="email">
 <input id="fullName" name="fullName" type="text">
 
 <!-- Sign up button -->
 <button id="signUpButton"><i class="fas fa-arrow-circle-right"></i></button>
 <script>
   // Sign Up
   $(function () { $("#signUpButton").click(function () {
     if ($('#username').val() == '' 
         || $('#password').val() == ''
         || $('#email').val() == ''
         || $('#fullName').val() == ''
     ){ console.log('Please fill all the fields.');

     } else {
       var params = { 'signInWith': '' };
       params['ST_username'] = $('#username').val();
       params['ST_password'] = $('#password').val();
       params['ST_email'] = $('#email').val();
       params['ST_iosDeviceToken'] = '';
       params['ST_androidDeviceToken'] = '';
       HDBSignUp(params);
     }// ./ If
 }); });
 </script>

• Reset Password - HDBForgotPassword

 <a class="btn btn-warning" href="#" onclick="HDBForgotPassword()">Forgot password</a>

• Query Objects - HDBQuery

 <script>
 function queryObjects() {
   var objects = HDBQuery(
     'tableName=' + 'Posts'  // Set the Table name
     + '&columnName=' + 'DT_createdAt'  // Get the createdAt Date column
     + '&orderBy=' + 'descending'  // OR 'ascending' 
   );
 // array of objects
 var objectsArray = [];
 for (var i = 0; i < objects.length; i++) {
   // JSON Obj
   var obj = objects[i];

   // Query filters
   if(
     obj['ST_category'] == 'Fun'
     || obj['NU_likes'] == 1234
   ){ objectsArray.push(obj); }

   // Finalize array of objects by removing duplicates (if any)
   if (i == objects.length-1) { 
     objectsArray = HDBRemoveDuplicatesFromArray(objectsArray);
     showData(objectsArray);
   } //./ If
 } // ./ For
}

// Show Data
function showData(objectsArray) {
  for(var i = 0; i < objectsArray.length; i++){
    // JSON object
    var obj = objectsArray[i];

    console.log(obj['ID_id']);
    console.log(obj['ST_text']);
    ...
  }
}
 </script>

• Refresh Object Data - HDBRefreshObjectData

 var refreshedObject = HDBRefreshObjectData("Users", "as34FiPrT");
 console.log(refreshedObject['ST_username']);
 ...

• Get Pointer - HDBGetPointer

  var userPointer = HDBGetPointer(obj['PO_userPointer_Users'], 'Users');

  console.log(userPointer['ST_username']);
  console.log(userPointer['ST_email']);
  ...

• Add/Edit an Object - HDBObject

 <!-- Text -->
 <textarea type="text" id="ST_text" name="ST_text" rows="2" ></textarea>
 <!-- Likes -->
 <input type="number" step="any" id="NU_likes" name="NU_likes" value="0">
 <!-- GPS coordinates -->
 <input type="number" step="any" id="latitude" name="latitude" >
 <input type="number" step="any" id="longitude" name="longitude" >
 ...

 <!-- Save button -->
 <a href="#" id="saveButton" onclick="saveData()">Save Object

 <script>
function saveData() {
  // Prepare data
  var params = {'tableName=':'Posts'};  // <- Mandatory!
  params['ID_id'] = objectID;  // USE THIS TO UPDATE AN OBJECT / REMOVE THIS LINE TO SAVE A NEW OBJECT
  params['ST_text'] = $('#ST_text').val();
  params['NU_likes'] = $('#NU_likes').val();
  params['GPS_coords'] = $('#latitude').val() +','+ $('#longitude').val();
  params['PO_userPointer_Users'] = currentUser['ID_id'];

  // Save
  var result = HDBObject(params);
  if (result.includes('ID_id')) {
    console.log('Object updated: ' + result);
  }
});
</script>

• Delete an Object - HDBDelete

 <!-- Delete Object button -->
 <a href="#" id="deleteButton" class="btn btn-danger btn-block">Delete Object</a>

 <script>
  // Get object's ID
  objectID = obj['ID_id'];

  // Delete object [HDBDelete]
  $("#deleteButton").click(function () {
    var params = 
      'tableName=' + 'Posts' +
      '&id=' + objectID;
    var result = HDBDelete(params);
    if (result == 'deleted') {
      console.log('Object successfully deleted!');
    }
  });
 </script>

• Utility functions

• HDBRemoveDuplicatesFromArray()
• uploadFile()
• roundBigNumber()
• Custom alerts

• Conclusion

[iOS SDK]

• Configurations

 let APP_NAME = "HelloDB"

 let DATABASE_PATH = "http://1.2.3.4/api/"

 let GOOGLE_SIGN_IN_CLIENT_ID = "191162618244-qmjf889os6jffa53d53el3dsk87..."

• Data format

 Object Name["Column name"].Data Type

 myPostObject["ST_text"].string!

 String
 Integer
 Double
 Array
 Boolean

 myObj["ST_string"].string!
 myObj["NU_number"].int! 
 myObj["NU_number"].double! 
 myObj["AR_array"].array! 
 myObj["BL_bool"].bool! 

• Current User - HDBCurrentUser

 HDBCurrentUser { (currentUser) in
 if currentUser != nil  {
   // User is logged in
   print(currentUser!["ST_username"].string!)
 } else {
   // User is logged out -> You may open a Login screen
}

• Sign In - HDBSignIn

 HDBSignIn(username: usernameTxt.text!, password: passwordTxt.text!) { (succ, e) in
  if e == nil {
    print("Signed in!")
    // Go to the Home screen...
    
  // Wrong username/password
  } else { print(e!) }
}// ./ HDBSignIn

• Sign Up - HDBSignUp

 HDBSignUp(username: self.usernameTxt.text!, password: self.passwordTxt.text!, email: self.emailTxt.text!, signInWith: "") { (userID, e) in
  if e == nil {
    var params = ["tableName": "Users"]
    params["ID_id"] = userID!

    // Additional data (optional)
    params["ST_fullname"] = self.fullnameTxt.text!

    self.HDBObject(params) { (succ, e) in
      if e == nil {
        print("Signed up!")
        // Do something...

      // error
      } else { print(e!)
    }}// ./ HDBObject

   // error
   } else { print(e!)
 }}// ./ HDBSignUp()

• Reset Password - HDBResetPassword

 HDBResetPassword(email: "myemail@address.com") { (result, e) in
 if e == nil { 
   print(result!)
 } else { 
   print(e!) 
 }

• Logout - HDBLogout

 HDBLogout { (succ) in
  if succ! {
    print("Logged out!")
    // Go to the Login screen...
    
  } else { print("Something went wrong. Try again.")
 }}// ./ HDBLogout

• Get Pointer Object - HDBGetPointer

 HDBGetPointer(pObj["PO_userPointer_Users"].string!, tableName: "Users") { (userPointer) in
  print(userPointer!["ST_username"].string!)
  print(userPointer!["NU_age"].int!)
  print(userPointer!["AR_followers"].array!)
 }

• Refresh Object Data - HDBRefreshObjectData

 HDBRefreshObjectData(tableName: "Posts", object: postObj) { (postObj, e) in
    if e == nil {
      // Use the 'postObj' as you wish...

    // error
    } else { self.simpleAlert(e!) }
 } // HDBRefreshObjectData 

• Delete an Object - HDBDelete

 HDBDelete(tableName: "Posts", id: pObj["ID_id"].string!) { (succ, e) in
  if e == nil {
    print("Object successfully deleted!")
  } else { 
    print(e!)
  }
 }

• Query Objects - HDBQuery

 HDBQuery(tableName: "Posts", columnName: "DT_createdAt", orderBy: "") { (objects, e) in
  if e == nil {
    // For
    for i in 0..< objects!.count {
      let pObj = objects![i]
      
      // [Search for keywords] --------------------------
      let keywords = self.searchText.components(separatedBy: " ")
      if (self.searchText.count != 0) {
        for j in 0..< keywords.count{
          if pObj["ST_text"].string!.lowercased().contains(keywords[j].lowercased())
          { self.objectsArray.append(pObj) }
        }// ./ For • Search
      
      // [No keywords -> Query filters] ---------------------------
      } else if
        pObj["ST_category"].string! == "Fun"
        || pObj["NU_likes"].int! == 789789
        { self.objectsArray.append(pObj) }
        
    // [Finalize array of objects]
    if i == objects!.count-1 { self.objectsArray.HDBRemoveDuplicatesFromArray() }
   }// ./ For
   
   
   if self.objectsArray.count != 0 {
     // Show data in a TableView or somewhere else...
   
   } else {
     print("No results!")
   }// ./ If
   
  // error on query
  } else { print(e!) }
            
 }// ./ HDBQuery

• Add/Edit an Object - HDBObject

 var params = ["tableName": "Posts"]  // <- Mandatory
 params["ID_id"] = myObj["ID_id"].string!  // USE THIS TO UPDATE AN OBJECT / REMOVE THIS LINE TO SAVE A NEW OBJECT
 params["ST_text"] = textTxt!.text!
 params["NU_number"] = numberTxt!.text!
 params["FL_file"] = fileURL!
 params["DT_date"] = HDBGetStringFromDate(self.selectedDate) // Used to save a Date()
 params["AR_array"] = HDBGetStringFromArray(likedBy) // Used to save an Array[String]
 params["GPS_coords"] = latitudeTxt.text! + "," + longitudeTxt.text!
 params["PO_userPointer_Users"] = currentUser["ID_id"].string!)

 HDBObject(params) { (e, obj) in
   if e == nil {
     print("Object Updated: " + obj!["ID_id"].string!)

   // error
   } else { print(e!)
 }}// ./ HDBObject

• Send a Push Notification

 // Send iOS Push notification
 HDBSendiOSPush(message: "Hi there, this is a Push!", deviceToken: userPointer!["ST_iosDeviceToken"].string!, pushType: "chat") { (succ, e) in
  if e == nil {
    print("iOS PUSH SENT!")
  }
 }// ./ HDBSendiOSPush()
 
 // Send Android Push notification
 HDBSendAndroidPush(message: "Hi there, this is a Push!", deviceToken: userPointer!["ST_androidDeviceToken"].string!, pushType: "chat") { (succ, e) in
   if e == nil {
     print("ANDROID PUSH SENT!")
   }
 }// ./ HDBSendAndroidPush()

• Utility functions

• getImage(from : String)
• HDBRemoveDuplicatesFromArray()
• HDBUploadFile()
• Custom alerts and more

• Conclusion

[Android SDK]

• Configurations

 public static String  DATABASE_PATH = "http://1.2.3.4/api/";

 <string name="app_name">HelloDB</string>

• Data format

 Object Name.key("Column name").Data Type

 myObj.key("ST_text").stringValue()

 String
 Integer
 Double
 Array
 Boolean

 pObj.key("ST_text").stringValue()
 pObj.key("NU_number").intValue();
 pObj.key("NU_number").doubleValue();
 pObj.key("AR_array").getJSONArray();
 pObj.key("BL_boolean").booleanValue();

• Current User - HDBCurrentUser

 HDBCurrentUser(this, new HDBCurrentUserHandler() { @Override public void done(final JSON currentUser) {
   // currentUse IS LOGGED IN!
   if (currentUser != null) {
     Log.i("hdb", currentUser.key("ST_username").stringValue());

   // currentUse IS NOT LOGGED IN...
   } else { startActivity(new Intent(ctx, Intro.class)); }
 }}); // ./ HDBCurrentUser

• Sign In - HDBSignIn

 HDBSignIn((Activity)ctx, usernameTxt.getText().toString(), passwordTxt.getText().toString(), new HDBSignInHandler() {
  @Override
  public void done(boolean success, String e) {
    if (e == null) {
      Log.i("hdb", "Signed in!");
      // Go to the Home screen...

    // error
    } else { Log.i("hdb", e); }
 }});// ./ HDBSignIn

• Sign Up - HDBSignUp

 HDBSignUp((Activity) ctx, usernameTxt.getText().toString(), passwordTxt.getText().toString(), emailTxt.getText().toString(), "", new HDBSignUpHandler() {
  @Override public void done(String result, String e) {
    if (e == null) {
      RequestParams params = new RequestParams();
      params.put("tableName", "Users"); // <- Mandatory
      params.put("ID_id", result); // <- Mandatory
      // Add additional data
      params.put("ST_fullname", fullnameTxt.getText().toString());
      
      HDBObject((Activity)ctx, params, new HDBObjectHandler() { @Override public void done(boolean success, String e) {
        if (e == null) {
          Log.i("hdb", "Signed up!");
   		  // Go to the Home screen...

   		// error
   	    } else { Log.i("hdb", e);
      }}});// ./ HDBObject
    
    // error
    } else { Log.i("hdb", e); }
 }});// ./ HDBSignUp

• Reset Password - HDBResetPassword

 HDBResetPassword((Activity)ctx, "myemail@address.com", new ResetPasswordHandler() {
   @Override
   public void done(String result, String error) {
     if (error == null) {
       Log.i("hdb", result);
     } else {
       Log.i("hdb", error);
     }
 }});// ./ HDBResetPassword

• Logout - HDBLogout

 HDBLogout(new LogoutHandler() { @Override public void done(boolean success) {
   if (success) {
     Log.i("hdb", "Logged out!");
   } else {
     Log.i("hdb", Something went wrong. Try again");
   }
 }});

• Get Pointer Object - HDBGetPointer

 HDBGetPointer((Activity) ctx, pObj.key("PO_userPointer_Users").stringValue(), "Users", new HDBPointerHandler() {
  @SuppressLint("SetTextI18n")
  @Override
  public void done(final JSON userPointer, final String e) {
    if (e == null) {
      Log.i("hdb", userPointer.key("ST_username").stringValue());
      Log.i("hdb", userPointer.key("NU_age").intValue());
      Log.i("hdb", userPointer.key("AR_followers").getJsonArray());
    // error
    } else { log.i("hdb", e);
 }}}); // ./ HDBGetPointer

• Refresh Object Data - HDBRefreshObjectData

 HDBRefreshObjectData((Activity)ctx, "Posts", postObj, new HDBRefreshObjectDataHandler() {
  @Override
  public void done(JSON postObj, String error) {
    if (error == null){
      // Use 'postObj' as you wish...

    // error
    } else { hideHUD(); simpleAlert(error, ctx); }
 }}); // HDBRefreshObjectData

• Delete an Object - HDBDelete

 HDBDelete((Activity)ctx, "Posts", pObj.key("ID_id").stringValue(), new HDBDeleteHandler() {
   @Override
   public void done(boolean success, String e) {
     if (e == null) {
       Log.i("HDB", "Object successfully deleted!");

     // error
     } else { Log.i("hdb", e);
 }}});// ./ HDBDelete

• Query Objects - HDBQuery

 HDBQuery((Activity)ctx, "Posts", "DT_createdAt", "descending", new HDBQueryHandler() {
    @Override public void done(JSON objects, String error) {
    if (error == null) {

      for (int i = 0; i < objects.count(); i++) {
        JSON pObj = objects.index(i);

        // [Search for keywords] --------------------------
        String[] keywords = searchText.toLowerCase().split(" ");
        if (searchText.length() != 0) {
          for (String keyword : keywords) {
            if (
              pObj.key("ST_text").stringValue().toLowerCase().contains(keyword.toLowerCase())
            ) { objectsArray.add(pObj); }
          }// ./ For • Search

        // [No keywords -> Query filters] ---------------------------
        } else if (
          pObj.key("ST_category").stringValue().matches("Fun")
          || pObj.key("NU_likes").intValue() == 789789
        ){ objectsArray.add(pObj); }

        // [Finalize array of objects]
        if (i == objects.count()-1) { objectsArray = HDBRemoveDuplicatesFromArray(objectsArray); }
      }// ./ For


      if (objectsArray.size() != 0) {
        // Show data in a ListView or somewhere else...

      } else {
        Log.i("hdb", "No results!");
      }// ./ If

    // error
    } else { Log.i("hdb", error); }
 }});// /. HDBQuery

• Add/Edit an Object - HDBObject

 // Parameters
 RequestParams params = new RequestParams();
 params.put("tableName", "Posts");
 params.put("ID_id", pObj.key("ID_id").stringValue()); // Used to update an object
 params.put("ST_text", textTxt.getText().toString());
 params.put("NU_number", numberTxt.getText().toString());
 params.put("FL_file", fileURL);
 params.put("DT_date",  HDBGetStringFromDate(selectedDate)); // Used to save a Date()
 params.put("AR_array", HDBGetStringFromArray(myArray)); // Used to save a ListArray<String>()
 params.put("GPS_coords", latitudeTxt.getText().toString() + "," + longitudeTxt.getText().toString());
 params.put("BL_bool", "1");

 HDBObject((Activity)ctx, params, new HDBObjectHandler() { @Override public void done(String e, JSON obj) {
   if (e == null) {
     Log.i("hdb", "Object updated: " + obj.key("ID_id").stringValue());

   // error
   } else { Log.i("hdb", e);
 }}});// ./ HDBObject

• Send a Push Notification

 // Send Android Push Notification
 HDBSendAndroidPush((Activity)ctx, pushMessage, userPointer.key("ST_androidDeviceToken").stringValue(), "chat", new HDBAndroidPushHandler() {
   @Override
   public void done(boolean success, String e) {
     if (e == null) {
       Log.i("hdb", "ANDROID PUSH SENT!");

     // error
     } else { Log.i("hdb", e); }
 }});// ./ HDBSendAndroidPush

 // Send iOS Push Notification
 HDBSendiOSPush((Activity)ctx, pushMessage, userPointer.key("ST_iosDeviceToken").stringValue(), "chat", new HDBiOSPushHandler() {
   @Override
   public void done(boolean success, String e) {
     if (e == null) {
       Log.i("hdb", "iOS PUSH SENT");

     // error
     } else { Log.i("hdb", e); }
 }});// ./ HDBSendiOSPush

• Utility functions

• roundBigNumber();
• HDBRemoveDuplicatesFromArray();
• HDBUploadFile();
• etc...

• Conclusion

[Unity SDK]

• Configurations

 public static String  DATABASE_PATH = "https://1.2.3.4/api/";

• Data format

 Object Name["Column name"]

 myObj["ST_text"]

 String
 Integer
 Double
 Array
 Boolean

• Current User - HDBCurrentUser

 // Get Current User
 JSONNode currentUser = HelloDBSDK.HDBCurrentUser();
 if(currentUser == null) { Debug.Log("Current User is logged out...");
 } else { Debug.Log(currentUser["ST_username"]); }

• Sign In - HDBSignIn

 if (usernameField.text == "" || passwordField.text == ""){
 HelloDBSDK.simpleAlert("Please type a username and a password.");
 } else {
   var result = HelloDBSDK.HDBSignIn(usernameField.text, passwordField.text);
   if(result) { SceneManager.LoadScene("MainScene"); }
 }

• Sign Up - HDBSignUp

 if (usernameField.text == "" || passwordField.text == "" || emailField.text == "" || fullnameField.text == ""){
 HelloDBSDK.simpleAlert("Please insert username, password, email and full name.");
 } else {
   var signUpResult = HelloDBSDK.HDBSignUp("unityUser", "qqq", "unity@mail.com", "");
   // Additional user's data
   List<String> parameters = new List<String>();
   parameters.Add(HelloDBSDK.param("tableName", "Users"));
   parameters.Add(HelloDBSDK.param("ID_id", signUpResult));
   parameters.Add(HelloDBSDK.param("ST_fullname", "Unity Gamer"));
   parameters.Add(HelloDBSDK.param("BL_bool", "0")); 
   parameters.Add(HelloDBSDK.param("FL_aFile", "0"));

   var result = HelloDBSDK.HDBObject(parameters);
   if (result.ToString().Contains("ID_id")){
     Debug.Log("NEW USER SIGNED UP: " + result.ToString());
     SceneManager.LoadScene("Home");
   }
 }

• Reset Password - HDBResetPassword

 var result = HelloDBSDK.HDBResetPassword("my@email.com");
 if(result != null){ HelloDBSDK.simpleAlert(result); }

• Logout - HDBLogout

 if (EditorUtility.DisplayDialog(HelloDBSDK.GAME_NAME, "Are you sure you want to logout?", "Logout", "Cancel")){
  // Logout
  if(HelloDBSDK.HDBLogout()) { Debug.Log("Logged out!"); }  	
 }

• Get Pointer Object - HDBGetPointer

 var userPointer = HelloDBSDK.HDBGetPointer("Users", obj["PO_userPointer_Users"]);
 Debug.Log("USERNAME: " + userPointer["ST_username"]);
 Debug.Log("FULLNAME: " + userPointer["ST_fullname"]);

• Refresh Object Data - HDBRefreshObjectData

 var refreshedObj = HelloDBSDK.HDBRefreshObjectData("Posts", myObject);
 Debug.Log("refreshed Object: " + refreshedObj.ToString());

• Delete an Object - HDBDelete

 var result = HelloDBSDK.HDBDelete("Posts", "Abc123Def");
 if(result) { Debug.Log("Object deleted!"); }

• Query Objects - HDBQuery

 List<JSONNode> objectsArray = new List<JSONNode>();
 var objects = HelloDBSDK.HDBQuery("Posts", "DT_createdAt", "");
 
 for(int i=0; i<objects.Count; i++){
   var obj = objects[i];

   // [Query Filters]
   if (obj["NU_likes"] == 123
     || obj["ST_category"] == "Game"
     || obj["AR_likedBy"].ToString().Contains("item1")
   ){ objectsArray.Add(obj); }
 } //./ for
 
 // Show data
 if (objectsArray.Count != 0){
   for (int i = 0; i < objectsArray.Count; i++){
     var obj = objectsArray[i];

     Debug.Log(obj["ST_text"]);
     Debug.Log(obj["BL_aBool"]);

     var date = HelloDBSDK.HDBGetDateFromString(obj["DT_myDate"]);
     Debug.Log(date.ToString("MMM dd, yyyy")); 
     
     // Get image from URL
     StartCoroutine(HelloDBSDK.GetImageFromURL(obj["FL_aFile"], myImage));
  } //./ For
 
 // No results
 } else { Debug.Log("No results!"); }

• Add/Edit an Object - HDBObject

 // Prepare Data
 List parameters = new List();
 parameters.Add(HelloDBSDK.param("tableName", "Posts"));
 parameters.Add(HelloDBSDK.param("ST_text", "Text from Unity Game!"));
 parameters.Add(HelloDBSDK.param("AR_likedBy", HelloDBSDK.HDBGetStringFromArray(myArray))); // Save a List<String>()
 parameters.Add(HelloDBSDK.param("NU_likes", 12.12.ToString())); // Save a Number
 parameters.Add(HelloDBSDK.param("GPS_coords", latitude.ToString() + "," + longitude.ToString())); // Save a GPS Location
 parameters.Add(HelloDBSDK.param("DT_aDate", HelloDBSDK.HDBGetStringFromDate(myDate)));   // Used to save DateTime
 parameters.Add(HelloDBSDK.param("BL_aBool", "1"));  // "0" -> FALSE | "1" -> TRUE
 parameters.Add(HelloDBSDK.param("FL_aFile", fileURL));
 // Save
 var result = HelloDBSDK.HDBObject(parameters);
 if (result.ToString().Contains("ID_id")){
  Debug.Log("OBJECT SAVED/UPDATED: " + result.ToString());
 } 

• Send a Push Notification

 var iosPush = HelloDBSDK.HDBSendiOSPush("Push from Unity!", userPointer["ST_ioDeviceToken"], "chat");
 var anPush = HelloDBSDK.HDBSendAndroidPush("Push from Unity!", userPointer["ST_androidDeviceToken"], "chat");

• Utility functions

• GetImageFromURL();
• HDBGetStringFromArray();
• HDBUploadFile();
• etc...

• Conclusion