ファイル関連の操作 - Drive and Photo Service - Alibaba Cloud ドキュメントセンター

このトピックでは、ファイルとフォルダに対して操作を実行するために呼び出すことができるメソッドについて説明します。操作には、追加、削除、変更、クエリ、コピー、および移動が含まれます。

説明

IPDSRequestConfig タイプの options パラメーターは、axios のリクエスト構成オプションに基づいてカプセル化されています。詳細については、「AxiosRequestConfig」をご参照ください。

listFiles メソッド

このメソッドを呼び出して、特定のディレクトリ内のファイルまたはフォルダをクエリできます。

const result = await client.listFiles(params, options)

例

const {items=[]} = await client.listFiles({
  drive_id:'1001', 
  parent_file_id:'root'
})

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	IListFileReq	はい	ファイルまたはフォルダのクエリに使用されるパラメーター。
options	IPDSRequestConfig		その他のリクエストパラメーター。

IListFileReq

パラメーター	タイプ	必須	説明
drive_id	string		ドライブ ID。 drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。
share_id	string		共有 ID。 drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。
parent_file_id	string		親ディレクトリの ID。
fields	string		返されるパラメーター。すべてのパラメーターを返す場合は、値を * に設定します。このパラメーターを指定しない場合は、基本パラメーターのみが返されます。デフォルトでは、このパラメーターは指定されていません。
url_expire_sec	number		URL の有効期間。
video_thumbnail_process	string		ビデオサムネイルの処理に使用される式。詳細については、「画像処理」をご参照ください。
image_thumbnail_process	string		画像サムネイルの処理に使用される式。詳細については、「画像処理」をご参照ください。
image_url_process	string		画像 URL の処理に使用される式。詳細については、「画像処理」をご参照ください。
limit	number		返されるエントリの最大数。
marker	string		ページネーショントークン。
order_by	string		結果のソートに使用されるパラメーター。
order_direction	string		結果をソートする順序。有効な値：DESC および ASC。
starred	boolean		ファイルまたはフォルダをお気に入りに追加するかどうかを指定します。
category	string		ファイルまたはフォルダのカテゴリ。
status	string		ファイルまたはフォルダの状態。
type	string		エントリのタイプ。有効な値：file および folder。

IFileItem

パラメーター	タイプ	必須	説明
action_list	array		権限。
category	string		ファイルのタイプ。有効な値：app、doc、image、video、audio、zip、および others。
content_hash	string		ファイルの識別子。
content_hash_name	string		ファイルの暗号化モード。
content_type	string		コンテンツのタイプ。
crc64_hash	string		CRC-64 ハッシュ値。
created_at	Date	はい	ファイルが作成された日時。
creator_id	string	はい	作成者 ID。
creator_name	string	はい	作成者の名前。
creator_type	string	はい	作成者のタイプ。有効な値：group および user。
domain_id	string	はい	ドメイン ID。
download_url	string		ダウンロード URL。このパラメーターは、type パラメーターが file に設定されている場合にのみ返されます。
drive_id	string	はい	ドライブ ID。
description	string		ファイルの説明。
encrypt_mode	string	はい	暗号化モード。
file_extension	string		ファイル名拡張子。例：`.txt`。
file_id	string	はい	フォルダ ID。
hidden	boolean	はい	ファイルが非表示かどうかを示します。
last_modifier_id	string	はい	ファイルの最終更新者 ID。
last_modifier_name	string		ファイルの最終更新者の名前。
last_modifier_type	string		ファイルを更新したユーザーのタイプ。有効な値：group および user。
labels	string		タグ。
location	string		場所。
mime_extension	string		メディアタイプの拡張子。
mime_type	string		メディアタイプ。
meta	string		メタデータ。
name	string	はい	フォルダの名前。
parent_file_id	string	はい	親ディレクトリの ID。
punish_flag	number		エラーの数。
revision_id	string	はい	リビジョンバージョン。
rapid_upload	boolean		インスタントファイル転送が実行されるかどうかを示します。
size	number		ファイルまたはフォルダのサイズ。単位：バイト。
starred	boolean	はい	ファイルまたはフォルダがお気に入りに追加されているかどうかを示します。
status	string	はい	ファイルまたはフォルダの状態。有効な値：available および uploading。
streams_upload_info			ストリームアップロードに関する情報。
thumbnail	string		サムネイル。このパラメーターは、category パラメーターが image または video に設定されている場合にのみ返されます。
type	string	はい	エントリのタイプ。有効な値：file および folder。
trashed	boolean		ファイルまたはフォルダがゴミ箱に移動されているかどうかを示します。
updated_at	Date	はい	ファイルまたはフォルダが更新された日時。
user_meta	string
upload_id	string		アップロード ID。
url	string		入力ファイルの URL。

download_url パラメーターと url パラメーターの違いは、download_url パラメーターに次のメッセージヘッダーが含まれていることです。
Content-Disposition: attachment; filename="filename"
メッセージヘッダーはブラウザによって直接ダウンロードされます。 url パラメーターにはメッセージヘッダーがなく、特定のファイルブラウザが URL を直接開きます。たとえば、特定のブラウザは、画像、MP4 ビデオ、および PDF ファイルを直接開くことができます。
thumbnail パラメーターは、画像とビデオに対してのみ返されます。

searchFiles メソッド

このメソッドを呼び出して、特定の条件に基づいてファイルを検索できます。

const result = await client.searchFiles(params, options, isRecycleBin)

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	object	はい	ファイルの検索に使用されるパラメーター。詳細については、このトピックの「ISearchFileReq」セクションを参照してください。
options	IPDSRequestConfig		その他のリクエストパラメーター。
isRecycleBin	boolean		ゴミ箱内のファイルを検索するかどうかを指定します。ゴミ箱内のファイルを検索する場合は、値を true に設定します。それ以外の場合は、値を false に設定します。デフォルト値：false。

ISearchFileReq

パラメーター	タイプ	必須	説明
limit	number		返されるエントリの最大数。
query	string	はい	ファイルの検索に使用されるフィルター条件。詳細については、「ファイルのクエリ」をご参照ください。
drive_id	string	はい	ドライブ ID。
fields	string		返されるパラメーター。すべてのパラメーターを返す場合は、値を * に設定します。このパラメーターを指定しない場合は、基本パラメーターのみが返されます。デフォルトでは、このパラメーターは指定されていません。
order_by	string		結果のソートに使用されるパラメーター。
marker	string		ページネーショントークン。
url_expire_sec	number		URL の有効期間。デフォルトでは、URL は 2 時間有効です。
image_thumbnail_process	string		画像サムネイルの処理に使用される式。詳細については、「画像処理」をご参照ください。
image_url_process	string		画像 URL の処理に使用される式。詳細については、「画像処理」をご参照ください。
video_thumbnail_process	string		ビデオサムネイルの処理に使用される式。詳細については、「画像処理」をご参照ください。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	IListRes	はい	返された結果。

IListRes

パラメーター	タイプ	必須	説明
items	array	はい	ファイルのリスト。具体的なパラメーターの詳細については、このトピックの「IFileItem」セクションを参照してください。
next_marker	string		ページネーショントークン。

getFile メソッド

このメソッドを呼び出して、ファイル ID に基づいてファイルに関する情報をクエリできます。

const result = await client.getFile(params, options)

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	object	はい	ファイル情報のクエリに使用されるパラメーター。詳細については、このトピックの「IGetFileReq」セクションを参照してください。
options	IPDSRequestConfig		その他のリクエストパラメーター。

IGetFileReq

パラメーター	タイプ	必須	説明
drive_id	string		ドライブ ID。 drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。
share_id	string		共有 ID。 drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。
file_id	string		ファイル ID。
fields	string		返されるパラメーター。すべてのパラメーターを返す場合は、値を * に設定します。このパラメーターを指定しない場合は、基本パラメーターのみが返されます。デフォルトでは、このパラメーターは指定されていません。
url_expire_sec	number		返される各署名付き URL の有効期間。
video_thumbnail_process	string		ビデオサムネイルの処理に使用される式。詳細については、「画像処理」をご参照ください。
image_thumbnail_process	string		画像サムネイルの処理に使用される式。詳細については、「画像処理」をご参照ください。
image_url_process	string		画像 URL の処理に使用される式。詳細については、「画像処理」をご参照ください。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	object	はい	返された結果。詳細については、このトピックの「IFileItem」セクションを参照してください。

getFileDownloadUrl

このメソッドを呼び出して、ファイルの ダウンロード URL をクエリできます。次に、ブラウザで ダウンロード URL を開き、ファイルを直接ダウンロードできます。

const result = await client.getFileDownloadUrl(params, options)

例

const info = await client.getFileDownloadUrl({
  drive_id: '1',
  file_id: 'xxxxx',
})

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	object	はい	ダウンロード URL のクエリに使用されるパラメーター。詳細については、このトピックの「IGetFileDownloadUrlReq」セクションを参照してください。
options	IPDSRequestConfig		その他のリクエストパラメーター。

IGetFileDownloadUrlReq

パラメーター	タイプ	必須	説明
drive_id	string		ドライブ ID。 drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。
share_id	string		共有 ID。 drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。
file_id	string		ファイル ID。
fields	string		返されるパラメーター。すべてのパラメーターを返す場合は、値を * に設定します。このパラメーターを指定しない場合は、基本パラメーターのみが返されます。デフォルトでは、このパラメーターは指定されていません。
file_name	string		ダウンロードするファイルの名前。ファイルのダウンロード時に、サーバー上で `Content-Disposition: attachment; filename="file_name"` レスポンスヘッダーが構成されます。名前の長さは最大 1,024 文字です。
expire_sec	number		ダウンロード URL の有効期間。単位：秒。最大値：115200。デフォルト値：900。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	object	はい	返された結果。詳細については、このトピックの「IGetFileDownloadUrlRes」セクションを参照してください。

IGetFileDownloadUrlRes

パラメーター	タイプ	必須	説明
expiration	string	はい	ダウンロード URL の有効期間。
method	string	はい	該当する HTTP メソッド。ほとんどの場合、GET メソッドが使用されます。
url	string	はい	ファイルのダウンロード URL。
size	number		ファイルのサイズ。単位：バイト。

saveFileContent メソッド

このメソッドを呼び出して、ファイルのコンテンツを保存したり、ファイルを作成したりできます。

新しいファイルに指定した ID が既存のファイルの ID と同じ場合は、既存のファイルが上書きされます。ファイルの ID を指定しない場合、システムはファイルを新しいファイルと見なし、check_name_mode パラメーターで指定されたポリシーが使用されます。デフォルトでは、check_name_mode パラメーターは refuse に設定されています。

const result = await client.saveFileContent(params, content, config)

例

次のサンプルコードは、ファイルを作成する方法の例を示しています。

await client.saveFileContent({
  drive_id: '1',
  parent_file_id: 'root',
  name: 'unnamed.txt',
  content_type: 'text/plain; charset=utf-8',
}, '')

次のサンプルコードは、既存のファイルのコンテンツを変更する方法の例を示しています。

await client.saveFileContent(fileItem, 'modified content')

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	IGetFileReq	はい	ファイルに関する情報。詳細については、このトピックの「IGetFileReq」セクションを参照してください。
content	string		ファイルのコンテンツ。デフォルトでは、このパラメーターは空のままです。
config	ISaveFileConfig		その他のリクエストパラメーター。

ISaveFileConfig

パラメーター

タイプ

必須

説明

check_name_mode

boolean

新しいファイルの名前が既存のファイルと同じ名前の場合に使用されるポリシー。有効な値：

auto_rename：ファイル名の末尾に乱数を追加します。

refuse：code が AlreadyExists である例外をスローします。

ignore：新しいファイルに既存のファイルと同じ名前を付けることができます。

デフォルト値：refuse。

params パラメーターに file_id パラメーターが含まれている場合、この file_id パラメーターは無効になります。

ignore_rapid

boolean

インスタントファイル転送を強制的に無効にするかどうかを指定します。このパラメーターは主にテストに使用されます。デフォルト値：false。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	object	はい	返された結果。詳細については、このトピックの「IFileItem」セクションを参照してください。

getFileContent メソッド

このメソッドを呼び出して、ファイルのコンテンツをクエリできます。ほとんどの場合、このメソッドはテキストファイルを読み取るために使用されます。

注：このメソッドを呼び出してファイルのコンテンツをクエリする場合、値は変数に直接割り当てられます。大きなファイルのコンテンツをクエリするためにこのメソッドを呼び出さないことをお勧めします。そうしないと、大量のメモリが占有されます。

const result = await client.getFileContent(params, options)

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	IGetFileReq	はい	リクエストパラメーター。
options	IPDSRequestConfig		その他のリクエストパラメーター。

レスポンスの content パラメーターは、options.responseType パラメーターに関連しています。デフォルトでは、responseType パラメーターは arraybuffer に設定されています。 Node.js 環境では、content パラメーターに Buffer の値が返されます。ブラウザ環境では、content パラメーターに ArrayBuffer の値が返されます。
ファイルがテキストファイルであることを確認した場合は、options.responseType パラメーターを text に設定して、content パラメーターの戻り値が文字列になるようにします。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	object	はい	返された結果。

result

パラメーター	タイプ	必須	説明
headers	object	はい	ヘッダーメッセージ。
content	Buffer \| string \| ...	はい	ファイルのコンテンツ。これは空のままにすることができます。 responseType パラメーターの値に基づいて異なる値が返されます。詳細については、「axios - npm」の「responseType」セクションを参照してください。
size	number	はい	ファイルのサイズ。単位：バイト。
type	string	はい	ファイル ID。
updated_at	string	はい	ファイルが更新された日時。
status	string	はい	ファイルの状態。

renameFile メソッド

このメソッドを呼び出して、ファイルまたはフォルダの名前を変更できます。

const result = await client.renameFile(fileItem, newName,check_name_mode)

例

次のサンプルコードは、ファイルの名前を変更する方法の例を示しています。

await client.renameFile({
  drive_id: "1",
  file_id: 'xxxxxx',
}, 'new name.txt')

リクエストパラメーター

パラメーター	タイプ	必須	説明
fileItem	IFileItem	はい	名前を変更するファイルに関する情報。詳細については、このトピックの「IFileItem」セクションを参照してください。
newName	string	はい	ファイルの新しい名前。
check_name_mode	string		新しいファイルの名前が既存のファイルと同じ名前の場合に使用されるポリシー。有効な値： auto_rename：ファイル名の末尾に乱数を追加します。 refuse：`code` が `AlreadyExists` である例外をスローします。 ignore：新しいファイルに既存のファイルと同じ名前を付けることができます。デフォルト値：refuse。 fileItem パラメーターに file_id パラメーターが含まれている場合、この file_id パラメーターは無効になります。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	object	はい	返された結果。詳細については、このトピックの「IFileItem」セクションを参照してください。

updateFile メソッド

このメソッドを呼び出して、ファイルまたはフォルダに関する情報を変更できます。

const result = await client.updateFile(params, options)

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	object	はい	更新するファイルに関する情報。具体的なパラメーターについては、このトピックの「IUpdateFileReq」セクションを参照してください。
options	IPDSRequestConfig		その他のリクエストパラメーター。

IUpdateFileReq

パラメーター	タイプ	必須	説明
drive_id	string		ドライブ ID。 drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。
share_id	string		共有 ID。 drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。
file_id	string	はい	ファイル ID。
check_name_mode	string		新しいファイルの名前が既存のファイルと同じ名前の場合に使用されるポリシー。有効な値： auto_rename：ファイル名の末尾に乱数を追加します。 refuse：`code` が `AlreadyExists` である例外をスローします。 ignore：新しいファイルに既存のファイルと同じ名前を付けることができます。
parent_file_id	string		親ディレクトリの ID。
custom_index_key	string		カスタムキー。
description	string		ファイルの説明。
encrypt_mode	string		暗号化モード。
hidden	boolean		ファイルまたはフォルダを非表示にするかどうかを指定します。
labels	array		タグ。
meta	string
name	string		ファイルまたはフォルダの名前。
starred	boolean		ファイルまたはフォルダをお気に入りに追加するかどうかを指定します。
user_meta	string

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	object	はい	更新された情報。具体的なパラメーターの詳細については、このトピックの「IFileItem」セクションを参照してください。

getFileByPath メソッド

このメソッドを呼び出して、ファイルパスに基づいてファイルまたはフォルダに関する情報をクエリできます。

たとえば、パス /a/b/c に基づいてファイルまたはフォルダをクエリできます。

const result = await client.getFileByPath(params, options)

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	IGetFileByPathReq	はい	リクエストパラメーター。
options	IPDSRequestConfig		その他のリクエストパラメーター。

IGetFileByPathReq

パラメーター	タイプ	必須	説明
drive_id	string	はい	ドライブ ID。
file_path	string	はい	フォルダのパス。例：/a/b/c。
fields	string		返されるパラメーター。すべてのパラメーターを返す場合は、値を * に設定します。
url_expire_sec	number		URL の有効期間。単位：秒。
video_thumbnail_process	string		ビデオサムネイルの処理に使用される式。詳細については、「画像処理」をご参照ください。
image_thumbnail_process	string		画像サムネイルの処理に使用される式。詳細については、「画像処理」をご参照ください。
image_url_process	string		画像 URL の処理に使用される式。詳細については、「画像処理」をご参照ください。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	object	はい	返された結果。詳細については、このトピックの「IFileItem」セクションを参照してください。

getBreadcrumbFolderList メソッド

このメソッドを呼び出して、複数レベルのパンくずリストディレクトリに関する情報をクエリできます。これは、現在のディレクトリに基づいてパスアップ再帰が実行され、関連付けられているすべてのディレクトリがクエリされることを示します。このプロセス中に、getFile メソッドが呼び出されます。

返される配列には、ルートディレクトリは含まれていません。

例外

1. 403 エラーが返された場合、ディレクトリのクエリは禁止されており、クエリは終了します。返される配列では、ディレクトリの is_forbidden パラメーターは true に設定されています。

2. 別の例外が発生した場合、その例外が直接スローされます。

const result = await client.getBreadcrumbFolderList(params, options)

例

// たとえば、パス /a/b/c/ が存在するとします。
// ディレクトリ c のファイル ID は 620cb4363a20321aa66a495ca063ac2679a8f726 です。

const arr = await client.getBreadcrumbFoldderList({
  drive_id,
  file_id,
})
// 複数レベルのパンくずリストディレクトリに関する情報を返します：[{file_id： 'ディレクトリ a の ID'、name： 'a'}、{file_id： 'ディレクトリ b の ID'、name： 'b'}]

。

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	IGetBreadcrumbReq	はい	複数レベルのパンくずリストディレクトリに関する情報のクエリに使用されるパラメーター。
options	IPDSRequestConfig		その他のリクエストパラメーター。

IGetBreadcrumbReq

パラメーター	タイプ	必須	説明
drive_id	string		ドライブ ID。 drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。
share_id	string		共有 ID。 drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。
file_id	string	はい	現在のディレクトリの ID。
end_parent_id	string		クエリの終了対象となる親ディレクトリの ID。デフォルト値：root。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	IParentFolderNameId[]	はい	返された結果。

IParentFolderNameId

パラメーター	タイプ	必須	説明
file_id	string	はい	ディレクトリの ID。
name	string	はい	ディレクトリの名前。
is_forbidden	boolean		ディレクトリのクエリが禁止されているかどうかを示します。

getBreadcrumbFolders メソッド

警告

このメソッドを getBreadcrumbFolderList メソッドに置き換えることをお勧めします。

返される配列には、ルートディレクトリは含まれていません。

例外

1. 403 エラーが返された場合、ディレクトリのクエリは禁止されており、クエリは終了します。返される配列では、ディレクトリの is_forbidden パラメーターは true に設定されています。

2. 別の例外が発生した場合、その例外が直接スローされます。

const result = await client.getBreadcrumbFolders(drive_id,file_id, end_parent_id)

リクエストパラメーター

パラメーター	タイプ	必須	説明
drive_id	string	はい	ドライブ ID。
file_id	string	はい	ディレクトリ ID。
end_parent_id	string		クエリの終了対象となる親ディレクトリの ID。デフォルト値：root。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	IParentFolderNameId[]	はい	返された結果。

IParentFolderNameId

パラメーター	タイプ	必須	説明
file_id	string	はい	ディレクトリの ID。
name	string	はい	ディレクトリの名前。
is_forbidden	boolean		ディレクトリのクエリが禁止されているかどうかを示します。

createFolder メソッド

このメソッドを呼び出して、フォルダを作成できます。

const result = await client.createFolder(params, options)

例

await client.createFolder({
  name: 'new folder',  
  drive_id: '1',
  parent_file_id: 'root',
  // check_name_mode:'auto_rename'
})

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	ICreateFolderReq	はい	フォルダの作成に使用するパラメーター。詳細については、このトピックの `ICreateFolderReq` セクションをご参照ください。
options	IPDSRequestConfig	いいえ	その他のリクエストパラメーター。

ICreateFolderReq

パラメーター	タイプ	必須	説明
check_name_mode	string		新しいファイルの名前が既存のファイルと同じ名前の場合に使用されるポリシー。有効な値： auto_rename: ファイル名の末尾に乱数を追加します。 refuse: `code` が `AlreadyExists` である例外をスローします。 ignore: 新しいファイルに既存のファイルと同じ名前を付けることができます。デフォルト値: refuse。
drive_id	string		ドライブ ID。 drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。
share_id	string		共有 ID。このパラメーターは共有リンクで有効です。 drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。
name	string	はい	ディレクトリの名前。
parent_file_id	string	はい	親ディレクトリの ID。ディレクトリがルートディレクトリの場合は、値を root に設定します。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	ICreateFolderRes	はい	返された結果。

ICreateFolderRes

パラメーター	タイプ	必須	説明
domain_id	string	はい	ドメイン ID。
drive_id	string		ドライブ ID。 drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。
share_id	string		共有 ID。 drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。
encrypt_mode	string		暗号化モード。
file_id	string	はい	ファイル ID。
file_name	string	はい	ファイルの名前。
parent_file_id	string	はい。	親ディレクトリの ID。ディレクトリがルートディレクトリの場合は、値を root に設定します。
type	string	はい	エントリのタイプ。有効な値: file および folder。

例

{
  "parent_file_id": "root",
  "type": "folder",
  "file_id": "61ba1892abbe9f56bb7342c4beee82156e68dd67",
  "domain_id": "daily123",
  "drive_id": "1",
  "file_name": "new folder",
  "encrypt_mode": "none"
}

createFolders メソッド

このメソッドを呼び出して、フォルダを作成できます。新しいフォルダの名前が既存のフォルダと同じ名前の場合、check_name_mode パラメーターで指定されたポリシーが使用されます。

const result = await client.createFolders(folderNames, parentKey, config)

リクエストパラメーター

パラメーター	タイプ	必須	説明
folderNames	string[]	はい	フォルダの名前。たとえば、パスが a/b/c のディレクトリを作成する場合は、値を ['a', 'b', 'c' ] に設定します。
parentKey	IParentFileKey	はい	複数レベルのフォルダの作成に使用されるパラメーター。
config	ICreateFoldersConfig		オプションのリクエストパラメーター。

IParentFileKey

パラメーター	タイプ	必須	説明
drive_id	string		ドライブ ID。 drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。
share_id	string		共有 ID。 drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。
parent_file_id	string	はい	親ディレクトリの ID。ディレクトリがルートディレクトリの場合は、値を root に設定します。

ICreateFoldersConfig

パラメーター	タイプ	必須	説明
check_name_mode	string		新しいファイルの名前が既存のファイルと同じ名前の場合に使用されるポリシー。有効な値： auto_rename: ファイル名の末尾に乱数を追加します。 refuse: `onFolderRepeat` パラメーターを呼び戻します。 ignore: 新しいファイルに既存のファイルと同じ名前を付けることができます。 overwrite: 既存のファイルを、既存のファイルと同じ名前のファイルで上書きします。 skip: 同じ名前のファイルをスキップします。デフォルト値: refuse。
create_folder_cache	Map<string, any>={}		ディレクトリ情報をキャッシュする map メソッド。
onFolderRepeat	()=>boolean		指定したパスが存在する場合に呼び出されるコールバック。`true` の値が返された場合、作成は続行されます。`false` の値が返された場合、`code` が `AlreadyExists` である例外がスローされます。
onFolderCreated	(fileItem)=>void		作成が成功した場合に呼び出されるコールバック。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	string	はい	作成されたパス。

deleteFile メソッド

このメソッドを呼び出して、特定のファイルまたはフォルダを削除できます。

await client.deleteFile(params, permanently, options)

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	IFileKey	はい	削除するファイルまたはフォルダの情報。
permanently	boolean		ファイルまたはフォルダを完全に削除するかどうかを指定します。false の値は、ファイルまたはフォルダが一時的に削除され、復元できることを示します。true の値は、ファイルまたはフォルダが完全に削除されることを示します。デフォルト値：false。
options	IPDSRequestConfig		その他のリクエストパラメーター。

IFileKey

パラメーター	タイプ	必須	説明
share_id	string		共有 ID。drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。
drive_id	string		ドライブ ID。drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。
file_id	string		削除するファイルまたはフォルダの ID。

レスポンスパラメーター

単一のファイルが削除された場合、HTTP ステータスコード 204 が直接返され、レスポンスボディは空になります。

フォルダが削除された場合は、HTTP ステータスコード 202 とレスポンスパラメーターで構成される JSON 構造が返される場合があります。次の表に、レスポンスパラメーターを示します。

パラメーター	タイプ	必須	説明
async_task_id	string		非同期タスクの ID。
domain_id	string		ドライブ ID。
file_id	string		削除されたファイルまたはフォルダの ID。

batchDeleteFiles メソッド

このメソッドを呼び出して、複数のファイルまたはフォルダを一度に削除できます。

const result = await client.batchDeleteFiles(params, permanently, options)

リクエストパラメータ

パラメータ	タイプ	必須	説明
params	IFileKey[]	はい	削除するファイルまたはフォルダに関する情報。複数のファイルまたはフォルダを一度に削除できます。特定のパラメータの詳細については、この Topic の「successArr」セクションと「errorArr」セクションをご参照ください。ファイル ID またはディレクトリ ID のみを渡す必要があります。このメソッドは、ディレクトリにあるすべてのファイルを削除するために、自動的に再帰を実行します。
permanently	boolean	はい	ファイルまたはフォルダを完全に削除するかどうかを指定します。false の値は、ファイルまたはフォルダが一時的に削除され、復元できることを示します。true の値は、ファイルまたはフォルダが完全に削除されることを示します。デフォルト値：false。
options	IPDSRequestConfig	いいえ	その他のリクエストパラメータ。

レスポンスパラメータ

パラメータ	タイプ	必須	説明
result	オブジェクト	はい	返された結果。ファイルまたはフォルダが削除された場合は、successArr が返されます。ファイルまたはフォルダの削除に失敗した場合は、errorArr が返されます。

successArr

ファイルが削除された場合、successArr パラメータの値は undefined です。フォルダが削除された場合、返される結果には次のパラメータが含まれます。

パラメータ	タイプ	必須	説明
async_task_id	文字列	はい	非同期タスクの ID。
domain_id	文字列	はい	ドメイン ID。
drive_id	文字列	はい	ドライブ ID。
share_id	文字列		共有 ID。
file_id	文字列	はい	削除されたファイルまたはフォルダの ID。

errorArr

ファイルまたはフォルダの削除に失敗した場合、指定したファイル情報が返されます。

パラメータ	タイプ	必須	説明
share_id	文字列		共有 ID。
drive_id	文字列	はい	ドライブ ID。
file_id	文字列	はい	削除に失敗したファイルまたはフォルダの ID。

copyFiles メソッド

このメソッドを呼び出して、ファイルまたはフォルダをコピーできます。

const result = await client.copyFiles(params, config, options)

例

次のサンプルコードは、複数のファイルをコピーする方法の例を示しています。

const {items=[]} = await client.listFiles(req)
                                          
// fileItem 配列を渡します。
await client.copyFiles(items, {to_parent_file_id, to_drive_id})

単一のファイルをコピーする場合、次のサンプルコードを実行してファイルの名前を変更できます。

await client.copyFiles(item, { new_name: 'new file name', ... })

コピー処理中にコピー操作をキャンセルするには、次のサンプルコードを実行できます。

let stopFlag=false

// コピー操作をキャンセルするために使用されるメソッド。
function cancel(){
  stopFlag=true
}

await client.copyFiles(items, {
  getStopFlag()=>{
    return stopFlag
  } 
})

リクエストパラメータ

パラメーター	タイプ	必須	説明
params	IFileItemKey[]	はい	コピーするファイル。特定のパラメーターの詳細については、このトピックの「IFileKey」セクションをご参照ください。
config	ICopyFilesConfig	はい	ファイルのコピーに関連する構成。
options	IPDSRequestConfig		その他のリクエストパラメーター。

IFileItemKey

パラメーター	タイプ	必須	説明
ドライブID	文字列		ドライブ ID。 drive_id パラメーターと share_id パラメーターのいずれか 1 つを指定する必要があります。
共有 ID	文字列		共有 ID。 drive_id パラメーターと share_id パラメーターのいずれか 1 つを指定する必要があります。
ファイル ID	文字列	はい	ファイルまたはフォルダの ID です。
親ファイル ID	文字列	はい	親ディレクトリの ID です。

IFileItemKey

パラメーター	種類	必須	説明
to_parent_file_id	文字列	はい	ファイルをコピーするフォルダの ID です。
to_drive_id	string		ファイルをコピーする先のドライブの ID です。 drive_id パラメーターと share_id パラメーターのいずれか 1 つを指定する必要があります。
to_share_id	文字列		ファイルをコピーする共有の ID です。 drive_id パラメーターと share_id パラメーターのいずれか 1 つを指定する必要があります。
新しい名前	文字列		ファイルの新しい名前。このパラメーターは、単一のファイルをコピーする場合にのみ指定できます。
進行中	(count,total) => {}		コピーの進捗状況を示すコールバックパラメーター。 count と total の 2 つのパラメーターを含みます。
getStopFlag	()=>boolean（ブール値）		コピープロセスを停止するかどうかを指定します。「true」の値は、コピープロセスを停止することを指定します。「false」の値は、コピープロセスを続行することを指定します。

レスポンスパラメータ

パラメータ	タイプ	必須	説明
result	ICopyFileRes[]	はい	返された結果。

ICopyFileRes

パラメータ	タイプ	必須	説明
async_task_id	string		非同期タスクの ID。このパラメータは、フォルダをコピーする場合にのみ使用できます。
domain_id	string		ドメイン ID。
drive_id	string		ドライブ ID。 drive_id パラメータと share_id パラメータのいずれか 1 つを指定する必要があります。
share_id	string		共有 ID。 drive_id パラメータと share_id パラメータのいずれか 1 つを指定する必要があります。
file_id	string	はい	ファイル ID。

createFolder メソッド

このメソッドを呼び出して、フォルダを作成できます。

const result = await client.moveFiles(params, config, options)

例

次のサンプルコードは、複数のファイルを移動する方法の例を示しています。

const {items=[]} = await client.moveFiles(...)
                                          
// fileItem 配列を渡します。                                   
await client.moveFiles(items, {to_parent_file_id, to_drive_id })

単一のファイルを移動する場合、次のサンプルコードを実行することで、ファイルの名前を変更できます。

await client.moveFiles(item, { new_name: 'new file name', ... })

移動プロセス中に移動操作をキャンセルするには、次のサンプルコードを実行できます。

let stopFlag=false

// 移動操作をキャンセルするために使用されるメソッド。
function cancel(){
  stopFlag=true
}

await client.moveFiles(items, {
  getStopFlag()=>{
    return stopFlag
  } 
})

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	IFileItemKey[]	はい	移動するファイル。特定のパラメーターの詳細については、このトピックの「IFileKey」セクションをご参照ください。
config	ICopyFilesConfig	はい	ファイルの移動に関連する構成。詳細については、このトピックの「copyFiles メソッド」セクションをご参照ください。
options	IPDSRequestConfig		その他のリクエストパラメーター。

レスポンスパラメータ

パラメータ	タイプ	必須	説明
result	ICopyFileRes[]	はい	返された結果です。詳細については、「copyFiles メソッドのレスポンスパラメータ」をご参照ください。

getAsyncTask メソッド

このメソッドを呼び出して、タスクの進捗状況をクエリできます。

const result = await client.getAsyncTask(async_task_id, options) // result はタスクの結果を格納します。

リクエストパラメーター

パラメーター	型	必須	説明
async_task_id	string	はい	タスク ID。
options	IPDSRequestConfig		その他のリクエストパラメーター。

レスポンスパラメーター

パラメーター	型	必須	説明
result	object	はい	返された結果。詳細については、このトピックの「IAsyncTaskRes」セクションをご参照ください。

IAsyncTaskRes

パラメーター	型	必須	説明
async_task_id	string	はい	非同期タスクの ID。
state	string	はい	タスクの状態。有効な値：Failed、Success、PartialSucceed、および Running。
error_message	string		メッセージ。
error_code	number		タスクが Failed 状態の場合に返されるメッセージ。
url	string		ファイルがアーカイブされた後に archiveFile 操作によって返されるダウンロード URL。

pollingAsyncTask メソッド

このメソッドを呼び出すと、目的の結果が返されるまで、タスクの進捗状況を定期的にポーリングできます。

const result = await client.getAsyncTask(async_task_id, ttl_ms options) // async_task_id、ttl_ms、options を使用してクライアントから非同期タスクを取得します。

リクエストパラメーター

パラメーター	タイプ	必須	説明
async_task_id	string	はい	タスク ID。
ttl_ms	number		ポーリングを実行する間隔。単位：ミリ秒。デフォルト値：5000。
options	IPDSRequestConfig		その他のリクエストパラメーター。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	IAsyncTaskRes	はい	返された結果。