uni-app Integration

Background information

Add the plugin to your project

1. Create a uni-app project.

   1. If you have not created a uni-app project, see Create a project by using the HBuilder visual interface.

   2. If you already have a project, proceed to the next step.

2. Download the plugin.

   1. Go to the plugin page: Alibaba Cloud Phone Number Verification SDK.

   2. On the right side of the page, click Download for offline packaging to download the plugin.

3. Import the plugin into your project.

   1. In the root directory of your project, create a new folder named nativeplugins. Unzip the downloaded AliCloud-NirvanaPns_x.x.x.zip package and add the extracted plugin folder to the nativeplugins folder.

   2. Open the manifest.json file in the root directory and click App Native Plugin Configuration > Select Local Plugin.

   3. In the Local Plugin Selection dialog box, select the Alibaba Cloud Phone Number Verification SDK checkbox.

   4. Click OK to import the plugin.

Import method

In your vue or nvue file, import the native plugin by using the uni.requireNativePlugin method.

Example

const aLiSDKModule = uni.requireNativePlugin('AliCloud-NirvanaPns');

setAuthSDKInfo (Set secret)

This is a required method.

Before using one-click logon, you must set the secret and ensure that the secret matches your app's bundle ID or package name.

Parameters: setAuthSDKInfo(info)

Example

aLiSDKModule.setAuthSDKInfo("<SDK_INFO>"); // Replace this with the secret you obtained from the console.

accelerateVerify

Accelerates obtaining a mobile number verification token.

• We recommend calling this method 2 to 3 seconds before you call the method to get the mobile number verification token. This buffer allows the method to obtain a temporary credential, a process that typically takes 1 to 3 seconds.

• Avoid calling this method multiple times.

• Calling this method is unnecessary if you get the mobile number verification token immediately after the application starts.

Parameters

Example

aLiSDKModule.accelerateVerify(5000, (result) => {
  console.log(JSON.stringify(result));
  if ("600000" == result.resultCode) {
    console.log("Successfully accelerated the token acquisition for mobile number verification");
  } else {
    console.log("Failed to accelerate token acquisition for mobile number verification, " + result.msg);
  }
});

getVerifyToken

Gets the token for mobile number verification.

Parameters

Example

aLiSDKModule.getVerifyToken(5000, (result) => {
  if ("600000" == result.resultCode) {
    console.log(
      "Successfully obtained the mobile number verification token. You must now use the mobile number and token to perform verification on your server. The SDK's role in the process is complete."
    );
  }
});

getVersion (Get SDK version)

Parameters:getVersion(callback)

Example

aLiSDKModule.getVersion((version) => {
  console.log("The current SDK version number is: " + version);
});

checkEnvAvailable (Environment check)

Checks whether the current environment supports one-click logon or local number verification.

Parameters:checkEnvAvailable(authType, callback)

Example

aLiSDKModule.checkEnvAvailable(2, (result) => {
  if ("600000" == result.resultCode) {
    uni.navigateTo({
      animationDuration: 300,
      url: "../login/login",
    });
  } else {
    console.log("The current environment does not support one-click logon. result = ", JSON.stringify(result));
    uni.showToast({
      icon: "none",
      title: result.msg,
      duration: 3000,
    });
  }
});

getCurrentCarrierName (Get default SIM carrier)

Parameters:getCurrentCarrierName(callback)

Example

aLiSDKModule.getCurrentCarrierName((carrierName) => {
  console.log("The current carrier is: " + carrierName);
});