web-view

接口

[h2]has.ascfweb.navigateTo

has.ascfweb.navigateTo(Object object)

保留当前页面，跳转到应用内的某个页面。但是不能跳转到tabBar页面。使用 has.ascfweb.navigateBack 可以返回到原页面。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

示例：

has.ascfweb.navigateTo({
  url: '/page/path/path?key=1',
  success: () => {
    console.info('navigateTo success');
  },
  fail: (err) => {
    console.error('navigateTo fail', err);
  },
  complete: (res) => {
    console.info('navigateTo complete', res);
  }
});

[h2]has.ascfweb.navigateBack

has.ascfweb.navigateBack(Object object)

关闭当前页面，返回上一页面或多级页面。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

示例：

// 注意：调用 navigateTo 跳转时，调用该方法的页面会被加入堆栈，而 redirectTo 方法则不会。见下方示例代码
// 此处是A页面
has.ascfweb.navigateTo({
  url: 'B?id=1'
});
// 此处是B页面
has.ascfweb.navigateTo({
  url: 'C?id=1'
});
// 在C页面内 navigateBack，将返回A页面
has.ascfweb.navigateBack({
  delta: 2
});

[h2]has.ascfweb.reLaunch

has.ascfweb.reLaunch(Object object)

关闭所有页面，打开到应用内的某个页面。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

示例：

// A页面跳转
has.ascfweb.reLaunch({
  url: 'test?id=1'
});

// B页面
// options内含有路径后携带参数
Page({
  onLoad (option) {
    console.info(option.query);
  }
});

[h2]has.ascfweb.switchTab

has.ascfweb.switchTab(Object object)

如果应用定义了多标签(tab)，即客户端窗口的底部或顶部有可切换页面的标签(tab)，那么可以通过此接口跳转到tabBar页面，同时关闭其他所有非tabBar页面。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

示例：

app.json：

  "tabBar": {
    "list": [{
      "pagePath": "index",
      "text": "首页"
    },{
      "pagePath": "other",
      "text": "其他"
    }]
  }

js代码：

has.ascfweb.switchTab({
  url: '/index'
});

[h2]has.ascfweb.redirectTo

has.ascfweb.redirectTo(Object object)

关闭当前页面，跳转到应用内的某个页面，但是不允许跳转到tabBar页面。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

示例：

has.ascfweb.redirectTo({
  url: 'test?id=1'
});

[h2]has.ascfweb.postMessage

has.ascfweb.postMessage(Object object)

此方法用于网页向元服务发送消息。消息会触发bindmessage上绑定的方法，方法的回调参数为网页postMessage的信息的数组队列。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

示例：

has.ascfweb.postMessage({ data: 'foo' });
has.ascfweb.postMessage({ data: { foo: 'bar' } });
has.ascfweb.postMessage({ data: { foo: 'bar' }, options: { mode: 'realtime' } });

[h2]has.ascfweb.onMessage

has.ascfweb.onMessage(callback: function): void

监听并接受来自postMessage发送过来的消息。

起始版本： 2.0.4

参数：

示例：

has.ascfweb.onMessage((data) => {
  console.info('onMessage, data:', data);
});

[h2]has.ascfweb.getEnv

has.ascfweb.getEnv(function callback)

获取当前环境。以callback形式返回结果。

起始版本： 1.0.4

参数：

callback返回值：

Object类型，包括以下字段。

systemInfo说明：

示例：

has.ascfweb.getEnv(function(res) {
  console.info(res.ascfweb);   // true
  console.info(res.systemInfo);
});

[h2]has.authorize

has.authorize(Object object)

提前向用户发起授权请求。调用后会立刻弹窗询问用户是否同意授权元服务使用某项功能或获取用户的某些数据，但不会实际调用对应接口。如果用户之前已经同意授权，则不会出现弹窗，直接返回成功。

起始版本： 2.0.2

参数：

参数为Object对象，包括以下字段。

在申请权限时，需要在项目的配置文件中，逐个声明需要的权限，否则将无法获取授权。配置方式请参见声明权限。

示例：

has.authorize({
  scope: 'scope.camera',
  success: () => {
    console.info('authorize success');
  },
  fail: (err) => {
    console.error('authorize fail', err);
  },
  complete: (res) => {
    console.info('authorize complete', res);
  }
});

[h2]has.checkJsApi

has.checkJsApi(Object object)

使用checkJsApi判断当前宿主是否支持某些API。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

示例：

has.checkJsApi({
  jsApiList: ['chooseImage', 'previewImage', 'compressImage', 'uploadFile'],
  success(res) {
    console.info('checkJsApi success', res);
  },
  fail(err) {
    console.error('checkJsApi fail', err);
  }
});

[h2]has.chooseImage

has.chooseImage(Object object)

从本地相册选择图片或使用相机拍照。

起始版本： 1.0.4

约束与限制：

当前接口在元服务被嵌入式运行时暂不支持使用，建议规避或替换类似功能接口。

参数：

参数为Object对象，包括以下字段。

success返回值：

示例：

has.chooseImage({
  count: 1, // 默认9
  sizeType: ['original', 'compressed'], // 可以指定是原图还是压缩图，默认二者都有
  sourceType: ['album', 'camera'], // 可以指定来源是相册还是相机，默认二者都有
  success: (res) => {
    console.info('chooseImage success', res.tempFilePaths);
  },
  fail: (err) => {
    console.error('chooseImage fail', err);
  },
  complete: (res) => {
    console.info('chooseImage complete', res);
  }
});

[h2]has.previewImage

has.previewImage(Object object)

在新页面中预览图片，预览的过程中用户可以进行保存图片等操作。

起始版本： 1.0.4

注意事项：在调用此接口时如果需要支持保存网络资源，需要先完成配置服务器域名。

参数：

参数为Object对象，包括以下字段。

示例：

has.previewImage({
  current: '', // 当前显示图片的http链接
  urls: [] // 需要预览的图片http链接列表
});

[h2]has.uploadImage

has.uploadImage(Object object)

将本地图片上传到服务器。

起始版本： 1.0.4

需要权限：在module.json5中声明ohos.permission.INTERNET。

注意事项：在调用此接口前，需要先完成配置服务器域名。

参数：

参数为Object对象，包括以下字段。

示例：

has.chooseImage({
  success (res) {
    const tempFilePaths = res.tempFilePaths;
    has.uploadImage({
      url: 'https://www.example.com', // 此处仅为样例，请开发者更换为可用接口地址
      filePath: tempFilePaths[0],
      name: 'file',
      formData: {
        'user': 'test'
      },
      success: (res) => {
        const data = res.data;
        // do something
      }
    });
  }});

[h2]has.downloadImage

has.downloadImage(Object object)

下载图片资源到本地。

起始版本： 1.0.4

需要权限：在module.json5中声明ohos.permission.INTERNET。

注意事项：在调用此接口前，需要先完成配置服务器域名。

参数：

参数为Object对象，包括以下字段。

示例：

has.downloadImage({
  url: 'https://www.example.com', // 此处仅为样例，请开发者更换为可用接口地址
  success(res) {
    // 只要服务器有响应数据，就会把响应内容写入文件并进入 success 回调，业务需要自行判断是否下载到了想要的内容
    if (res.statusCode === 200) {
      let filePath = res.filePath;
    }
  }
});

[h2]has.getNetworkType

has.getNetworkType(Object object)

获取网络类型。

起始版本： 1.0.4

需要权限： 在module.json5中声明ohos.permission.GET_NETWORK_INFO。

参数：

参数为Object对象，包括以下字段。

success返回值：

示例：

has.getNetworkType({
  success: (res) => {
    const networkType = res.networkType; // 返回网络类型cellular，wifi，bluetooth，ethernet，vpn，none，unknown
    console.info('getNetworkType success', networkType);
  }
});

[h2]has.openLocation

has.openLocation(Object object)

使用引擎内置地图查看具体位置。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

示例：

has.openLocation({
  latitude: 0, // 纬度，浮点数，范围为90 ~ -90
  longitude: 0, // 经度，浮点数，范围为180 ~ -180。
  name: '', // 位置名
  address: '' // 地址详情说明
});

[h2]has.getLocation

has.getLocation(Object object)

获取当前的地理位置、速度。开启高精度定位，接口耗时会增加，可指定highAccuracyExpireTime作为超时时间。

起始版本： 1.0.4

需要权限： 在module.json5中声明ohos.permission.LOCATION和ohos.permission.APPROXIMATELY_LOCATION。

参数：

参数为Object对象，包括以下字段。

success返回值：

示例：

has.getLocation({
  type: 'wgs84', // 默认为wgs84的gps坐标，如果要返回直接给openLocation用的火星坐标，可传入'gcj02'
  success: (res) => {
    let latitude = res.latitude; // 纬度，浮点数，范围为90 ~ -90
    let longitude = res.longitude; // 经度，浮点数，范围为180 ~ -180。
    let speed = res.speed; // 速度，以米/每秒计
    let accuracy = res.accuracy; // 位置精度
  }
});

[h2]has.login

has.login(Object object)

调用接口获取登录凭证（code）。使用该凭证进一步换取用户登录状态信息，包括用户在当前程序中的唯一标识（openid）、平台账号下的唯一标识（unionid）。用户数据的加密与解密通信需要依赖会话密钥来完成。进一步使用时，请参见获取华为账号用户信息。

起始版本： 1.0.9

参数：

参数为Object对象，包括以下字段。

success返回值：

示例：

has.login({
  success: (res) => {
    console.info('login success', res);
  },
  fail: (err) => {
    console.error('login fail', err);
  },
  complete: (res) => {
    console.info('login complete', res);
  }
});

[h2]has.requestPayment

has.requestPayment(Object object)

拉起华为支付或跳转三方支付。使用前请参见华为支付服务-开发准备。

起始版本： 1.0.9

参数：

参数为Object对象，包括以下字段。

success返回值：

拉起华为支付success的返回值为空，跳转三方支付success的返回值包括以下字段。

示例：

拉起华为支付：

has.requestPayment({
  orderStr: 'xxx',
  success: (res) => {
    console.info('requestPayment success', res);
  },
  fail: (err) => {
    console.error('requestPayment fail', err);
  },
  complete: (res) => {
    console.info('requestPayment complete', res);
  }
});

跳转三方支付：

has.requestPayment({
  orderStr: 'xxx',
  payload: 'AP',
  success: (res) => {
    console.info('requestPayment success', res);
  },
  fail: (err) => {
    console.error('requestPayment fail', err);
  },
  complete: (res) => {
    console.info('requestPayment complete', res);
  }
});

[h2]has.cashierPicker

has.cashierPicker(Object object)

拉起通用收银台。

起始版本： 1.0.10

参数：

参数为Object对象，包括以下字段。

success返回值：

示例：

has.cashierPicker({
  tradeSummary: '',
  amount: 100,
  currency: 'CNY',
  extraInfo: '',
  success: (res) => {
    console.info('cashierPicker success', res);
  },
  fail: (err) => {
    console.error('cashierPicker fail', err);
  },
  complete: (res) => {
    console.info('cashierPicker complete', res);
  }
});

[h2]has.requestContract

has.requestContract(Object object)

调起华为支付签约服务。

起始版本： 1.0.10

参数：

参数为Object对象，包括以下字段。

示例：

has.requestContract({
  contractStr: 'xxx',
  success: (res) => {
    console.info('requestContract success', res);
  },
  fail: (err) => {
    console.error('requestContract fail', err);
  },
  complete: (res) => {
    console.info('requestContract complete', res);
  }
});

[h2]has.queryIapEnvStatus

has.queryIapEnvStatus(Object object)

查询用户登录的账号服务地是否在IAP Kit支持结算的国家/地区中。当前只支持中国大陆。

需要权限： 开发前需要配置Client ID、配置签名证书指纹、开通商户服务、开启和激活应用内购买服务。

起始版本： 1.0.10

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

has.queryIapEnvStatus({
  success() {
    console.info('iap is support');
  },
  fail(err) {
    console.error('iap is not support', err);
  }
});

[h2]has.createIap

has.createIap(Object object)

发起购买，支持消耗型商品、非消耗型商品和自动续期订阅商品。在HarmonyOS 开发者中心创建商品后，使用此接口拉起华为应用内支付收银台，显示商品名称、价格等信息。

需要权限： 开发前需要配置Client ID、配置签名证书指纹、开通商户服务、开启和激活应用内购买服务。

起始版本： 1.0.10

参数：

参数为Object对象，包括以下字段。

success返回值：

错误码信息：

示例：

has.createIap({
  // 替换为实际的商品id
  productId: 'product_id',
  productType: 0,
  developerPayload: '',
  reservedInfo: JSON.stringify({ key1: 'value1' }),
  promotionalOfferId: '',
  applicationUserName: '',
  jwsRepresentation: '',
  success(res) {
    console.info('createIap success', res);
  },
  fail(err) {
    console.error('createIap fail', err);
  }
});

[h2]has.finishIap

has.finishIap(Object object)

应用完成已购商品的发货后，调用此接口确认发货，指明此次购买流程结束。

需要权限： 开发前需要配置Client ID、配置签名证书指纹、开通商户服务、开启和激活应用内购买服务。

起始版本： 1.0.10

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

has.finishIap({
  productType: 0,
  // 替换为实际的purchaseToken
  purchaseToken: '***',
  // 替换为实际的purchaseOrderId
  purchaseOrderId: '***',
  success() {
    console.info('finishIap success ');
  },
  fail(err) {
    console.error('finishIap fail', err);
  }
});

[h2]has.queryIap

has.queryIap(Object object)

查询用户已订购商品的购买数据，包括消耗型商品和非消耗型商品，一次请求只能查询一种类型的商品。

• 若查询消耗型商品，IAP仅返回用户已购未消耗的购买数据。若有购买数据返回，说明可能存在因某些异常而导致未进行发货的情况，需要应用判断是否已发货，未发货则需要进行补发货处理。

• 若查询非消耗型商品，IAP返回用户所有已订购商品的购买数据。

需要权限： 开发前需要配置Client ID、配置签名证书指纹、开通商户服务、开启和激活应用内购买服务。

起始版本： 1.0.10

参数：

参数为Object对象，包括以下字段。

success返回值：

错误码信息：

示例：

has.queryIap({
  productType: 0,
  queryType: 1,
  success(res) {
    console.info('queryIap success', res);
  },
  fail(err) {
    console.error('queryIap fail', err);
  }
});

[h2]has.queryIapProducts

has.queryIapProducts(Object object)

获取在HarmonyOS 开发者中心上配置的商品的详情信息。

需要权限： 开发前需要配置Client ID、配置签名证书指纹、开通商户服务、开启和激活应用内购买服务。

起始版本： 1.0.10

参数：

参数为Object对象，包括以下字段。

success返回值：

返回Product数组。

错误码信息：

示例：

has.queryIapProducts({
  productType: 0,
  productIds: ['xxx-1', 'xxx-2'],
  success(res) {
    console.info('queryIapProducts success', res);
  },
  fail(err) {
    console.error('queryIapProducts fail', err);
  }
});

[h2]has.isIapSandboxActivated

has.isIapSandboxActivated(Object object)

检查沙盒测试能力是否生效。

需要权限： 开发前需要配置Client ID、配置签名证书指纹、开通商户服务、开启和激活应用内购买服务。

起始版本： 1.0.10

参数：

参数为Object对象，包括以下字段。

success返回值：

返回boolean，表示沙盒测试能力是否生效。

错误码信息：

示例：

has.isIapSandboxActivated({
  success(res) {
    console.info('isIapSandboxActivated success', res);
  },
  fail(err) {
    console.error('isIapSandboxActivated fail', err);
  }
});

[h2]has.showIapManagedSubscriptions

has.showIapManagedSubscriptions(Object object)

跳转到订阅页或订阅详情页。

需要权限： 开发前需要配置Client ID、配置签名证书指纹、开通商户服务、开启和激活应用内购买服务。

起始版本： 1.0.10

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

has.showIapManagedSubscriptions({
  uiParameter: {
    windowScreenMode: 1
  },
  groupId: 'xxx',
  success() {
    console.info('showIapManagedSubscriptions success');
  },
  fail(err) {
    console.error('showIapManagedSubscriptions fail', err);
  }
});

[h2]has.requestSubscribeMessage

has.requestSubscribeMessage(Object object)

订阅消息。

起始版本： 1.0.10

约束与限制：

当前接口在元服务被嵌入式运行时暂不支持使用，建议规避或替换类似功能接口。

参数：

参数为Object对象，包括以下字段。

success返回值：

示例：

has.requestSubscribeMessage({
  tmplIds: [''],
  success: (res) => {
    console.info('requestSubscribeMessage success', res);
  },
  fail: (err) => {
    console.error('requestSubscribeMessage fail', err);
  },
  complete: (res) => {
    console.info('requestSubscribeMessage complete', res);
  }
});

[h2]has.startRealNameVerification

has.startRealNameVerification(Object object)

提供实名信息验证功能，调用该方法后会拉起实名信息验证授权组件。

起始版本： 1.0.10

依赖关系： HarmonyOS SDK版本≥5.1.1(19)且ROM版本≥5.1.1

参数：

参数为Object对象，包括以下字段。

success返回值：

返回string，代表实名信息验证ID，用于实名信息验证结果查询。

错误码信息：

示例：

has.startRealNameVerification({
  preVerifyId: 'xxx',
  success: (res) => {
    console.info('startRealNameVerification success', res);
  },
  fail: (err) => {
    console.error('startRealNameVerification fail', err);
  },
  complete: (res) => {
    console.info('startRealNameVerification complete', res);
  }
});

[h2]has.startRealNameAuth

has.startRealNameAuth(Object object)

提供实名信息授权功能，调用该方法后会拉起实名信息授权组件。

起始版本： 1.0.10

依赖关系： HarmonyOS SDK版本≥5.1.1(19)且ROM版本≥5.1.1

参数：

参数为Object对象，包括以下字段。

success返回值：

返回string，代表实名信息授权ID，用于实名信息授权结果查询。

错误码信息：

示例：

has.startRealNameAuth({
  success: (res) => {
    console.info('startRealNameAuth success', res);
  },
  fail: (err) => {
    console.error('startRealNameAuth fail', err);
  },
  complete: (res) => {
    console.info('startRealNameAuth complete', res);
  }
});

[h2]has.startFaceVerification

has.startFaceVerification(Object object)

提供人脸核身、实人验证功能，调用该方法后会拉起人脸核身、实人验证组件。

起始版本： 1.0.10

依赖关系： HarmonyOS SDK版本≥5.1.1(19)且ROM版本≥5.1.1

参数：

参数为Object对象，包括以下字段。

success返回值：

返回string，代表验证结果ID，用于人脸核身实人验证结果查询。

错误码信息：

示例：

has.startFaceVerification({
  preVerifyId: 'xxx',
  success: (res) => {
    console.info('startFaceVerification success', res);
  },
  fail: (err) => {
    console.error('startFaceVerification fail', err);
  },
  complete: (res) => {
    console.info('startFaceVerification complete', res);
  }
});

[h2]has.getPhoneNumber

has.getPhoneNumber(Object object):void

拉起获取手机号的功能页。使用前请参见开发前提-获取手机号完成环境配置。在获取到code后，将code传到开发者后台，并在开发者后台调用服务器端接口消费该code来获取用户级凭证，再通过获取用户信息接口，来获取用户手机号。每个code有效期为5min，且只能消费一次。code即是获取用户级凭证接口中需要的授权码（Authorization Code）。

起始版本： 1.0.12

参数：

参数为Object对象，包括以下字段。

success返回值：

fail返回值：

错误码信息：

错误码统一为14000201，表示获取手机号失败，可能原因参考：华为账号服务ArkTS错误码。

示例：

has.getPhoneNumber({
  success: (res) => {
    console.info('getPhoneNumber success', res);
  },
  fail: (err) => {
    console.error('getPhoneNumber fail', err);
  },
  complete: (res) => {
    console.info('getPhoneNumber complete', res);
  }
});

体验示意图如下：

[h2]has.getAvatarInfo

has.getAvatarInfo(Object object): void

拉起获取用户头像的功能页。使用前请参见配置Client-id。

起始版本： 1.0.12

约束与限制：

当前接口在元服务被嵌入式运行时暂不支持使用，建议规避或替换类似功能接口。

参数：

参数为Object对象，包括以下字段。

success返回值：

示例：

has.getAvatarInfo({
  success: (res) => {
    console.info('getAvatarInfo success', res);
  },
  fail: (err) => {
    console.error('getAvatarInfo fail', err);
  },
  complete: (res) => {
    console.info('getAvatarInfo complete', res);
  }
});

体验示意图如下：

[h2]has.getInvoiceTitle

has.getInvoiceTitle(Object object): void

拉起获取发票抬头的功能页。使用前请参见配置Client-id。

起始版本： 1.0.12

参数：

参数为Object对象，包括以下字段。

success返回值：

示例：

has.getInvoiceTitle({
  success: (res) => {
    console.info('getInvoiceTitle success', res);
  },
  fail: (err) => {
    console.error('getInvoiceTitle fail', err);
  },
  complete: (res) => {
    console.info('getInvoiceTitle complete', res);
  }
});

体验示意图如下：

[h2]has.getDeliveryAddress

has.getDeliveryAddress(Object object): void

拉起获取收货地址的功能页。使用前请参见配置Client-id。

起始版本： 1.0.12

参数：

参数为Object对象，包括以下字段。

success返回值：

示例：

has.getDeliveryAddress({
  success: (res) => {
    console.info('getDeliveryAddress success', res);
  },
  fail: (err) => {
    console.error('getDeliveryAddress fail', err);
  },
  complete: (res) => {
    console.info('getDeliveryAddress complete', res);
  }
});

体验示意图如下：

[h2]has.getServiceSubscription

has.getServiceSubscription(Object object): void

拉起订阅服务的功能页。使用前请参见开通推送服务、选用订阅模板。

起始版本： 1.0.12

参数：

参数为Object对象，包括以下字段。

success返回值：

示例：

has.getServiceSubscription({
  tmplIds: [''],
  success: (res) => {
    console.info('getServiceSubscription success', res);
  },
  fail: (err) => {
    console.error('getServiceSubscription fail', err);
  },
  complete: (res) => {
    console.info('getServiceSubscription complete', res);
  }
});

体验示意图如下：

[h2]PurchaseData

包含jws格式的订单信息、订阅状态信息。

起始版本： 1.0.10

[h2]PurchaseOrderPayload

订单信息模型，支持消耗型商品、非消耗型商品和自动续期订阅商品。

起始版本： 1.0.10

[h2]SubGroupStatusPayload

订阅组相关的订阅状态信息。

起始版本： 1.0.10

[h2]SubscriptionStatus

订阅状态信息。

起始版本： 1.0.10

[h2]SubRenewalInfo

订阅的扣费计划信息。

起始版本： 1.0.10

[h2]UIWindowParameter

界面窗口参数。

起始版本： 1.0.10

[h2]Product

包含单个商品详细信息。

起始版本： 1.0.10

[h2]SubscriptionInfo

订阅信息。

起始版本： 1.0.10

[h2]SubscriptionOffer

促销信息。

起始版本： 1.0.10

[h2]PromotionalOffer

订阅商品支持的自定义优惠信息。

起始版本： 1.0.10