Skip to content

Latest commit

 

History

History
113 lines (90 loc) · 3.29 KB

README.md

File metadata and controls

113 lines (90 loc) · 3.29 KB
Raw

VolleyJoomla

Android library that provides an extension to Volley that create several requests to interact with a JoomlaAPI to retrieve categories and articles. The goal is to simple extend existing requests to create faster new ones.

Changelog

Latest version: 1.0.0 (14.05.2014)

Login Example

private void loginToJoomla() {
  	// SETUP YOU WEBSITE DATA WHICH ARE PREVIOUSLY SET ON YOUR JOOMLA API
  	final String host = "http://www.MY-JOOMLA-PAGE.com";
  	final String username = "api_user";
	final String password = "api_password";
  	final String uuid = "api_user_id";

  	// PREPARE YOUR CALLBACK LISTENER
  	final Listener<JConfiguration> onLoginSuccessListener = new Listener<JConfiguration>(){
		@Override
		public void onResponse( JConfiguration configuration ) {
			// THE CONFIGURATION OBJECT IS YOUR AUTHORISATION FOR MORE REQUESTS
		}
	};
	
	final ErrorListener onErrorListener = new ErrorListener(){
  		@Override
  		public void onErrorResponse(VolleyError error) {
	  
  		}
	};

  	// CREATE YOUR WEBSITE AND LOGIN REQUEST
	final JWebsite website = new JWebsite(host, username, password, uuid);
	final Request<?> request = new JLoginRequest( website, onLoginSuccessListener, onErrorListener );
  	final RequestQueue queue = Volley.newRequestQueue( this );
  	queue.add( request );
}

Category Example

private void showJoomlaCategories( JConfiguration configuration ) {
	// PREPARE YOUR CALLBACK LISTENER
  	final Listener<JCategory[]> onCategoriesLoadedListener = new Listener<JCategory[]>(){
		@Override
		public void onResponse( JCategory[] categories ) {
			// DO SOMETHING WITH THE CATEGORIES
		}
	};
	
	final ErrorListener onErrorListener = new ErrorListener(){
  		@Override
  		public void onErrorResponse(VolleyError error) {
	  
  		}
	};
	
	// CREATE THE REQUEST
	final Request<?> request = new JCategoriesRequest( configuration, onCategoriesLoadedListener, onErrorListener )
	final RequestQueue queue = Volley.newRequestQueue( this );
  	queue.add( request );
}

Pojos and Requests

Available requests:

  • JLoginRequest
  • JCategoriesRequest
  • JArticlesRequest
  • JArticleDetailsRequest
  • JRequest
  • GsonJRequest

Already existing POJOS:

  • JWebsite
  • JConfiguration
  • JCategory
  • JArticle

All POJOS except the JWebsite class implement the Parcelable interface and be simple transfered between Activities or Fragments.

private void showDetails( JConfiguration configuration, JArticle article ) {
	Intent details = new Intent( context, ArticleDetailsActivity.class );
	details.putExtra( "my_config", configuration );
	details.putExtra( "my_article", article );
	startActivity( details );
}

The JWebsite object is only needed for the login process and stored no password. The JConfiguration object is bound to one website and can be reused for all requests to this bound website.

Required external libraries

License

Apache License v2

See LICENSE for full license text.