API untuk mengelola file lokal di program mini - Mobile Platform as a Service

my.saveFile

Catatan

API ini didukung mulai dari base libraries versi 1.13.0 dan mPaaS 10.1.32 ke atas. Untuk versi base library yang lebih lama, pastikan kompatibilitasnya. Untuk informasi selengkapnya, lihat Mini Program base libraries.

API ini menyimpan file ke perangkat lokal. Ukuran total file lokal dibatasi hingga 10 MB. Setelah pemanggilan my.saveFile berhasil, file yang disimpan berada di folder /alipay/pictures/ pada perangkat Android. Pada iOS, path folder tersebut tidak dapat dilihat karena bersifat tersembunyi.

Parameter input

Name	Type	Required	Description
apFilePath	String	Yes	File path
success	Function	No	Fungsi callback yang dijalankan ketika pemanggilan berhasil.
fail	Function	No	Fungsi callback yang dijalankan ketika pemanggilan gagal.
complete	Function	No	Fungsi callback yang dijalankan ketika pemanggilan selesai. Fungsi ini dijalankan baik saat pemanggilan berhasil maupun gagal.

Deskripsi nilai kembali success

Name	Type	Description
apFilePath	String	Path tempat file disimpan.

Contoh kode

my.chooseImage({
  success: (res) => {
    my.saveFile({
      apFilePath: res.apFilePaths[0],
      success: (res) => {
        console.log(JSON.stringify(res))
      },
    });
  },
});

my.getFileInfo

Catatan

API ini didukung mulai dari base libraries versi 1.4.0 dan mPaaS 10.1.32 ke atas. Untuk versi base library yang lebih lama, pastikan kompatibilitasnya. Untuk informasi selengkapnya, lihat Mini Program base libraries.

Parameter input

Name	Type	Required	Description
apFilePath	String	Yes	File path (local path).
digestAlgorithm	String	No	Algoritma ringkasan. Nilai yang didukung adalah `md5` dan `sha1`. Nilai default-nya adalah `md5`.
success	Function	No	Fungsi callback yang dijalankan ketika pemanggilan berhasil.
fail	Function	No	Fungsi callback yang dijalankan ketika pemanggilan gagal.
complete	Function	No	Fungsi callback yang dijalankan ketika pemanggilan selesai. Fungsi ini dijalankan baik saat pemanggilan berhasil maupun gagal.

Hasil callback success

Name	Type	Description
size	Number	File size.
digest	String	Hasil ringkasan.

Contoh kode

my.getFileInfo({
    apFilePath:'https://resource/apml953bb093ebd2834530196f50a4413a87.video',
    digestAlgorithm:'sha1',
    success:(res)=>{
        console.log(JSON.stringify(res))
    }
})

my.getSavedFileInfo

Catatan

API ini didukung mulai dari base libraries versi 1.3.0 dan mPaaS 10.1.32 ke atas. Untuk versi base library yang lebih lama, pastikan kompatibilitasnya. Untuk informasi selengkapnya, lihat Mini Program base libraries.

API ini mengambil informasi tentang file yang telah disimpan.

Parameter input

Name	Type	Required	Description
apFilePath	String	Yes	File path.
success	Function	No	Fungsi callback yang dijalankan ketika pemanggilan berhasil.
fail	Function	No	Fungsi callback yang dijalankan ketika pemanggilan gagal.
complete	Function	No	Fungsi callback yang dijalankan ketika pemanggilan selesai. Fungsi ini dijalankan baik saat pemanggilan berhasil maupun gagal.

Deskripsi nilai kembali success

Name	Type	Description
size	Number	File size.
createTime	Number	Timestamp waktu pembuatan.

Contoh kode

Anda hanya dapat menggunakan my.getSavedFileInfo dengan path yang disimpan melalui 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

Catatan

API ini mengambil daftar semua file yang telah disimpan.

Parameter input

Name	Type	Required	Description
success	Function	No	Fungsi callback yang dijalankan ketika pemanggilan berhasil.
fail	Function	No	Fungsi callback yang dijalankan ketika pemanggilan gagal.
complete	Function	No	Fungsi callback yang dijalankan ketika pemanggilan selesai. Fungsi ini dijalankan baik saat pemanggilan berhasil maupun gagal.

Deskripsi nilai kembali success

Name	Type	Description
fileList	List	File list.

Properti objek file

Name	Type	Description
size	Number	File size.
createTime	Number	Creation time.
apFilePath	String	File path.

Contoh kode

my.getSavedFileList({
    success:(res)=>{
        console.log(JSON.stringify(res))
    }
});

my.removeSavedFile

Catatan

API ini menghapus file yang telah disimpan.

Parameter input

Name	Type	Required	Description
apFilePath	String	Yes	File path.
success	Function	No	Fungsi callback yang dijalankan ketika pemanggilan berhasil.
fail	Function	No	Fungsi callback yang dijalankan ketika pemanggilan gagal.
complete	Function	No	Fungsi callback yang dijalankan ketika pemanggilan selesai. Fungsi ini dijalankan baik saat pemanggilan berhasil maupun gagal.

Contoh kode

my.getSavedFileList({
        success:(res)=>{
            my.removeSavedFile({
          apFilePath:res.fileList[0].apFilePath,
          success:(res)=>{
            console.log('remove success')
          }
        })
        }
    });

my.openDocument

my.openDocument(Object object)

Anda dapat melihat pratinjau file PDF lokal.

Parameter input

Object object

Property	Type	Default	Required	Compatibility	Description
filePath	String	-	Yes	-	File path (temporary file, cache file, atau user file).
fileType	String	-	Yes	-	File type. Valid value: pdf.
success	Function	-	No	-	Fungsi callback yang dijalankan ketika pemanggilan berhasil.
fail	Function	-	No	-	Fungsi callback yang dijalankan ketika pemanggilan gagal.
complete	Function	-	No	-	Fungsi callback yang dijalankan ketika pemanggilan selesai. Catatan Fungsi ini dijalankan baik saat pemanggilan berhasil maupun gagal.

Kode kesalahan

Callback fail mengembalikan sebuah Object. Properti error dari objek ini berisi kode kesalahan, dan properti errorMessage berisi pesan kesalahan.

Error code	Error message	Solutions
4011	Invalid path	Periksa apakah parameter filePath sudah benar. Untuk informasi selengkapnya, lihat tipe dan deskripsi parameter filePath.
4012	The file does not exist	Periksa apakah file yang ditentukan oleh `filePath` ada.
4013	This file type is not supported	Periksa apakah parameter `fileType` sudah benar. Untuk informasi selengkapnya, lihat deskripsi parameter fileType.

Contoh kode

my.openDocument({
  filePath: `${my.env.USER_DATA_PATH}/test.pdf`,
  fileType: 'pdf',
  success: (res) => {
    console.log(res);
  },
  fail: (err) => {
    console.log(err);
  },
});

Tip

Anda dapat mengunduh file PDF menggunakan my.downloadFile, lalu menggunakan path file temporary lokal sebagai parameter filePath.