JavaScript 用 PDS SDK を使用してファイル権限を管理する方法 - Drive and Photo Service

このトピックでは、ファイルの権限を管理するために使用されるメソッドについて説明します。

説明

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

listSharingFiles メソッド

共有ファイルのリストをクエリします。

const result = await client.listSharingFiles(params, options) // 共有ファイルリストを取得します。

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	IListReq	いいえ	共有ファイルのリストをクエリするために使用されるリクエストパラメーター。このパラメーターを指定しない場合、デフォルト値 {} が使用されます。
options	IPDSRequestConfig	いいえ	その他のリクエストパラメーター。

IListReq フィールド

フィールド	タイプ	必須	説明
limit	number	はい	返すエントリの最大数。
marker	string	はい	クエリの開始マーカー。

レスポンスパラメーター

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

IListRes フィールド

フィールド	タイプ	必須	説明
items	array	はい	返されたファイルのリスト。詳細については、次の表を参照してください。
next_marker	string	はい	ページネーショントークン。
punished_file_count	number	いいえ	ペナルティを受けたファイルの数。

IFileItem フィールド

フィールド	タイプ	必須	説明
action_list	string[]	いいえ	ファイルの権限。
created_at	Date	はい	ファイルが作成された日時。
creator_id	string	いいえ	ファイルを作成したユーザーの ID。
creator_name	string	いいえ	ファイルを作成したユーザーの名前。
creator_type	string	いいえ	ファイルを作成したユーザーのタイプ。
domain_id	string	はい	ドメイン ID。
drive_id	string	はい	ドライブ ID。
encrypt_mode	string	いいえ	ファイルの暗号化モード。
file_id	string	いいえ	ファイル ID。
hidden	boolean	いいえ	ファイルが非表示かどうかを示します。
last_modifier_id	string	いいえ	ファイルに最後に変更を加えたユーザーの ID。
last_modifier_name	string	いいえ	ファイルに最後に変更を加えたユーザーの名前。
last_modifier_type	string	いいえ	ファイルに最後に変更を加えたユーザーのタイプ。
name	string	いいえ	ファイル名。
parent_file_id	string	いいえ	ファイルの親ディレクトリの ID。
revision_id	string	いいえ	ファイルのバージョン。
starred	boolean	いいえ	ファイルがお気に入りに追加されているかどうかを示します。true の値は、ファイルがお気に入りに追加されていることを示します。
status	string	はい	ファイルのステータス。有効な値：available および enabled。
type	string	いいえ	ファイルのタイプ。例：folder。
updated_at	Date	はい	ファイルが更新された日時。

listReceivedFiles メソッド

受信した共有ファイルに関する情報をクエリします。

const result = await client.listReceivedFiles(params, options) // 受信した共有ファイルのリストを取得します。

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	IListReq	いいえ	受信した共有ファイルに関する情報をクエリするために使用されるリクエストパラメーター。このパラメーターを指定しない場合、デフォルト値 {} が使用されます。
options	IPDSRequestConfig	いいえ	その他のリクエストパラメーター。

IListReq フィールド

フィールド	タイプ	必須	説明
limit	number	いいえ	返すエントリの最大数。
marker	string	いいえ	クエリの開始マーカー。

レスポンスパラメーター

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

IListRes フィールド

フィールド	タイプ	必須	説明
items	array	はい	クエリされたファイルの情報。詳細については、次の表を参照してください。
next_marker	string	いいえ	ページネーショントークン。
punished_file_count	number	いいえ	ペナルティを受けたファイルの数。

addFilePermission メソッド

ファイルの共有を作成または更新します。

const result = await client.addFilePermission(params, options) // ファイルの共有を作成または更新します。

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	IAddFilePermissionReq	はい	ファイルの共有を作成または更新するために使用されるリクエストパラメーター。
options	IPDSRequestConfig	いいえ	その他のリクエストパラメーター。

IAddFilePermissionReq フィールド

フィールド	タイプ	必須	説明
drive_id	string	はい	ドライブ ID。
file_id	string	いいえ	共有するファイルの ID。
member_list	array	いいえ	ファイルを共有するユーザー。詳細については、次の表を参照してください。

IPermissionStandard フィールド

フィールド	タイプ	必須	説明
identity	object	はい	ファイルを共有するユーザーの ID。このパラメーターには、identity_type フィールドと identity_id フィールドが含まれます。
expire_time	number	はい	ファイルの有効期限。値を UNIX タイムスタンプに設定します。
role_id	string	はい	ロール ID。
disinherit_sub_group	boolean	はい	サブグループを継承するかどうかを指定します。

レスポンスパラメーター

標準モードでファイルの共有が作成または更新された場合、値は返されません。それ以外の場合、エラーメッセージが返されます。

removeFilePermission メソッド

ファイルの共有を削除します。

await client.removeFilePermission(params, options) // ファイルの共有を削除します。

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	IAddFilePermissionReq	はい	ファイルの共有を削除するために使用されるリクエストパラメーター。
options	IPDSRequestConfig	いいえ	その他のリクエストパラメーター。

レスポンスパラメーター

共有が削除された場合、値は返されません。それ以外の場合、エラーメッセージが返されます。

listFilePermissions メソッド

ファイルの権限をクエリします。

const result = await client.listFilePermission(params, options) // ファイルの権限リストを取得します。

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	IListPermissionReq	はい	ファイルの権限をクエリするために使用されるリクエストパラメーター。
options	IPDSRequestConfig	いいえ	その他のリクエストパラメーター。

IListPermissionReq パラメーター

パラメーター	タイプ	必須	説明
drive_id	string	はい	ドライブ ID。
file_id	string	はい	ファイル ID。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	array	はい	返された結果。詳細については、次の表を参照してください。

IPermissionStandard パラメーター

パラメーター	タイプ	必須	説明
identity	object	はい	ファイルに対する権限を持つユーザーの ID。このパラメーターには、identity_name、identity_type、および identity_id フィールドが含まれます。
expire_time	number	はい	ファイルの有効期限。値は UNIX タイムスタンプです。
role_id	string	はい	ロール ID。
disinherit_sub_group	boolean	はい	サブグループが継承されるかどうかを示します。