Welcome to CMLiveDeal Customer Android Mobile Application’s documentation!¶
CM Live Deal is a Joomla! component for providing free coupons developed by CMExtension, for more information of CM Live Deal please check its documation.
Customer Android mobile application for CM Live Deal gives customers ability to browser for deals right on their mobile devices, capture coupons and redeem coupons at merchants.
This documentation is for version 0.0.1 of CM Live Deal Customer application for Android.
Contents:
Requirements & Downloads¶
In order to work with CM Live Deal Customer Android application and make it connect to your Joomla! website, you need Android Stuido IDE and CM Mobile Joomla! component.
You can use any version of Android Studio, but it is recommended to use the latest verion.
Please refer to the below table for compatible versions of CM Live Deal and CM Mobile.
| Customer Android app | CM Live Deal | CM Mobile |
|---|---|---|
| 0.0.1 | 1.2.1 | 0.0.4 |
For example, if you use Customer Android application version 0.0.1, you will need to use it together with CM Live Deal 1.2.1 and CM Mobile 0.0.4.
Android Studio¶
Android Studio is the official Integrated Development Environment (IDE) for Android from the Android team. It is built on the popular IntelliJ IDEA (Community Edition) Java IDE.
CM Live Deal Customer application is built as an Android Studio project so you need Android Studio work with the application. Eclipse IDE is not supported.
To download Android Studio or find out more info, please visit Android Developers website.
Please note that this documentation doesn’t cover how to use Android Studio or how to program in Java programming language.
CM Mobile¶
CM Live Deal doesn’t have any function to communicate with external applications like mobile applications, CM Mobile is developed to not only help CM Live Deal on this but also give other Joomla! components the same ability.
You can find CM Mobile’s documentation at Read The Docs, and download its Joomla! package as well as its source code at Github. You should download and use the latest version of CM Mobile.
CM Live Deal Customer Android application¶
If you have an active subscription for CM Live Deal at CMExtension’s wesite, you can download the Android Studio project of CM Live Deal Customer application in CM Live Deal’s download area.
Configuration¶
CM Mobile¶
Please check CM Mobile’s documentation for how to confige CM Mobile.
The following settings need to be applied the same in CM Live Deal Customer application: HTTP request method, Allowed user agent, Secret key.
CM Live Deal Customer Android application¶
First setup¶
After downloading the ZIP file of the project from our website, you extract the file on your component and open the project with your Android Studio. For example, with Android Studio’s startup dialog, you select “Open an existing Android Studio project”.
The project is linked to our Android SDK on our computer so Android Studio will detect that the path to our computer’s Android SDK doesn’t exist on your component, it will automatically sync the project with your computer’s Android SDK.
Android Studio will check and updating required libraries in background tasks, you need to wait until the tasks are finished.
There could be some additional tasks depending on your Android Studio. For example you may need to install Build Tools 20.0.0 if you use an older version.
Now you can try the application with emulator or with your real Android device.
However, the application uses the data on our demo site, please check the next section to know how to connect with your Joomla! website.
Try with your own site¶
To connect the application to your Joomla!, you need to modify some settings in app/src/main/java/vn/cmext/cmlivedealcustomer/Constants.java
You need to change SITE_URL variable to your site’s URL. The URL must contain “index.php” at the end.
If in CM Mobile’s configuration, you use GET method, you set METHOD variable to 1. But if you use POST, you set the variable to 2.
Set USER_AGENT variable to the string you use for “Allowed user agent” option in CM Mobile’s configuration.
Set SECRET_KEY variable to the string you use for “Secret key” option in CM Mobile’s configuration.
You can try the application again, it should connect to your Joomla! and get the data from your CM Live Deal, now you can start customizing the application to suit your needs.