This HelloTodo sample contains an Android project that communicates with a StrongLoop-based mobile backend created with the MobileFirst Services Starter boilerplate on IBM® Bluemix®.
You can either watch the video tutorial or follow the instructions that take you step-by-step through the process of creating a mobile backend and running the sample.
Before you start, make sure that you have:
- A Bluemix account
- Android Studio
->
<-
We're working on creating a video tutorial. It will be published when it's ready.
Use the following steps to configure the helloTodo sample for Android:
- Download the helloTodo sample
- Configure the mobile backend for your helloTodo application
- Configure the front end in the helloTodo sample
- Run the helloTodo sample application
Clone the sample from Github with the following command:
git clone https://github.com/ibm-bluemix-mobile-services/bms-samples-android-hellotodo
Before you can run the helloTodo application, you must set up a mobile backend for your app on Bluemix.
If you have already created a mobile backend with the MobileFirst Services Starter boilerplate, you might want to skip to the Configuring the front end in the helloTodo sample section.
The following procedure shows you how to create a MobileFirst Services Starter application. Using the boilerplate to create your app automatically performs the following actions:
- Provisions a Node.js runtime and populates it with with a default helloTodo application that was created with StrongLoop. This application uses the LoopBack framework to expose the
/api/ItemsAPI, which is used by both the Web UI and the helloTodo app sample from this Github repository. - Adds the following services to the app: Cloudant® NoSQL DB, IBM Push Notifications, and Mobile Client Access.
- In the Boilerplates section of the Bluemix catalog, click MobileFirst Services Starter.
- Enter a name and host for your mobile backend and click Create.
- Click Finish.
- Get information about your app.
After the provisioning process is complete, you will see a a page for your newly provisioned mobile backend. Click the Mobile Options link in top right part of a screen to find your appRoute and appGUID. Keep this screen open in your browser; you will need these parameters in the next steps.
- Open the appRoute URL that you copied from the Bluemix dashboard in your browser. You will see the web interface for the helloTodo backend.
- Start by following the guided experience steps that are described in the web UI.
Eventually, you will try to DELETE a todo item and will discover that this action can only be complete when using the helloTodo mobile apps sample from this Github repository.The mobile backend is protected by a Mobile Client Access by default. Mobile Client Access is a Bluemix service that provides security and monitoring functionality for mobile backend applications.
Tip: Click the View API Reference button on web UI to see the API specs.
- Using Android Studio, open the
bms-samples-android-hellotododirectory where the project was cloned. - Run a Gradle sync (usually starts automatically) to import the required
coreSDK. You can view thebuild.gradlefile in thehelloTodo\app\directory. This file contains:
compile group: 'com.ibm.mobilefirstplatform.clientsdk.android',
name: 'core',
version: '2.+',
ext: 'aar',
transitive: trueThis section in build.gradle file tells Android Studio to automatically download the Bluemix Mobile Services Core SDK and add it to the project.
- After the gradle sync completes, open the
MainActivity.javafile and locate thetryblock within theonCreate()function. - In the
BMSClient.getInstance().initialize()function, replace the<APPLICATION_ROUTE>and<APPLICATION_ID>values with the application route and ID you were given when creating your application on Bluemix.
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
client = BMSClient.getInstance();
try {
client.initialize(getApplicationContext(), "<APPLICATION_ROUTE>", "<APPLICATION_ID>", BMSClient.REGION_US_SOUTH);
} catch (MalformedURLException e) {
throw new RuntimeException(e);
}
} Note: If your Bluemix app is not hosted in US_SOUTH, be sure to update the region parameter appropriately: BMSClient.REGION_SYDNEY or BMSClient.REGION_UK.
In Android Studio, click Run > Run.
The helloTodo sample is a single view application with a simple list of to do items. If you previously added data through your web application, you will see the data is automatically pulled into the application.
You can create, add and modify items directly in the application. This sample uses Bluemix Mobile Services SDK, which knows how to handle Mobile Client Access security. Therefore, unlike the web application, you can also DELETE items from mobile app by swiping them. You can also mark items as completed by clicking to the left of the corresponding to do item. When you update an item in the mobile app it will automatically be updated in the web app (you need to refresh the web app). If you make a change in the web UI and want to see it reflected in the mobile app, pull down the todo list to refresh.
As you recall, the DELETE endpoint can only be accessed by mobile applications because it is protected by the Mobile Client Access service.
By default, Mobile Client Access is not configured to require any interactive authentication (for example, to ask for username and password).
The next step is to learn how to configure authentication with the Mobile Client Access dashboard and instrument your app with required components. For more information, see the Mobile Client Access documentation and HelloAuthentication sample.
This package contains sample code provided in source code form. The samples are licensed under the under the Apache License, Version 2.0 (the "License"). You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 and may also view the license in the license.txt file within this package. Also see the notices.txt file within this package for additional notices.