Android

API client library

Getting started

Install

Step 1. Add the JitPack repository to your build file

                      allprojects {
                        repositories {
                            ...
                            maven { url 'https://jitpack.io' }
                        }
                     }
                    

Step 2. Add the dependency

                      dependencies {
                        implementation 'com.github.plentra:sphereclient:1.0.4'
                }
                    

Initialization

                      ...
                      import com.plentra.sphereclient.SphereClient;
                      ...
                      
                      SphereClient sphereclient;
                      
                      class YOUR_CLASS_NAME extends PARENT_CLASS { 
                      ...
                          sphereClient = new SphereClient("YOUR_APP_KEY")
                      
                      
                      }
                          
                    

Get Home Launcher (with launcher items)

Home launcher is the main launcher of your app containing launcher items that link to either items belonging to a particular category or a sub launcher.It also acts as a source for special features such as popup and message (It is intended to launch during the initial launch of your application).

Accessing the home launcher

You can access home launcher properties by calling getHome method on the sphereClient object.The getHome method has single argument that accepts GetHome interface.

                      sphereClient.getHome(new GetHome() {

                        @Override
                        public void onResult(String appName, String appIcon, int totalItemCount, int itemsInThisPage, int itemsPerPage, HomeItems[] items) {
                        //do on result
                        }
                    
                        @Override
                        public void onLoading() {
                        //do when loading
                        }
                    
                        @Override
                        public void onLoadfinished() {
                        //do when loading finished
                        }
                    
                        @Override
                        public void onPopup(String popupTitle , String popupBody) {
                        //do when popup
                        }
                    
                        @Override
                        public void onAnnouncement( String announcementBody) {
                        //do when announcement
                        }
                    
                        @Override
                        public void onMessage(String messageTitle , String messageBody) {
                        //do when message
                        }
                    
                        @Override
                        public void onAppLocation(String appLocation, double latitude, double longitude) {
                        //do when app location
                        }
                    
                        @Override
                        public void onNextPage() {
                        //do when next page exists
                        }
                    
                        @Override
                        public void onHomeCover(String cover) {
                        //do when there is a home cover
                        }
                    
                        @Override
                        public void onEmpty(String appName, String appIcon) {
                        //do when home launcher items are empty
                        }
                    
                        @Override
                        public void onError(VolleyError error) {
                        //do when error
                        }
                    
                        @Override
                        public void onUnderConstruction() {
                        //do when under construction
                        }
                    
                        @Override
                        public void onNotActive() {
                        //do when app is not active
                        }
                    
                        @Override
                        public void onNotExist() {
                        //do when app does not exist
                        }
                    
                        @Override
                        public void onNotFound() {
                        //do when page not found
                        }
                    
                        @Override
                        public void onNotAcceptable() {
                        //do when there is illegal client request
                        }
                    
                        @Override
                        public void onBadRequest() {
                        //do when there is bad request from client
                        }
                    
                        @Override
                        public void onNoNextPage() {
                        //do when there is no next page
                        }
                     });
                    
                    

GetHome interface methods

Accessing more home launcher items

You can access home launcher properties by calling getLauncherLoadMore method on the sphereClient object.The getHomeLoadMore method has single argument that accepts GetHomeLoadMore interface.

sphereClient.getHomeLoadMore(new GetHomeLoadMore() {

  @Override
  public void onResult(int totalItemCount, int itemsInThisPage, int itemsPerPage, HomeItems[] items) {
  //do on result
  }

  @Override
  public void onLoading() {
  //do when loading
  }

  @Override
  public void onLoadfinished() {
  //do when loading finished
  }

  @Override
  public void onNextPage() {
  //do when next page exists
  }

  @Override
  public void onEmpty() {
  //do when home launcher items are empty
  }

  @Override
  public void onError(VolleyError error) {
  //do when error
  }

  @Override
  public void onUnderConstruction() {
  //do when under construction
  }

  @Override
  public void onNotActive() {
  //do when app is not active
  }

  @Override
  public void onNotExist() {
  //do when app does not exist
  }

  @Override
  public void onNotFound() {
  //do when page not found
  }

  @Override
  public void onNotAcceptable() {
  //do when there is illegal client request
  }

  @Override
  public void onBadRequest() {
  //do when there is bad request from client
  }

  @Override
  public void onNoNextPage() {
  //do when there is no next page
  }
});

                  

GetHomeLoadMore interface methods

Get items belonging to a category

Every item you add is linked to a category.

Accessing the items belonging to a category

You can access all the items belonging to a category by calling getItems method on the sphereClient object.The getItems method has two arguments that accepts getItems interface and item category id .

                    sphereClient.GetItems(new GetItems() {

                      @Override
                      public void onResult(String appName, String appIcon, String categoryName, String categoryIcon, int totalItemCount, int itemsInThisPage, int itemsPerPage, Items[] items) {
                      //do on result
                      }
                  
                      @Override
                      public void onLoading() {
                      //do when loading
                      }
                  
                      @Override
                      public void onLoadfinished() {
                      //do when loading finished
                      }
                  
                      @Override
                      public void onAnnouncement( String announcementBody) {
                      //do when announcement
                      }
                  
                      @Override
                      public void onAppLocation(String appLocation, double latitude, double longitude) {
                      //do when app location
                      }
                  
                      @Override
                      public void onNextPage() {
                      //do when next page exists
                      }
                  
                      @Override
                      public void onHomeCover(String cover) {
                      //do when there is a home cover
                      }
                  
                      @Override
                      public void onEmpty(String appName, String appIcon, String categoryName, String categoryIcon) {
                      //do when items are empty
                      }
                  
                      @Override
                      public void onError(VolleyError error) {
                      //do when error
                      }
                  
                      @Override
                      public void onUnderConstruction() {
                      //do when under construction
                      }
                  
                      @Override
                      public void onNotActive() {
                      //do when app is not active
                      }
                  
                      @Override
                      public void onNotExist() {
                      //do when app does not exist
                      }
                  
                      @Override
                      public void onNotFound() {
                      //do when page not found
                      }
                  
                      @Override
                      public void onNotAcceptable() {
                      //do when there is illegal client request
                      }
                  
                      @Override
                      public void onBadRequest() {
                      //do when there is bad request from client
                      }
                  
                      @Override
                      public void onNoNextPage() {
                      //do when there is no next page
                      }
                   });
                  

GetItems interface methods

Accessing more items belonging to a category

You can access more items belonging to a category by calling getItemsLoadMore method on the sphereClient object.This iterates the next page available and loads the properties of that page everytime this method is called.The getItemsLoadMore method has two arguments that accepts GetItemsLoadMore interface and category id.

sphereClient.GetItemsLoadMore(new GetItemsLoadMore() {

  @Override
  public void onResult(int totalItemCount, int itemsInThisPage, int itemsPerPage, Items[] items) {
  //do on result
  }

  @Override
  public void onLoading() {
  //do when loading
  }

  @Override
  public void onLoadfinished() {
  //do when loading finished
  }

  @Override
  public void onNextPage() {
  //do when next page exists
  }


  @Override
  public void onEmpty() {
  //do when items are empty
  }

  @Override
  public void onError(VolleyError error) {
  //do when error
  }

  @Override
  public void onUnderConstruction() {
  //do when under construction
  }

  @Override
  public void onNotActive() {
  //do when app is not active
  }

  @Override
  public void onNotExist() {
  //do when app does not exist
  }

  @Override
  public void onNotFound() {
  //do when page not found
  }

  @Override
  public void onNotAcceptable() {
  //do when there is illegal client request
  }

  @Override
  public void onBadRequest() {
  //do when there is bad request from client
  }

  @Override
  public void onNoNextPage() {
  //do when there is no next page
  }
});
                  

GetItemsLoadMore interface methods

Get Sub launcher

Just like the home launcher the sub launcher contains launcher items that are linked either to a category or other sub launcher.

Accessing the sub launcher

You can access all the properties of sub launcher by calling getLauncher method on the sphereClient object.The getLauncher method has two arguments that accepts getLauncher interface and launcher id

sphereClient.GetLauncher(new GetLauncher() {

  @Override
  public void onResult(String appName, String appIcon, String launcherName, String launcherIcon, int totalItemCount, int itemsInThisPage, int itemsPerPage, LauncherItems[] items) {
  //do on result
  }

  @Override
  public void onLoading() {
  //do when loading
  }

  @Override
  public void onLoadfinished() {
  //do when loading finished
  }

  @Override
  public void onAnnouncement( String announcementBody) {
  //do when announcement
  }

  @Override
  public void onAppLocation(String appLocation, double latitude, double longitude) {
  //do when app location
  }

  @Override
  public void onNextPage() {
  //do when next page exists
  }

  @Override
  public void onLauncherCover(String cover) {
  //do when there is launcher cover
  }

  @Override
  public void onEmpty(String appName, String appIcon, String launcherName, String launcherIcon) {
  //do when launcher items are empty
  }

  @Override
  public void onError(VolleyError error) {
  //do when error
  }

  @Override
  public void onUnderConstruction() {
  //do when under construction
  }

  @Override
  public void onNotActive() {
  //do when app is not active
  }

  @Override
  public void onNotExist() {
  //do when app does not exist
  }

  @Override
  public void onNotFound() {
  //do when page not found
  }

  @Override
  public void onNotAcceptable() {
  //do when there is illegal client request
  }

  @Override
  public void onBadRequest() {
  //do when there is bad request from client
  }

  @Override
  public void onNoNextPage() {
  //do when there is no next page
  }
});

                  

GetLauncher interface methods

Accessing more sub launcher items

You can access more sub launcher items by calling getLauncherLoadMore method on the sphereClient object.This iterates the next page available and loads the properties of that page everytime this method is called.The getLauncherLoadMore method has two arguments that accepts GetLauncherLoadMore interface and launcher id.

sphereClient.GetLauncherLoadMore(new GetLauncherLoadMore() {

  @Override
  public void onResult(int totalItemCount, int itemsInThisPage, int itemsPerPage, LauncherItems[] items) {
  //do on result
  }

  @Override
  public void onLoading() {
  //do when loading
  }

  @Override
  public void onLoadfinished() {
  //do when loading finished
  }

  @Override
  public void onNextPage() {
  //do when next page exists
  }

  @Override
  public void onEmpty() {
  //do when launcher items are empty
  }

  @Override
  public void onError(VolleyError error) {
  //do when error
  }

  @Override
  public void onUnderConstruction() {
  //do when under construction
  }

  @Override
  public void onNotActive() {
  //do when app is not active
  }

  @Override
  public void onNotExist() {
  //do when app does not exist
  }

  @Override
  public void onNotFound() {
  //do when page not found
  }

  @Override
  public void onNotAcceptable() {
  //do when there is illegal client request
  }

  @Override
  public void onBadRequest() {
  //do when there is bad request from client
  }

  @Override
  public void onNoNextPage() {
  //do when there is no next page
  }
});

                

GetLauncherLoadMore interface methods

Get item

Accessing the item

You can access all the item properties by calling GetItem method on the sphereClient object.The GetItem method has two arguments that accepts getItem interface and item id.

sphereClient.GetItem(new GetItem() {

  @Override
  public void onResult(String appName, String appIcon, String itemName, JSONObject extras_, String body, String itemCategoryName, JSONObject itemImages_, String itemImage) {
  //do on result
  }

  @Override
  public void onLoading() {
  //do when loading
  }

  @Override
  public void onLoadfinished() {
  //do when loading finished
  }

  @Override
  public void onAnnouncement( String announcementBody) {
  //do when announcement
  }

  @Override
  public void onAppLocation(String appLocation, double latitude, double longitude) {
  //do when app location
  }


  @Override
  public void onHomeCover(String cover) {
  //do when there is home cover
  }

  @Override
  public void onError(VolleyError error) {
  //do when error
  }

  @Override
  public void onUnderConstruction() {
  //do when under construction
  }

  @Override
  public void onNotActive() {
  //do when app is not active
  }

  @Override
  public void onNotExist() {
  //do when app does not exist
  }

  @Override
  public void onNotFound() {
  //do when page not found
  }

  @Override
  public void onNotAcceptable() {
  //do when there is illegal client request
  }

  @Override
  public void onBadRequest() {
  //do when there is bad request from client
  }

});
              

GetItem interface methods

A private limited company, incorporated under the Companies Act, 2013

Registered office: No. 69, Vinobha Nagar, K G Halli, Venkateshpura, Bangalore North, Bangalore-560045, Karnataka, India.

Privacy Policy Terms and Conditions Refund Policy

Copyright Ⓒ 2023 Plentra Technologies Pvt Ltd