cloudCommon (公共模块)

导入模块

import { cloudCommon } from '@kit.CloudFoundationKit';

cloudCommon.init

init(options?: CloudOptions): void

初始化云开发服务。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.DeviceCloudGateway.CloudFoundation

起始版本：5.0.0(12)

参数：

错误码：

以下错误码的详细介绍请参见ArkTS错误码。

示例：

import { cloudCommon } from '@kit.CloudFoundationKit';
import { request } from '@kit.BasicServicesKit';

cloudCommon.init({
  region: cloudCommon.CloudRegion.CHINA,
  functionOptions: {timeout: 10 * 1000},
  storageOptions: {mode: request.agent.Mode.BACKGROUND, network: request.agent.Network.ANY},
  databaseOptions: {schema: "schema", traceId: "traceId"}
})

CloudOptions

初始化选项。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.DeviceCloudGateway.CloudFoundation

起始版本：5.0.0(12)

CloudRegion

枚举， 存储地类型。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.DeviceCloudGateway.CloudFoundation

起始版本：5.0.0(12)

AuthProvider

认证提供方。您可以使用AGC认证服务SDK获取AuthProvider，或者使用华为账号服务Access Token接口自定义AuthProvider。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.DeviceCloudGateway.CloudFoundation

起始版本：5.0.0(12)

[h2]getAccessToken

getAccessToken(isForceRefresh: boolean): Promise<string>

获取用户凭据。使用Promise异步回调。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.DeviceCloudGateway.CloudFoundation

起始版本：5.0.0(12)

参数：

返回值：

示例：

• （推荐）方式一：使用AGC认证服务SDK获取AuthProvider
  1. 在应用级（一般为entry目录下）“oh-package.json5”文件里面添加认证服务SDK依赖。

     "dependencies": {
       "@hw-agconnect/auth": "^1.0.2"
     } 

  2. 使用手机、邮箱或华为账号进行登录认证，认证成功后获取AuthProvider。

     import { cloudCommon } from '@kit.CloudFoundationKit';
     import auth from '@hw-agconnect/auth';
     import { request } from '@kit.BasicServicesKit';
     
     let authProvider =  auth.getAuthProvider();
     cloudCommon.init({
       region: cloudCommon.CloudRegion.CHINA,
       authProvider: authProvider,
       functionOptions:{timeout:10*1000},
       storageOptions:{mode:request.agent.Mode.BACKGROUND, network:request.agent.Network.ANY},
       databaseOptions:{schema:"schema", traceId:"traceId"}
     })

• 方式二：使用华为账号服务的获取用户级凭证接口自定义AuthProvider

  import { cloudCommon } from '@kit.CloudFoundationKit';
  import { http } from '@kit.NetworkKit';
  import { hilog } from '@kit.PerformanceAnalysisKit';
  
  let accessToken = '';
  
  export class MyAuthProvider implements cloudCommon.AuthProvider {
    async getAccessToken(isForceRefresh: boolean): Promise<string> {
      let data =
        "grant_type=refresh_token&client_id=xxxx&client_secret=xxxx&refresh_token=";
      let refreshToken =
        encodeURIComponent('xxxx');
      if (isForceRefresh) {
        data = data + refreshToken;
        try {
          let httpRequest = http.createHttp();
          let ohosOptions: http.HttpRequestOptions = {
            method: http.RequestMethod.POST,
            header: {
              'Content-Type': 'application/x-www-form-urlencoded'
            },
            extraData: data,
          };
          let url = "https://oauth-login.cloud.huawei.com/oauth2/v3/token";
          let resp = await httpRequest.request(url, ohosOptions);
          accessToken = JSON.parse(resp.result.toString()).access_token;
        } catch (err) {
          hilog.error(0x0000, 'testTag', '%{public}s', `Failed to get accessToken, code: ${err.code}, message: ${err.message}`);
        }
      }
      return Promise.resolve(accessToken);
    }
  }

FunctionOptions

云函数初始化配置参数。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.DeviceCloudGateway.CloudFoundation

起始版本：5.0.0(12)

StorageOptions

云存储初始化配置参数。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力：SystemCapability.DeviceCloudGateway.CloudFoundation

起始版本：5.0.0(12)

DatabaseOptions

云数据库初始化配置参数。

模型约束：此接口仅可在Stage模型下使用。

元服务API：从版本5.0.0(12)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.DeviceCloudGateway.CloudFoundation

起始版本：5.0.0(12)