@hmscore/hms-js-base v6.1.0-300

hms-js-base

Contents

1. Introduction
2. Installation Guide
3. Function Definitions & Sample
4. Licencing & Terms

1. Introduction

The SDK provides the ability to use HMS Core with JavaScript under multiple platforms (RN, OHOS, QuickApp, Cordova).

2. Installation Guide

• Go to your project

cd example/

• Install

npm i @hmscore/hms-js-base 

project-name
    |_ node_modules
        |_ ...
        |_  @hmscore/hms-js-base
        |_ ...

• import hms-js-base package to your application

import { hmsjsb, hmsbase } from '@hmscore/hms-js-base'

3. Function Definitions & Sample

• Function Definitions
  • hmsjsb
    • hmsjsb.invoke({apiName, args, success, fail, complete})
    • hmsjsb.on(eventName, callback, eventCallbackMap)
    • hmsjsb.off(eventName, offKey, eventCallbackMap)
    • hmsjsb.init(params)
    • hmsjsb.destroy()
  • hmsbase
    • SharedPreferences
      • hmsbase.setSPvalue({key, value, spname})
      • hmsbase.getSPvalue({key, spname})
      • hmsbase.removeSPvalue({key, spname})
    • base
      • hmsbase.getMetaData({key, packagename})
      • hmsbase.getPackageName()
      • hmsbase.getAppId()
      • hmsbase.getAaId()
      • hmsbase.getUid()
      • hmsbase.getAppVersion()
      • hmsbase.getAgcConfig({key})
      • hmsbase.config({subId})
    • report
      • hmsbase.reportEntry({uri, kitSdkVersion})
      • hmsbase.reportExit({uri, transactId, statusCode, errorCode, kitSdkVersionName})
    • update
      • hmsbase.isJsbKitAvailable({min_api_level})
      • hmsbase.upgrade()
      • hmsbase.reload()
• Sample
  • OHOS example

hmsjsb.invoke({apiName, args, success, fail, complete})

Call the HMS Core method.

The returns of callback & promise are supported. When the paramters contain success/fail/complete, it will return from callbacks, otherwise it will return a promise.

return value： result

example

// callback
hmsjsb.invoke({
  apiName: 'update.availability',
  args: {
    min_api_level: 2,
  },
  success: (result) => {
    console.info(JSON.stringify(result));
  },
  fail: (error) => {
    console.info(JSON.stringify(error));
  }
});

// promise 
hmsjsb.invoke({
  apiName: 'update.availability',
  args: {
    min_api_level: 2,
  }
}).then(res => console.info(JSON.stringify(res)))
.catch(err => console.info(JSON.stringify(err)));

hmsjsb.on(eventName, callback, eventCallbackMap)

listen for HMS Core events. After the interface is called, the listener will start automatically. You can use hmsjsb.off to stop listening.

return value： result

hmsjsb.off(eventName, offKey, eventCallbackMap)

Stop listening for HMS Core events, call it when the page is destroyed.

return value ：result

hmsjsb.init(params)

Before calling the hmsjsb methods,call the method to initialize

Note: Currently only the React Native and OHOS platforms need to call this method, other platforms can ignore it.

return value： result

hmsjsb.destroy()

Before the page is destroyed, call the method to destroy.

Note: Currently only the React Native platform needs to call this method, other platforms can ignore it.

return value： result

hmsbase.setSPvalue({key, value, spname})

SharedPreferences

hmsbase.getSPvalue({key, spname})

Read SharedPreferences value

hmsbase.removeSPvalue({key, spname})

Delete shareapeferences value

hmsbase.getMetaData({key, packagename})

Read metadata

hmsbase.getPackageName()

Get the package name of the third party application

hmsbase.getAppId()

Get the appid of the third party application

hmsbase.getAaId()

Get AAID

hmsbase.getUid()

Get UID, Depends on hms-js-base 5.2.0-300 and bridge-sdk 5.2.0.300

hmsbase.getAppVersion()

Get the application version number, Depends on hms-js-base 5.2.0-300 and bridge-sdk 5.2.0.300

hmsbase.getAgcConfig({key})

Get AGC configuration, Depends on hms-js-base 5.2.0-300 and bridge-sdk 5.2.0.300

hmsbase.config({subId})

Authentication

hmsbase.reportEntry({uri, kitSdkVersion})

Event tracking start

hmsbase.reportExit({uri, transactId, statusCode, errorCode, kitSdkVersionName})

Event tracking end

hmsbase.isJsbKitAvailable({min_api_level})

Check jsb kit api_level >= min_api_level

hmsbase.upgrade()

Upgrade jsb kit

hmsbase.reload()

After the upgrade is successful, reload the new jsb kit to initialize the jsb kit

successCallback : function

success callback.

Kind: global typedef

failCallback : function

fail callback.

Kind: global typedef

completeCallback : function

complete callback.

Kind: global typedef

result : object

the returned value of mothed or callback

Kind: return value

OHOSexample

Define the global variable eventCallbackMap in app.js, and then init hms-js-base at the onCreate method.

import { hmsjsb } from '@hmscore/hms-js-base'
//Define the global
hmsData: {
  eventCallbackMap: {},
}

//init
onCreate() {
  hmsjsb.init(this.hmsData.eventCallbackMap);
}

Subscribe and unsubscribe events, need to match use.

Notes: When the event linstener is no longer needed or the page is destroyed, please stop listening

import router from '@system.router'
import { hmsjsb } from '@hmscore/hms-js-base'

export default {
  data: {
    title: "",
    eventCallbackId: ""
  },
  onInit() {
    //Subscribe
    this.eventCallbackId = hmsjsb.on("onBackground", (result) => {
      console.info("event callback result: " + JSON.stringify(result));
    }, this.$app.$def.hmsData.eventCallbackMap);
  },
  onDestroy() {
    //unsubscribe
    hmsjsb.off("onBackground", this.eventCallbackId,
      this.$app.$def.hmsData.eventCallbackMap);
  }
}

4. Licensing and Terms

hms-js-base SDK uses the Apache 2.0 license.