This module provides the capability of initializing cloud development services.
Start version: 5.0.0(12)
init(options?: CloudOptions): void
Initializes cloud development services.
Model restriction: This API can be used only in the stage model.
Atomic service API: This API can be used in atomic services since API version 5.0.0(12).
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
options | No | Initialization parameters. |
Error codes:
For details about the error codes, please refer to ArkTS Error Codes.
Error Code | Error Message |
|---|---|
401 | Parameter error. |
Example:
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"}
}) Initialization options.
Model restriction: This API can be used only in the stage model.
Atomic service API: This API can be used in atomic services since API version 5.0.0(12).
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
region | No | Yes | Storage location. The default value is CHINA. | |
authProvider | No | Yes | Authentication provider. | |
functionOptions | No | Yes | Cloud Functions initialization settings. | |
storageOptions | No | Yes | Cloud Storage initialization settings. | |
databaseOptions | No | Yes | Cloud DB initialization settings. |
Enumerated storage locations.
Model restriction: This API can be used only in the stage model.
Atomic service API: This API can be used in atomic services since API version 5.0.0(12).
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Name | Value | Description |
|---|---|---|
CHINA | 0 | Data is stored in the Chinese mainland. |
GERMANY | 1 | Data is stored in Germany. |
RUSSIA | 2 | Data is stored in Russia. |
SINGAPORE | 3 | Data is stored in Singapore. |
Custom authentication provider. You can use the access token API of Account Kit to customize an AuthProvider.
Model restriction: This API can be used only in the stage model.
Atomic service API: This API can be used in atomic services since API version 5.0.0(12).
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
getAccessToken(isForceRefresh: boolean): Promise<string>
Obtains user credentials. This API returns the result asynchronously through a promise.
Model restriction: This API can be used only in the stage model.
Atomic service API: This API can be used in atomic services since API version 5.0.0(12).
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
isForceRefresh | boolean | Yes | Indicates whether to forcibly refresh user credentials. true: yes; false: no. |
Returns:
Type | Description |
|---|---|
Promise<string> | User credentials returned through a promise. The user credentials can be generated through the API of Account Kit for obtaining a user-level credential. |
Example:
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);
}
} Cloud Functions initialization settings.
Model restriction: This API can be used only in the stage model.
Atomic service API: This API can be used in atomic services since API version 5.0.0(12).
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
timeout | number | No | Yes | Timeout interval for requesting a function, in milliseconds. The default interval is 70 x 1000 milliseconds. The value range is unrestricted, and the value will be converted to the unsigned long type. |
Cloud Storage initialization settings.
Model restriction: This API can be used only in the stage model.
Atomic service API: This API can be used in atomic services since API version 5.0.0(12).
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
mode | No | Yes | Task mode. After an app is switched to the background for a period of time, background tasks are not affected but foreground tasks will fail or pause. The default value is BACKGROUND.
| |
network | No | Yes | Network type. If the network does not meet the preset condition, tasks that have not been executed will await for execution, and tasks that are being executed will fail or pause. The default value is Network.ANY.
|
Cloud DB initialization settings.
Model restriction: This API can be used only in the stage model.
Atomic service API: This API can be used in atomic services since API version 5.0.0(12).
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Name | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
schema | string | No | Yes | Complete data table results and permissions. The schema configuration file is downloaded from the cloud and, by default, is obtained from the rawfile directory. |
traceId | string | No | Yes | Custom trace ID, used to trace requests. The custom trace ID must contain 1 to 32 characters and can only consist of the following two types of characters:
|