This module provides the capabilities of uploading, downloading, querying, and deleting files through the Cloud Storage service.
Start version: 5.0.0(12)
bucket(name?: string): StorageBucket
Initializes a Cloud Storage instance.
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 |
|---|---|---|---|
name | string | No | Name of a storage instance. The format is restricted by the cloud. Only lowercase letters, digits, and hyphens (-) are allowed. The value must start and end with a letter or digit and contain 9 to 63 characters. Two or more consecutive hyphens (-) are not allowed. If this parameter is not specified, an asynchronous task will be initiated to query the default instance on the cloud side. If this parameter is specified, ensure that the storage instance exists on the cloud; otherwise, subsequent operations will result in an error during storage instance query. |
Returns:
Type | Description |
|---|---|
Cloud Storage instance. |
Error codes:
For details about the error codes, please refer to ArkTS Error Codes.
Error Code | Error Message |
|---|---|
401 | Parameter error. |
Example:
import { cloudStorage } from '@kit.CloudFoundationKit';
let bucket1: cloudStorage.StorageBucket = cloudStorage.bucket(); // When name is not specified, an asynchronous task will be initiated to query the default instance on the cloud.
/**
* Set the Cloud Storage instance name to mybucket-duaf5.
* mybucket is the storage instance name set during Cloud Storage instance creation, and duaf5 is a random character string generated during Cloud Storage instance creation. They are connected by a hyphen (-).
*/
let bucket2: cloudStorage.StorageBucket = cloudStorage.bucket('mybucket-duaf5'); Cloud Storage instance, which provides the capabilities of uploading and downloading files through the Cloud Storage service. The instance is initialized through bucket.
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)
uploadFile(context: common.BaseContext, parameters: UploadParams): Promise<request.agent.Task>
Uploads a specified file to the cloud. 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).
Required permission: ohos.permission.INTERNET
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
context | common.BaseContext | Yes | App context. |
parameters | Yes | Upload-related parameters. |
Returns:
Type | Description |
|---|---|
Promise<request.agent.Task> | Upload task returned through a promise. |
Error codes:
For details about the error codes, please refer to ArkTS Error Codes.
Error Code | Error Message |
|---|---|
201 | No Internet permission. |
401 | Parameter error. |
1008220001 | Network connection error. |
1008220009 | Client internal error. |
1008221001 | Server error. |
import { cloudStorage } from '@kit.CloudFoundationKit';
import { BusinessError, request } from '@kit.BasicServicesKit';
let bucket: cloudStorage.StorageBucket = cloudStorage.bucket();
// ArkUI context.
bucket.uploadFile(getContext(this), {
localPath: cacheFile, // Local file path.
cloudPath: path // Cloud file path.
}).then((task: request.agent.Task) => {
task.on('progress', (progress) => {
console.info(`on progress ${JSON.stringify(progress)}`);
});
task.on('completed', (progress) => {
console.info(`on completed ${JSON.stringify(progress)}`);
});
task.on('failed', (progress) => {
console.error(`on failed ${JSON.stringify(progress)}`);
});
task.on('response', (response) => {
console.info(`on response ${JSON.stringify(response)}`);
});
// Start the task.
task.start((err: BusinessError) => {
if (err) {
console.error(`Failed to start the uploadFile task, Code: ${err.code}, message: ${err.message}`);
} else {
console.info(`Succeeded in starting a uploadFile task.`);
}
});
}).catch((err: BusinessError) => {
console.error(`Upload file failed, Code: ${err.code}, message: ${err.message}`);
}); uploadFile(context: common.BaseContext, parameters: UploadParams, callback: AsyncCallback<request.agent.Task>): void
Uploads a specified file to the cloud. This API returns the result asynchronously through a callback.
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).
Required permission: ohos.permission.INTERNET
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
context | common.BaseContext | Yes | App context. |
parameters | Yes | Upload-related parameters. | |
callback | AsyncCallback<request.agent.Task> | Yes | Callback function. If the file is uploaded successfully, err is undefined and data is the request.agent.Task obtained; otherwise, err is an error object. |
Error codes:
For details about the error codes, please refer to ArkTS Error Codes.
Error Code | Error Message |
|---|---|
201 | No Internet permission. |
401 | Parameter error. |
1008220001 | Network connection error. |
1008220009 | Client internal error. |
1008221001 | Server error. |
import { cloudStorage } from '@kit.CloudFoundationKit';
import { BusinessError, request } from '@kit.BasicServicesKit';
let bucket: cloudStorage.StorageBucket = cloudStorage.bucket();
// ArkUI context.
bucket.uploadFile(getContext(this), {
localPath: cacheFile, // Local file path.
cloudPath: path // Cloud file path.
}, (err: BusinessError, task: request.agent.Task) => {
if (err) {
console.error(`Upload file failed! Code: ${err.code}, message: ${err.message}`);
return;
}
task.on('progress', (progress) => {
console.info(`on progress ${JSON.stringify(progress)}`);
});
task.on('completed', (progress) => {
console.info(`on completed ${JSON.stringify(progress)}`);
});
task.on('failed', (progress) => {
console.error(`on failed ${JSON.stringify(progress)}`);
});
task.on('response', (response) => {
console.info(`on response ${JSON.stringify(response)}`);
});
// Start the task.
task.start((err: BusinessError) => {
if (err) {
console.error(`Failed to start the uploadFile task, Code: ${err.code}, message: ${err.message}`);
} else {
console.info(`Succeeded in starting a uploadFile task.`);
}
});
}); downloadFile(context: common.BaseContext, parameters: DownloadParams): Promise<request.agent.Task>
Downloads a file from the cloud to a local path. 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).
Required permission: ohos.permission.INTERNET
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
context | common.BaseContext | Yes | App context. |
parameters | Yes | Download-related parameters. |
Returns:
Type | Description |
|---|---|
Promise<request.agent.Task> | Download task returned through a promise. |
Error codes:
For details about the error codes, please refer to ArkTS Error Codes.
Error Code | Error Message |
|---|---|
201 | No Internet permission. |
401 | Parameter error. |
1008220001 | Network connection error. |
1008220009 | Client internal error. |
1008221001 | Server error. |
import { cloudStorage } from '@kit.CloudFoundationKit';
import { BusinessError, request } from '@kit.BasicServicesKit';
let bucket: cloudStorage.StorageBucket = cloudStorage.bucket();
// ArkUI context.
bucket.downloadFile(getContext(this), {
cloudPath: path, // Cloud file path.
localPath: cacheFile, // Local path to store the file.
}).then((task: request.agent.Task) => {
task.on('progress', (progress) => {
console.info(`on progress ${JSON.stringify(progress)}`);
});
task.on('completed', (progress) => {
console.info(`on completed ${JSON.stringify(progress)}`);
});
task.on('failed', (progress) => {
console.error(`on failed ${JSON.stringify(progress)}`);
});
task.on('response', (response) => {
console.info(`on response ${JSON.stringify(response)}`);
});
// Start the task.
task.start((err: BusinessError) => {
if (err) {
console.error(`Failed to start the downloadFile task, Code: ${err.code}, message: ${err.message}`);
} else {
console.info(`Succeeded in starting a downloadFile task.`);
}
});
}).catch((err: BusinessError) => {
console.error(`Download file failed! Code: ${err.code}, message: ${err.message}`);
}); downloadFile(context: common.BaseContext, parameters: DownloadParams, callback: AsyncCallback<request.agent.Task>): void
Downloads a file from the cloud to a local path. This API returns the result asynchronously through a callback.
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).
Required permission: ohos.permission.INTERNET
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
context | common.BaseContext | Yes | App context. |
parameters | Yes | Download-related parameters. | |
callback | AsyncCallback<request.agent.Task> | Yes | Callback function. If the file is downloaded successfully, err is undefined and data is the request.agent.Task obtained; otherwise, err is an error object. |
Error codes:
For details about the error codes, please refer to ArkTS Error Codes.
Error Code | Error Message |
|---|---|
201 | No Internet permission. |
401 | Parameter error. |
1008220001 | Network connection error. |
1008220009 | Client internal error. |
1008221001 | Server error. |
import { cloudStorage } from '@kit.CloudFoundationKit';
import { BusinessError, request } from '@kit.BasicServicesKit';
let bucket: cloudStorage.StorageBucket = cloudStorage.bucket();
// ArkUI context.
bucket.downloadFile(getContext(this), {
cloudPath: path, // Cloud file path.
localPath: cacheFile, // Local path to store the file.
}, (err: BusinessError, task: request.agent.Task) => {
if (err) {
console.error(`Download file failed! Code: ${err.code}, message: ${err.message}`);
return;
}
task.on('progress', (progress) => {
console.info(`on progress ${JSON.stringify(progress)}`);
});
task.on('completed', (progress) => {
console.info(`on completed ${JSON.stringify(progress)}`);
});
task.on('failed', (progress) => {
console.error(`on failed ${JSON.stringify(progress)}`);
});
task.on('response', (response) => {
console.info(`on response ${JSON.stringify(response)}`);
});
// Start the task.
task.start((err: BusinessError) => {
if (err) {
console.error(`Failed to start the downloadFile task, Code: ${err.code}, message: ${err.message}`);
} else {
console.info(`Succeeded in starting a downloadFile task.`);
}
});
}); getDownloadURL(cloudPath: string): Promise<string>
Obtains the download URL of a cloud file. 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).
Required permission: ohos.permission.INTERNET
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
cloudPath | string | Yes | Cloud file path. |
Returns:
Type | Description |
|---|---|
Promise<string> | Cloud file download URL returned through a promise. |
Error codes:
For details about the error codes, please refer to ArkTS Error Codes.
Error Code | Error Message |
|---|---|
201 | No Internet permission. |
401 | Parameter error. |
1008220001 | Network connection error. |
1008220009 | Client internal error. |
1008221001 | Server error. |
import { cloudStorage } from '@kit.CloudFoundationKit';
import { BusinessError } from '@kit.BasicServicesKit';
let bucket: cloudStorage.StorageBucket = cloudStorage.bucket();
// cloudPath indicates the cloud file path.
bucket.getDownloadURL('cloudPath').then((downloadURL: string) => {
console.info(`downloadURL: ${downloadURL}`);
}).catch((err: BusinessError) => {
console.error(`getDownloadURL failed! Code: ${err.code}, message: ${err.message}`);
}); getDownloadURL(cloudPath: string, callback: AsyncCallback<string>): void
Obtains the download URL of a cloud file. This API returns the result asynchronously through a callback.
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).
Required permission: ohos.permission.INTERNET
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
cloudPath | string | Yes | Cloud file path. |
callback | AsyncCallback<string> | Yes | Cloud file download URL returned through a callback function. |
Error codes:
For details about the error codes, please refer to ArkTS Error Codes.
Error Code | Error Message |
|---|---|
201 | No Internet permission. |
401 | Parameter error. |
1008220001 | Network connection error. |
1008220009 | Client internal error. |
1008221001 | Server error. |
import { cloudStorage } from '@kit.CloudFoundationKit';
import { BusinessError } from '@kit.BasicServicesKit';
let bucket: cloudStorage.StorageBucket = cloudStorage.bucket();
// cloudPath indicates the cloud file path.
bucket.getDownloadURL('cloudPath', (err: BusinessError, downloadURL: string) => {
if (err) {
console.error(`getDownloadURL failed! Code: ${err.code}, message: ${err.message}`);
} else {
console.info(`downloadURL: ${downloadURL}`);
}
}); deleteFile(cloudPath: string): Promise<void>
Deletes a cloud file. 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).
Required permission: ohos.permission.INTERNET
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
cloudPath | string | Yes | Cloud file path. |
Returns:
Type | Description |
|---|---|
Promise<void> | Promise that returns no value. |
Error codes:
For details about the error codes, please refer to ArkTS Error Codes.
Error Code | Error Message |
|---|---|
201 | No Internet permission. |
401 | Parameter error. |
1008220001 | Network connection error. |
1008220009 | Client internal error. |
1008221001 | Server error. |
import { cloudStorage } from '@kit.CloudFoundationKit';
import { BusinessError } from '@kit.BasicServicesKit';
let bucket: cloudStorage.StorageBucket = cloudStorage.bucket();
// cloudPath indicates the cloud file path.
bucket.deleteFile('cloudPath').then(() => {
console.info('delete file success.');
}).catch((err: BusinessError) => {
console.error(`delete file failed! Code: ${err.code}, message: ${err.message}`);
}); deleteFile(cloudPath: string, callback: AsyncCallback<void>): void
Deletes a cloud file. This API returns the result asynchronously through a callback.
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).
Required permission: ohos.permission.INTERNET
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
cloudPath | string | Yes | Cloud file path. |
callback | AsyncCallback<void> | Yes | Callback function. If the cloud file is deleted successfully, err is undefined; otherwise, err is an error object. |
Error codes:
For details about the error codes, please refer to ArkTS Error Codes.
Error Code | Error Message |
|---|---|
201 | No Internet permission. |
401 | Parameter error. |
1008220001 | Network connection error. |
1008220009 | Client internal error. |
1008221001 | Server error. |
import { cloudStorage } from '@kit.CloudFoundationKit';
import { BusinessError } from '@kit.BasicServicesKit';
let bucket: cloudStorage.StorageBucket = cloudStorage.bucket();
// cloudPath indicates the cloud file path.
bucket.deleteFile('cloudPath', (err: BusinessError) => {
if (err) {
console.error(`delete file failed! Code: ${err.code}, message: ${err.message}`);
} else {
console.info('delete file success.');
}
}); list(cloudPath: string, options?: ListOptions): Promise<ListResults>
Obtains the cloud file list. 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).
Required permission: ohos.permission.INTERNET
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
cloudPath | string | Yes | Cloud file path. If an empty character string ('') is passed, the list of files in the root path on the cloud will be obtained. If some_directory/ is passed, the list of files in the specified folder some_directory will be obtained. |
options | No | Parameters for obtaining the file list. |
Returns:
Type | Description |
|---|---|
Promise<ListResults> | File list returned through a promise. |
Error codes:
For details about the error codes, please refer to ArkTS Error Codes.
Error Code | Error Message |
|---|---|
201 | No Internet permission. |
401 | Parameter error. |
1008220001 | Network connection error. |
1008220009 | Client internal error. |
1008221001 | Server error. |
import { cloudStorage } from '@kit.CloudFoundationKit';
import { BusinessError } from '@kit.BasicServicesKit';
let bucket: cloudStorage.StorageBucket = cloudStorage.bucket();
// Obtain the list of files in the root path on the cloud.
bucket.list('').then((result: cloudStorage.ListResults) => {
console.info(`list result: ${JSON.stringify(result)}`);
}).catch((err: BusinessError) => {
console.error(`list file failed! Code: ${err.code}, message: ${err.message}`);
});
// Obtain the list of files in the specified folder some_directory.
bucket.list('some_directory/').then((result: cloudStorage.ListResults) => {
console.info(`list result: ${JSON.stringify(result)}`);
}).catch((err: BusinessError) => {
console.error(`list file failed! Code: ${err.code}, message: ${err.message}`);
}); list(cloudPath: string, options: ListOptions, callback: AsyncCallback<ListResults>): void
Obtains the cloud file list. This API returns the result asynchronously through a callback.
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).
Required permission: ohos.permission.INTERNET
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
cloudPath | string | Yes | Cloud file path. If an empty character string ('') is passed, the list of files in the root path on the cloud will be obtained. If some_directory/ is passed, the list of files in the specified folder some_directory will be obtained. |
options | Yes | Parameters for obtaining the file list. | |
callback | AsyncCallback<ListResults> | Yes | Callback function. If the cloud file list is obtained successfully, err is undefined and data is the ListResults obtained; otherwise, err is an error object. |
Error codes:
For details about the error codes, please refer to ArkTS Error Codes.
Error Code | Error Message |
|---|---|
201 | No Internet permission. |
401 | Parameter error. |
1008220001 | Network connection error. |
1008220009 | Client internal error. |
1008221001 | Server error. |
import { cloudStorage } from '@kit.CloudFoundationKit';
import { BusinessError } from '@kit.BasicServicesKit';
let bucket: cloudStorage.StorageBucket = cloudStorage.bucket();
// Obtain the list of files in the root path on the cloud.
bucket.list('', {}, (err: BusinessError, result: cloudStorage.ListResults) => {
if (err) {
console.error(`list file failed! Code: ${err.code}, message: ${err.message}`);
} else {
console.info(`list result: ${JSON.stringify(result)}`);
}
});
// Obtain the list of files in the specified folder some_directory.
bucket.list('some_directory/', {}, (err: BusinessError, result: cloudStorage.ListResults) => {
if (err) {
console.error(`list file failed! Code: ${err.code}, message: ${err.message}`);
} else {
console.info(`list result: ${JSON.stringify(result)}`);
}
}); getMetadata(cloudPath: string): Promise<Metadata>
Obtains metadata of a cloud file. 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).
Required permission: ohos.permission.INTERNET
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
cloudPath | string | Yes | Cloud file path. |
Returns:
Type | Description |
|---|---|
Promise<Metadata> | Metadata of the cloud file, returned through a promise. |
Error codes:
For details about the error codes, please refer to ArkTS Error Codes.
Error Code | Error Message |
|---|---|
201 | No Internet permission. |
401 | Parameter error. |
1008220001 | Network connection error. |
1008220009 | Client internal error. |
1008221001 | Server error. |
import { cloudStorage } from '@kit.CloudFoundationKit';
import { BusinessError } from '@kit.BasicServicesKit';
let bucket: cloudStorage.StorageBucket = cloudStorage.bucket();
// cloudPath indicates the cloud file path.
bucket.getMetadata('cloudPath').then((data: cloudStorage.Metadata) => {
console.info(`Metadata : ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`getMetadata failed! Code: ${err.code}, message: ${err.message}`);
}); getMetadata(cloudPath: string, callback: AsyncCallback<Metadata>): void
Obtains metadata of a cloud file. This API returns the result asynchronously through a callback.
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).
Required permission: ohos.permission.INTERNET
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
cloudPath | string | Yes | Cloud file path. |
callback | AsyncCallback<Metadata> | Yes | Callback function. If the cloud file metadata is obtained successfully, err is undefined and data is the Metadata obtained; otherwise, err is an error object. |
Error codes:
For details about the error codes, please refer to ArkTS Error Codes.
Error Code | Error Message |
|---|---|
201 | No Internet permission. |
401 | Parameter error. |
1008220001 | Network connection error. |
1008220009 | Client internal error. |
1008221001 | Server error. |
import { cloudStorage } from '@kit.CloudFoundationKit';
import { BusinessError } from '@kit.BasicServicesKit';
let bucket: cloudStorage.StorageBucket = cloudStorage.bucket();
// cloudPath indicates the cloud file path.
bucket.getMetadata('cloudPath', (err: BusinessError, data: cloudStorage.Metadata) => {
if (err) {
console.error(`getMetadata failed! Code: ${err.code}, message: ${err.message}`);
} else {
console.info(`Metadata: ${JSON.stringify(data)}`);
}
}); setMetadata(cloudPath: string, metadata: MetadataUpdatable): Promise<Metadata>
Sets metadata of a cloud file. 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).
Required permission: ohos.permission.INTERNET
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
cloudPath | string | Yes | Cloud file path. |
metadata | Yes | Metadata to be updated. |
Returns:
Type | Description |
|---|---|
Promise<Metadata> | Complete metadata of the cloud file after the metadata is updated, returned through a promise. |
Error codes:
For details about the error codes, please refer to ArkTS Error Codes.
Error Code | Error Message |
|---|---|
201 | No Internet permission. |
401 | Parameter error. |
1008220001 | Network connection error. |
1008220009 | Client internal error. |
1008221001 | Server error. |
import { cloudStorage } from '@kit.CloudFoundationKit';
import { BusinessError } from '@kit.BasicServicesKit';
let bucket: cloudStorage.StorageBucket = cloudStorage.bucket();
// cloudPath indicates the cloud file path.
bucket.setMetadata('cloudPath', {
customMetadata: {
key1: "value1",
key2: "value2"
}
}).then((data: cloudStorage.Metadata) => {
console.info(`Metadata : ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`setMetadata failed! Code: ${err.code}, message: ${err.message}`);
}); setMetadata(cloudPath: string, metadata: MetadataUpdatable, callback: AsyncCallback<Metadata>): void
Sets metadata of a cloud file. This API returns the result asynchronously through a callback.
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).
Required permission: ohos.permission.INTERNET
System capability: SystemCapability.DeviceCloudGateway.CloudFoundation
Start version: 5.0.0(12)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
cloudPath | string | Yes | Cloud file path. |
metadata | Yes | Metadata to be updated. | |
callback | AsyncCallback<Metadata> | Yes | Callback function. If the cloud file metadata is set successfully, err is undefined and data is the Metadata set; otherwise, err is an error object. |
Error codes:
For details about the error codes, please refer to ArkTS Error Codes.
Error Code | Error Message |
|---|---|
201 | No Internet permission. |
401 | Parameter error. |
1008220001 | Network connection error. |
1008220009 | Client internal error. |
1008221001 | Server error. |
import { cloudStorage } from '@kit.CloudFoundationKit';
import { BusinessError } from '@kit.BasicServicesKit';
let bucket: cloudStorage.StorageBucket = cloudStorage.bucket();
// cloudPath indicates the cloud file path.
bucket.setMetadata('cloudPath', {
customMetadata: {
key1: "value1",
key2: "value2"
}
}, (err: BusinessError, data: cloudStorage.Metadata) => {
if (err) {
console.error(`setMetadata failed! Code: ${err.code}, message: ${err.message}`);
} else {
console.info(`Metadata: ${JSON.stringify(data)}`);
}
}); Upload-related parameters.
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 |
|---|---|---|---|---|
localPath | string | No | No | Local file path. The root path is the cache directory. |
cloudPath | string | No | No | Cloud file path. After a file is uploaded successfully, you can use this path to perform other operations. |
metadata | No | Yes | File metadata. | |
mode | No | Yes | Type of the upload task. 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 request.agent.Mode.BACKGROUND.
| |
network | No | Yes | Network required by the upload task. 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 request.agent.Network.ANY.
|
Download-related parameters.
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 |
|---|---|---|---|---|
localPath | string | No | No | Local file path. The root path is the cache directory. |
cloudPath | string | No | No | Cloud file path. |
mode | No | Yes | Type of the download task. 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 request.agent.Mode.BACKGROUND.
| |
overwrite | boolean | No | Yes | Indicates whether to overwrite the local file when the file to be downloaded already exists. The default value is false.
|
network | No | Yes | Network required by the download task. 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 request.agent.Network.ANY.
|
Parameters for obtaining the file list.
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 |
|---|---|---|---|---|
maxResults | number | No | Yes | Maximum number of files in a list. The value ranges from 1 to 1000. By default, all files are listed. |
pageMarker | string | No | Yes | Pagination marker. |
File listing result.
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 |
|---|---|---|---|---|
directories | string[] | No | No | List of cloud directories returned. |
files | string[] | No | No | List of cloud files returned. |
pageMarker | string | No | Yes | Pagination marker. |
Metadata to be updated.
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 |
|---|---|---|---|---|
contentType | string | No | Yes | Standard HTTP header Content-Type. |
cacheControl | string | No | Yes | Standard HTTP header Cache-Control. |
contentDisposition | string | No | Yes | Standard HTTP header Content-Disposition. |
contentEncoding | string | No | Yes | Standard HTTP header Content-Encoding. |
contentLanguage | string | No | Yes | Standard HTTP header Content-Language. |
customMetadata | Record<string, string> | No | Yes | Custom cloud file attributes, which are case insensitive and must comply with the standard HTTP header specifications. |
Complete metadata, extended from MetadataUpdatable.
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 |
|---|---|---|---|---|
name | string | No | No | Cloud file name. |
size | number | No | No | Size of a cloud file, in bytes. |
createTime | Date | No | No | Time when a cloud file was created, in format yyyy-MM-ddTHH:mm:ssZ. |
modifyTime | Date | No | No | Time when a cloud file was modified, in format yyyy-MM-ddTHH:mm:ssZ. |
sha256Hash | string | No | Yes | SHA-256 information of a cloud file. |