my.saveFile
この API は、ベースライブラリ 1.13.0 以降、および mPaaS 10.1.32 以降でサポートされています。これより前のバージョンのベースライブラリでは、互換性を確保する必要があります。詳細については、「ミニプログラムベースライブラリ」をご参照ください。
この API は、ローカルデバイスにファイルを保存します。ローカルファイルの合計サイズは 10 MB に制限されています。my.saveFile の呼び出しが成功すると、保存されたファイルは Android デバイスの /alipay/pictures/ フォルダに配置されます。iOS では、非表示のフォルダパスを表示することはできません。
入力パラメーター
名前 | 型 | 必須 | 説明 |
apFilePath | String | はい | ファイルパスです。 |
success | Function | いいえ | 呼び出しが成功したときに実行されるコールバック関数です。 |
fail | Function | いいえ | 呼び出しが失敗したときに実行されるコールバック関数です。 |
complete | Function | いいえ | 呼び出しが完了したときに実行されるコールバック関数です。この関数は、呼び出しが成功したか失敗したかに関わらず実行されます。 |
成功時の戻り値の説明
名前 | 型 | 説明 |
apFilePath | String | ファイルが保存されているパスです。 |
コードサンプル
my.chooseImage({
success: (res) => {
my.saveFile({
apFilePath: res.apFilePaths[0],
success: (res) => {
console.log(JSON.stringify(res))
},
});
},
});my.getFileInfo
この API は、ベースライブラリ 1.4.0 以降、および mPaaS 10.1.32 以降でサポートされています。これより前のバージョンのベースライブラリでは、互換性を確保する必要があります。詳細については、「ミニプログラムベースライブラリ」をご参照ください。
入力パラメーター
名前 | 型 | 必須 | 説明 |
apFilePath | String | はい | ファイルパス (ローカルパス) です。 |
digestAlgorithm | String | いいえ | 要約アルゴリズムです。サポートされている値は |
success | Function | いいえ | 呼び出しが成功したときに実行されるコールバック関数です。 |
fail | Function | いいえ | 呼び出しが失敗したときに実行されるコールバック関数です。 |
complete | Function | いいえ | 呼び出しが完了したときに実行されるコールバック関数です。この関数は、呼び出しが成功したか失敗したかに関わらず実行されます。 |
成功時のコールバック結果
名前 | 型 | 説明 |
size | Number | ファイルサイズです。 |
digest | String | 要約結果です。 |
コードサンプル
my.getFileInfo({
apFilePath:'https://resource/apml953bb093ebd2834530196f50a4413a87.video',
digestAlgorithm:'sha1',
success:(res)=>{
console.log(JSON.stringify(res))
}
})my.getSavedFileInfo
この API は、ベースライブラリ 1.3.0 以降、および mPaaS 10.1.32 以降でサポートされています。これより前のバージョンのベースライブラリでは、互換性を確保する必要があります。詳細については、「ミニプログラムベースライブラリ」をご参照ください。
この API は、保存されたファイルに関する情報を取得します。
入力パラメーター
名前 | 型 | 必須 | 説明 |
apFilePath | String | はい | ファイルパスです。 |
success | Function | いいえ | 呼び出しが成功したときに実行されるコールバック関数です。 |
fail | Function | いいえ | 呼び出しが失敗したときに実行されるコールバック関数です。 |
complete | Function | いいえ | 呼び出しが完了したときに実行されるコールバック関数です。この関数は、呼び出しが成功したか失敗したかに関わらず実行されます。 |
成功時の戻り値の説明
名前 | 型 | 説明 |
size | Number | ファイルサイズです。 |
createTime | Number | 作成時間のタイムスタンプです。 |
コードサンプル
my.getSavedFileInfo は、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
この API は、ベースライブラリ 1.13.0 以降、および mPaaS 10.1.32 以降でサポートされています。これより前のバージョンのベースライブラリでは、互換性を確保する必要があります。詳細については、「ミニプログラムベースライブラリ」をご参照ください。
この API は、保存されているすべてのファイルのリストを取得します。
入力パラメーター
名前 | 型 | 必須 | 説明 |
success | Function | いいえ | 呼び出しが成功したときに実行されるコールバック関数です。 |
fail | Function | いいえ | 呼び出しが失敗したときに実行されるコールバック関数です。 |
complete | Function | いいえ | 呼び出しが完了したときに実行されるコールバック関数です。この関数は、呼び出しが成功したか失敗したかに関わらず実行されます。 |
成功時の戻り値の説明
名前 | 型 | 説明 |
fileList | List | ファイルリストです。 |
ファイルオブジェクトのプロパティ
名前 | 型 | 説明 |
size | Number | ファイルサイズです。 |
createTime | Number | 作成時間です。 |
apFilePath | String | ファイルパスです。 |
コードサンプル
my.getSavedFileList({
success:(res)=>{
console.log(JSON.stringify(res))
}
});my.removeSavedFile
この API は、ベースライブラリ 1.13.0 以降、および mPaaS 10.1.32 以降でサポートされています。これより前のバージョンのベースライブラリでは、互換性を確保する必要があります。詳細については、「ミニプログラムベースライブラリ」をご参照ください。
この API は、保存されたファイルを削除します。
入力パラメーター
名前 | 型 | 必須 | 説明 |
apFilePath | String | はい | ファイルパスです。 |
success | Function | いいえ | 呼び出しが成功したときに実行されるコールバック関数です。 |
fail | Function | いいえ | 呼び出しが失敗したときに実行されるコールバック関数です。 |
complete | Function | いいえ | 呼び出しが完了したときに実行されるコールバック関数です。この関数は、呼び出しが成功したか失敗したかに関わらず実行されます。 |
コードサンプル
my.getSavedFileList({
success:(res)=>{
my.removeSavedFile({
apFilePath:res.fileList[0].apFilePath,
success:(res)=>{
console.log('remove success')
}
})
}
});my.openDocument
my.openDocument(Object object)
ローカルの PDF ファイルをプレビューできます。
入力パラメーター
Object オブジェクト
プロパティ | 型 | デフォルト | 必須 | 互換性 | 説明 |
filePath | String | - | はい | - | ファイルパス (一時ファイル、キャッシュファイル、またはユーザーファイル) です。 |
fileType | String | - | はい | - | ファイルタイプです。 有効な値:pdf。 |
success | Function | - | いいえ | - | 呼び出しが成功したときに実行されるコールバック関数です。 |
fail | Function | - | いいえ | - | 呼び出しが失敗したときに実行されるコールバック関数です。 |
complete | Function | - | いいえ | - | 呼び出しが完了したときに実行されるコールバック関数です。 説明 この関数は、呼び出しが成功したか失敗したかに関わらず実行されます。 |
エラーコード
fail コールバックは Object を返します。このオブジェクトの error プロパティにはエラーコードが、errorMessage プロパティにはエラーメッセージが含まれます。
エラーコード | エラーメッセージ | 解決策 |
4011 | 無効なパス | filePath パラメーターが正しいかどうかを確認してください。詳細については、filePath パラメーターの型と説明をご参照ください。 |
4012 | ファイルが存在しません | `filePath` で指定されたファイルが存在するかどうかを確認してください。 |
4013 | このファイルタイプはサポートされていません | `fileType` パラメーターが正しいかどうかを確認してください。詳細については、fileType パラメーターの説明をご参照ください。 |
コードサンプル
my.openDocument({
filePath: `${my.env.USER_DATA_PATH}/test.pdf`,
fileType: 'pdf',
success: (res) => {
console.log(res);
},
fail: (err) => {
console.log(err);
},
});ヒント
my.downloadFile を使用して PDF ファイルをダウンロードし、ローカルの一時ファイルパスを filePath パラメーターとして使用できます。