@plentra/sphereclient-nigeria
TypeScript icon, indicating that this package has built-in type declarations

1.5.2 • Public • Published

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
     },
  }
)

please refer to the complete JavaScript documentation at https://sphere.plentratechnologies.com/jsdocs/.

Package Sidebar

Install

npm i @plentra/sphereclient-nigeria

Weekly Downloads

0

Version

1.5.2

License

MIT

Unpacked Size

462 kB

Total Files

158

Last publish

Collaborators

  • plentra