my.saveFile
Note:
- This interface is supported since basic library version 1.3.0. Compatibility processing is required for earlier versions. See Mini Program base library to learn more.
- This interface is only supported in mPaaS 10.1.32 and later versions.
This interface is used to save the file to local. The maximum local file capacity is 10 MB. After my.saveFile
is successfully called, you can find the saved files in the path storage/alipay/pictures/file location
in Android device. Hidden file path in iOS device cannot be found.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
apFilePath | String | Yes | File path |
success | Function | No | Callback function upon call success. |
fail | Function | No | Callback function upon call failure. |
complete | Function | No | Callback function upon call completion (to be executed upon either call success or failure). |
Return value on success
Parameter | Type | Description |
---|---|---|
apFilePath | String | File save path |
Sample code
my.chooseImage({
success: (res) => {
my.saveFile({
apFilePath: res.apFilePaths[0],
success: (res) => {
console.log(JSON.stringify(res))
},
});
},
});
my.getFileInfo
Note:
- This interface is supported since basic library version 1.4.0. Compatibility processing is required for earlier versions. See Mini Program base library to learn more.
- This interface is only supported in mPaaS 10.1.32 and later versions.
This interface is used to get file information.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
apFilePath | String | Yes | File path (local path) |
digestAlgorithm | String | No | Digest algorithm, supporting md5 and sha1, md5 by default. |
success | Function | No | Callback function upon call success. |
fail | Function | No | Callback function upon call failure. |
complete | Function | No | Callback function upon call completion (to be executed upon either call success or failure). |
Return value on success
Parameter | Type | Description |
---|---|---|
size | Number | File size |
digest | String | Digest result. |
Sample code
my.getFileInfo({
apFilePath:'https://resource/apml953bb093ebd2834530196f50a4413a87.video',
digestAlgorithm:'sha1',
success:(res)=>{
console.log(JSON.stringify(res))
}
})
my.getSavedFileInfo
Note:
- This interface is supported since basic library version 1.3.0. Compatibility processing is required for earlier versions. See Mini Program base library to learn more.
- This interface is only supported in mPaaS 10.1.32 and later versions.
This interface is used to get the information of the saved files.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
apFilePath | String | Yes | File path |
success | Function | No | Callback function upon call success. |
fail | Function | No | Callback function upon call failure. |
complete | Function | No | Callback function upon call completion (to be executed upon either call success or failure). |
Return value on success
Parameter | Type | Description |
---|---|---|
size | Number | File size |
createTime | Number | Creation time |
Sample code
my.getSavedFileInfo
only works on the file address saved by using my.saveFile.
var that = this;
my.chooseImage({
success: (res) => {
console.log(res.apFilePaths[0], 1212)
my.saveFile({
apFilePath: res.apFilePaths[0],
success: (result) => {
console.log(result, 1212)
my.getSavedFileInfo({
apFilePath: result.apFilePath,
success: (resu) => {
console.log(JSON.stringify(resu))
that.filePath = resu
}
})
},
});
},
});
my.getSavedFileList
Note:
- This interface is supported since basic library version 1.3.0. Compatibility processing is required for earlier versions. See Mini Program base library to learn more.
- This interface is only supported in mPaaS 10.1.32 and later versions.
This interface is used to get all saved files.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
success | Function | No | Callback function upon call success. |
fail | Function | No | Callback function upon call failure. |
complete | Function | No | Callback function upon call completion (to be executed upon either call success or failure). |
Return value on success
Parameter | Type | Description |
---|---|---|
fileList | List | File list |
Attributes of file object
Attribute | Type | Description |
---|---|---|
size | Number | File size |
createTime | Number | Creation time |
apFilePath | String | File path |
Sample code
my.getSavedFileList({
success:(res)=>{
console.log(JSON.stringfy(res))
}
});
my.removeSavedFile
Note:
- This interface is supported since basic library version 1.3.0. Compatibility processing is required for earlier versions. See Mini Program base library to learn more.
- This interface is only supported in mPaaS 10.1.32 and later versions.
This interface is used to delete a saved file.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
apFilePath | String | Yes | File path |
success | Function | No | Callback function upon call success. |
fail | Function | No | Callback function upon call failure. |
complete | Function | No | Callback function upon call completion (to be executed upon either call success or failure). |
Sample code
my.getSavedFileList({
success:(res)=>{
my.removeSavedFile({
apFilePath:res.fileList[0].apFilePath,
success:(res)=>{
console.log('remove success')
}
})
}
});