HarmonyOS SDK Description

• JVerificationInterface,include SDK All interfaces

Settings Debug Mode

Supported version

Supported since version 1.0.0

API definition

• JVerificationInterface.setDebugMode(enable: boolean)
• Description：
• Settings to open debug Mode.true will print more log information. Recommendation init Call before interface.
• Parameters：
• enable：debug Switches
• Example：

              JVerificationInterface.setDebugMode(true);

        

SDK Initialize

Supported version

Supported since version 1.0.0

API definition

• JVerificationInterface.init(context:common.ApplicationContext, appkey:string, callback:(code:number, msg:string)=>void)
• Description：
• Initialization interface.
• Parameters：
• contextGlobalcontext(Systems get context out of time, need to enter as parameters)
• callback:Return interface
• appkey：Jiguangappkey
• Callback：
• code: Return code.8000 The initialization was successful, the others failed, as detailedError CodeDescription
• msg: ResultsDescription
• Example：

           JVerificationInterface.init(this.getUIContext().getHostContext()!.getApplicationContext(),"你的APPKEY", (code, msg) => {

 });

        

Successful initialization

Supported version

Supported since version 1.0.0

API definition

• JVerificationInterface.isInitSuccess()
• Description：
• Access sdk Identification of success in overall initialization
• Return value
• boolean: true - Success.false - Failed.
• Example：

              let isSuccess = JVerificationInterface.isInitSuccess();

        

Judge whether the network environment supports one-tap login

Supported version

Supported since version 1.0.0

API definition

• async JVerificationInterface.checkVerifyEnable()
• Description：
• The current mobile phone network environment is judged to be usable for authentication.
• Return value：
• Back true delegates can use;return false Other means of verification were suggested.
• Example：

              let verifyEnable = await JVerificationInterface.checkVerifyEnable();

        

Preclaim number

• **SDK Caches the pretake result, and lifts the authorized page at a speed. It is therefore proposed to pull up the authorized page, e.g. by pre-altering this interface to a pre-take number on an open or business entry page. **
• **Request succeeded, do not repeat calls frequently. **
• ** Do not repeat the pre-number or pull up the authorized page interface in the pre-number callback. **

Supported version

Supported since version 1.0.0

API definition

• JVerificationInterface.prelogin(callback:(code:number, msg:string, operatorMsg:string)=>void, timeout = 10000)
• Description：
• Authenticate CurrentCarrierCan the network perform a key?LoginOperation, this method will cache access to number information, raise one-tap loginEfficiency. Suggests to launch one-tap loginThis method is called first.
• Parameters：
• timeOut: Timeout (ms), effective range (ms)5000,30000, if less than equal 5000 Or greater 30000 Take Default 10000. Recommended settings as 5001-10000.
• listenerInterface echoes
• Callback：
• code: Return code.7000 Representative success, others failure, as detailedError CodeDescription
• content: Call result informationDescription
• carrierMsg: CarrierInformation
• Example：

           JVerificationInterface.prelogin((code,msg,operateRet)=>{
 console.log("code:" + code + ", msg:" + msg + ", operateRet:" + operateRet);
 });

        

Let's see if the precept is valid.

Supported version

Supported since version 1.0.0

API definition

• async JVerificationInterface.isValidePreloginCache()
• Description：
• Determines whether the current precept number is valid.
• Return value：
• Back true delegates can use;return false Other means of verification were suggested.
• Example：

              let enable = await JVerificationInterface.isValidePreloginCache();

        

Clear Pretract Cache

Supported version

Supported since version 1.0.0

API definition

• JVerificationInterface.clearPreLoginCache()
• Description：
• Clear sdk failed
• Example：

           JVerificationInterface.clearPreLoginCache();

        

Pull up authorized pages

• ** one-tap loginWe need to rely on pre-number results. If there's no pre-number, one key.Login**
• ** It is proposed to pull up the authorized page, e.g., by pre-altering this interface to a pre-alignment number on the open page or the business entry page, to increase the speed of the authorized page and optimize the experience. **
• ** one-tap loginRequest succeeded, do not repeat calls frequently.CarrierThe number of requests will be limited in unit time. **
• ** Not in one-tap loginRepeats in the return call with the pre-number or pulls up the authorized page interface. **

Supported version

Supported since version 1.0.0

API definition

• JVerificationInterface.loginAuth(settings:JVerificationLoginSettings, callback:(code:number, msg:string, operatorMsg:string)=>void)
• Description：
• Raise one-tap loginPermission page obtained with user authorization loginToken
• Parameters：
• settings：LoginInterface settings.
• callback：LoginThe results are being reversed.
• Callback：
• code: Return code.6000 Representative loginToken failed.6001 Representative loginToken failedDescription
• content: return code explanatory information, if successful, content information representative loginToken。
• carrierReturn: CarrierOutcome information
• Example：

           let settings = new JVerificationLoginSettings();
 JVerificationInterface.loginAuth(settings, (code,msg,operateRet)=>{
 console.log("code:" + code + ", msg:" + msg + ", operateRet:" + operateRet);
 });

        

One-Tap LoginParametersJVerificationLoginSettings

          export class JVerificationLoginSettings {
 autoFinish = true//自动关闭
 timeout = 10*1000//超时时间
 authPageEventListener?:JVAuthPageEventListener//事件listener
 context: UIContext //ui上下文
 navPathStack?: NavPathStack //导航栈，isRouter为false时需要设置；必填 1.2.2版本开始 移动强制要求使用Navigation
 isRouter = true //是否使用router打开，如果需要使用导航模式打开需要设置为false，仅在电信，联通情况下生效

 constructor(context: UIContext) {
 this.context = context;
 }
}

        

Note: Acquire one-tap loginYes. loginToken then return it to the application service and call it from the service provider REST API To get a cell phone number.

Page Time BackJVAuthPageEventListener

          export type JVAuthPageEventListener = (code:number, msg:string)=>void

        

Event codes

Close Authorized Page

Supported version

Supported since version 1.0.0

API definition

• JVerificationInterface.dismissLoginAuthActivity(context: UIContext)
• Parameters：
• contextPageuicontext
• Description：
• CloseLoginMandate page, if the current mandate is in progress loginAuth The interface will trigger immediately. 6002 Cancel the callback.
• Support for movement, connectivity, telecommunications
• Example：

              JVerificationInterface.dismissLoginAuthActivity()

        

Close the privacy protocol second window.

Supported version

Supported since version 1.1.0

API definition

• JVerificationInterface.closeCheckDialog()
• Description：
• Close the privacy protocol second window.
• Access only, telecommunications
• Example：

              JVerificationInterface.closeCheckDialog()

        

Customise authorized page UI styles

Supported version

Supported since version 1.1.0

API definition

• JVerificationInterface.setCustomUIWithConfig(config:JVerifyUIConfig)
• Description：
• Modify the authorized page theme by setCustomUIWithConfig Method changes to authorized page theme, need to loginAuth Call before interface
• Parameters：
• uiConfig: Theme profiler, developer in JVerifyUIConfig.java Category calls the corresponding method to configure the corresponding elements in the authorized page, for details JVerifyUIConfig Configure Element Description。
• Example：

           let builder = new JVerifyUIConfigBuilder();
 builder.enableDialogMode(true).setDialogWidth(275).setDialogHeight(400).setLogoOffsetY(30).setDialogPage(this).setLogBtnOffsetY(30).setLogBtnWidth(150).setPrivacyMargin({left:10, right:20, bottom:20})................................
 let uiconfig:JVerifyUIConfig = builder.build();
 JVerificationInterface.setCustomUIWithConfig(uiconfig);

        

JVerifyUIConfig One-Tap Login-Configure Element Description

• Supported version ：1.1.0
• Use JVerifyUIConfigBuilder Configure Correlation Properties
• Set Mandate Page Background

• One-Tap Login-Blast Window Mode

• Page Background

• One-Tap LoginPage Font

• Safe area and Back button

• logo

• Phone number.

• slogan

• Loginbutton

• Privacy protocol section

• PrivacyBean-Privacy protocol model

• Privacy protocol page

• Privacy protocol double-barrel

• Set Custom UI

• Import one-tap loginDefault pictures used for pages
• Need to SDKImport a picture toAppScope/resources/base/mediaFolder

• Set MoveCarrier UI

Because of movementCarrier SDK Provides a complete set of UIs without being able to remove their UIs and then customize the design, so the move needs to be built using the mobile provided UI builderCarrierUi.

Specific configuration elements readMove UI Configuration Element Description

Description of moving UI configuration elements

• Supported version ：1.1.0
• Use GenAuthThemeConfigBuilder Configure Correlation Properties
• Set the background for moving authorized pages

          cmUIConfig(jgBuilder: JVerifyUIConfigBuilder, isDialog: boolean) {
 let builder = new GenAuthThemeConfigBuilder();
 builder.setNumberMargin({top:100})
 if (isDialog) {
 builder.setWindowMode({ width:'80%', height:'50%' })
 }
 builder.setLogBtnText("登录")
 builder.setLoginBtnTextColor(Color.White)
 builder.setLoginBtnColor(Color.Black)
 jgBuilder.setCmUIConfig(builder);
}

        

• Status Bar

• Service Terms Dialogue

• Mandate Page Layout

• Authorized Page Bar

• Authorization PageLoginbutton

• Authorise Page Privacy Bar

• Blast Window Mode

• Enable Web DOM Storage

• Authorise Language Switches

• Pull up the authorization page.

• Protocol Click to listen

• protocol page off button configuration

• Return key listening

• Authorized button listening

JVerifyUIConfig One-Tap Login-Configure Element Description (disused)

• Set Mandate Page Background
  • Supported version ：1.0.0

• LoginPage Navigation Bar

Number authentication

Supported version

Supported since version 1.0.0

API definition

• JVerificationInterface.getToken(callback:(code:number, msg:string)=>void, timeout = 10000)
• Description：
• Access current online at scheduled time sim Carcass.Carrierand token, the interface return timed out of time if the time is exceeded.
• Parameters：
• timeOut: Timeout (ms), effective range (ms)5000,30000, if less than equal 5000 Or greater 30000 Take Default 10000. Recommended settings as 5001-10000.
• callbackInterface echoes
• Callback：
• code: Return code.2000 Representative success, others failure, as detailedError CodeDescription
• content: when successful token, which can be used to call the cell phone interface.token It is valid for one minute and requires re-acquisition before it can be used. failed
• carrierReturn: CarrierOutcome information
• Example：

           JVerificationInterface.getToken((code,msg,operateRet)=>{
 console.log("code:" + code + ", msg:" + msg + ", operateRet:" + operateRet);
 });