Javascript

API client library

Getting started

Install

                        npm i @plentra/sphereclient

                    

Import

                        import { SphereClient } from '@plentra/sphereclient';
                    

Initialization

                        ...
                        let sphereClient = new SphereClient("YOUR-APP-KEY")
                            
                          
                    

Get Home launcher (with 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

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).

sphereClient.getHome({
    onResult( appName  ,  appIcon  ,  totalItemCount  ,  itemsInThisPage  ,  itemsPerPage  ,   items ){
        //do on result
     },
     onLoading(){
        //do when loading
     },
     onLoadfinished(){
        //do when loading finished
     },
     onPopup( popupTitle  ,  popupMessage ){
        //do when popup
     },
     onAnnouncement( announcementBody ){
        //do when announcement
     },
     onMessage( messageTitle  ,  messageBody ){
        //do when message
     },
     onAppLocation( appLocation  ,  latitude  ,  longitude  ){
        //do when app location
     },
     onNextPage(){
        //do when next page exists
     },
     onHomeCover( cover ){
        //do when there is a home cover
     },
     onEmpty(appName , appIcon){
        //do when home launcher items are empty
     },
     onError(error){
        //do when error
     },
     onUnderConstruction(){
        //do when under construction
     },
     onNotActive(){
        //do when app is not active
     },
     onNotExist(){
        //do when app does not exist
     },
     onNotFound(){
        //do when page not found
     },
     onNotAcceptable(){
        //do when there is illegal client request
     },
     onBadRequest(){
        //do when there is bad request from client
     },
     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({
    
    onResult( totalItemCount  ,  itemsInThisPage  ,  itemsPerPage  ,   items ){
        //do on result 
    },
    onLoading(){
        //do when loading
    },
    onLoadfinished(){
        //do when loading finished
    },
    onNextPage(){
        //do when next page exists
    },
    onEmpty(){
        //do when home launcher items are empty
    },
    onError(error){
        //do when error
    },
    onUnderConstruction(){
        //do when under construction
    },
    onNotActive(){
        //do when app is not active
    },
    onNotExist(){
        //do when app does not exist
    },
    onNotFound(){
        //do when page not found
    },
    onNotAcceptable(){
        //do when there is illegal client request
    },
    onBadRequest(){
        //do when there is bad request from client
    },
    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(categoryId , {

    onResult( appName ,  appIcon  ,  categoryName, categoryIcon ,   totalItemCount ,  itemsInThisPage ,  itemsPerPage ,  items){
        //do on result
    },
    onLoading(){
        //do when loading
    },
    onLoadfinished(){
        //do when loading finished
    },
    onAnnouncement( announcementBody ){
        //do when announcement
    },
    onAppLocation( appLocation  ,  latitude  ,  longitude  ){
        //do when app location
    },
    onNextPage(){
        //do when page exists
    },
    onHomeCover( cover ){
        //do when there is a home cover
    },
    onEmpty(appName ,  appIcon  ,  categoryName, categoryIcon){
        //do when items are empty
    },
    onError(error){
        //do when error
    },
    onUnderConstruction(){
        //do when construction
    },
    onNotActive(){
        //do when app is not active
    },
    onNotExist(){
        //do when app does not exist
    },
    onNotFound(){
        //do when page not found
    },
    onNotAcceptable(){
        //do when there is illegal client request
    },
    onBadRequest(){
        //do when there is bad request from client
    },
    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(categoryId , {

    onResult(totalItemCount ,  itemsInThisPage ,  itemsPerPage ,  items){
        //do on result 
    }, 
    onLoading(){
        //do when loading
    },
    onLoadfinished(){
        //do when loading finished
    },
    onNextPage(){
        //do when next page exists
    },
    onEmpty(){
        //do when items are empty
    },
    onError(error){
        //do when error
    },
    onUnderConstruction(){
        //do when construction
    },
    onNotActive(){
        //do when app is not active
    },
    onNotExist(){
        //do when app does not exist
    },
    onNotFound(){
        //do when page not found
    },
    onNotAcceptable(){
        //do when there is illegal from client
    },
    onBadRequest(){
        //do when there is bad request from client
    },
    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(launcherId , {

    onResult( appName ,  appIcon  ,  launcherName, launcherIcon ,   totalItemCount ,  itemsInThisPage ,  itemsPerPage ,  items ){
        //do on result 
    },
    onLoading(){
        //do when loading
    },
    onLoadfinished(){
        //do when loading finished
    },
    onAnnouncement( announcementBody ){
        //do when announcement
    },
    onAppLocation( appLocation  ,  latitude  ,  longitude  ){
        //do when app location
    },
    onNextPage(){
        //do when next page exists
    },
    onLauncherCover( cover ){
        //do when there is launcher cover
    },
    onEmpty(appName ,  appIcon  ,  launcherName, launcherIcon){
        //do when launcher items are empty
    },
    onError(error){
        //do when error
    },
    onUnderConstruction(){
        //do when under construction
    },
    onNotActive(){
        //do when app is not active
    },
    onNotExist(){
        //do when app does not exist
    },
    onNotFound(){
        //do when page not found
    },
    onNotAcceptable(){
        //do when there is illegal client request
    },
    onBadRequest(){
        //do when there is bad request from client
    },
    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(launcherId , {

    onResult(totalItemCount ,  itemsInThisPage ,  itemsPerPage ,  items ){
        //do on result
    },
    onLoading(){
        //do when loading
    },
    onLoadfinished(){
        //do when loading finished
    },
    onNextPage(){
        //do when next page exists
    },
    onEmpty(){
        //do when launcher items are empty
    },
    onError(error){
        //do when error
    },
    onUnderConstruction(){
        //do when under construction
    },
    onNotActive(){
        //do when app is not active 
    },
    onNotExist(){
        //do when app does not exist 
    },
    onNotFound(){
        //do when page not found
    },
    onNotAcceptable(){
        //do when there is illegal client request
    },
    onBadRequest(){
        //do when there is bad request from client
    },
    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(id , {

        onResult(appName , appIcon   , itemName ,extras  , body ,itemCategoryName ,itemImages , itemImage){
            //do on result 
        },
        onLoading(){
            //do when loading
        },
        onLoadfinished(){
            //do when loading finished
        },
        onAnnouncement(announcementBody){
            //do when announcement
        },
        onAppLocation(appLocation ,latitude ,longitude ){
            //do when app location
        },
        onHomeCover(cover){
            //do when there is home cover
        },
        onError(error){
            //do when error
        },
        onUnderConstruction(){
            //do when under construction
        },
        onNotActive(){
            //do when app is not active
        },
        onNotExist(){
            //do when app does not exist
        },
        onNotFound(){
            //do when page not found
        },
        onNotAcceptable(){
            //do when there is illegal client request
        },
        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