cloud

title: cloud

sidebar_label: cloud

Instance object of a cloud development SDK.

Reference

Type

typeof cloud

Parameters

CallFunctionResult

Common return for cloud functions

IAPIParam

Common parameters for cloud functions

IInitConfig

Initial configuration

IConfig

Configuration

ICloudAPIParam

Common parameters for the Cloud Functions API.

CallFunctionParam

UploadFileResult

Results of uploaded files

UploadFileParam

Parameters of uploaded files

DownloadFileResult

下载文件结果

DownloadFileParam

Parameters for downloading files

GetTempFileURLResult

The result of the acquisition of temporary documents.

GetTempFileURLResultItem

List of files

GetTempFileURLParam

Parameters of get temporary file

DeleteFileResult

The result of deleting a file

DeleteFileResultItem

Delete file list

DeleteFileParam

init

The initialisation method init needs to be called once before calling the cloud development APIs (only once globally, only the first time takes effect if called multiple times)

Reference

(config?: IInitConfig) => void

Sample Code

Taro.cloud.init({
  env: 'test-x1dzi'
})

API Support

callFunction

Call Cloud funtion

Reference

{ (param: OQ<CallFunctionParam>): void; (param: Pick<CallFunctionParam, "name" | "data" | "slow" | "config">): Promise<CallFunctionResult>; }

Sample Code

Assuming there is already a cloud function add, initiate a call to the cloud function add on the mini program side.

Taro.cloud.callFunction({
// Name of the cloud function to be called
name: 'add',
  // The event parameter passed to the cloud function.
  data: {
    x: 1,
    y: 2,
  }
}).then(res => {
  // output: res.result === 3
}).catch(err => {
  // handle error
})

API Support

uploadFile

Upload local resources to cloud storage, or overwrite if uploading to the same path.

Reference

{ (param: OQ<UploadFileParam>): any; (param: Pick<UploadFileParam, "config" | "cloudPath" | "filePath" | "header">): Promise<UploadFileResult>; }

Sample Code

Example 1

Taro.cloud.uploadFile({
  cloudPath: 'example.png',
  filePath: '', // file path
  success: res => {
    // get resource ID
    console.log(res.fileID)
  },
  fail: err => {
    // handle error
  }
})

Example 2

Taro.cloud.uploadFile({
  cloudPath: 'example.png',
  filePath: '', // file path
}).then(res => {
  // get resource ID
  console.log(res.fileID)
}).catch(error => {
  // handle error
})

API Support

downloadFile

Download files from cloud storage.

Reference

{ (param: OQ<DownloadFileParam>): any; (param: Pick<DownloadFileParam, "config" | "cloudPath" | "fileID">): Promise<DownloadFileResult>; }

Sample Code

Example 1

Taro.cloud.downloadFile({
  fileID: 'a7xzcb',
  success: res => {
    // get temp file path
    console.log(res.tempFilePath)
  },
  fail: err => {
    // handle error
  }
})

Example 2

Taro.cloud.downloadFile({
  fileID: 'a7xzcb'
}).then(res => {
  // get temp file path
  console.log(res.tempFilePath)
}).catch(error => {
  // handle error
})

API Support

getTempFileURL

Exchange your cloud file ID for a real link. Links obtained from public and readable files do not expire, while links obtained from private files are valid for ten minutes. Maximum of 50 at a time.

Reference

{ (param: OQ<GetTempFileURLParam>): void; (param: Pick<GetTempFileURLParam, "config" | "fileList">): Promise<GetTempFileURLResult>; }

Sample Code

Example 1

Taro.cloud.getTempFileURL({
  fileList: [{
    fileID: 'a7xzcb',
    maxAge: 60 * 60, // one hour
  }]
}).then(res => {
  // get temp file URL
  console.log(res.fileList)
}).catch(error => {
  // handle error
})

Example 2

Taro.cloud.getTempFileURL({
  fileList: ['cloud://xxx', 'cloud://yyy'],
  success: res => {
    // get temp file URL
    console.log(res.fileList)
  },
  fail: err => {
    // handle error
  }
})

API Support

deleteFile

Delete files from cloud storage, up to 50 at a time.

Reference

{ (param: OQ<DeleteFileParam>): void; (param: Pick<DeleteFileParam, "config" | "fileList">): Promise<DeleteFileResult>; }

Sample Code

Example 1

.cloud.deleteFile({
  fileList: ['a7xzcb']
}).then(res => {
  // handle success
  console.log(res.fileList)
}).catch(error => {
  // handle error
})

Example 2

Taro.cloud.deleteFile({
  fileList: ['a7xzcb'],
  success: res => {
    // handle success
    console.log(res.fileList)
  },
  fail: err => {
    // handle error
  },
  complete: res => {
    // ...
  }
})

API Support

database

Get the database instance.

Reference

(config?: IConfig) => Database

Sample Code

Example 1

The following call obtains a reference to the database of the default environment:

const db = Taro.cloud.database()

Example 2

Assuming an environment named test-123 is used as a test environment, the test environment database can be obtained as follows.

const testDB = Taro.cloud.database({
  env: 'test-123'
})

API Support