Topik ini menjelaskan metode-metode yang digunakan untuk mengelola izin pada file.
Parameter options dari tipe IPDSRequestConfig dienkapsulasi berdasarkan opsi konfigurasi permintaan axios. Untuk informasi lebih lanjut, lihat AxiosRequestConfig.
Metode listSharingFiles
Meminta daftar file yang dibagikan.
const result = await client.listSharingFiles(params, options)Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | IListReq | Tidak | Parameter permintaan yang digunakan untuk meminta daftar file yang dibagikan. Jika Anda tidak menentukan parameter ini, nilai default {} akan digunakan. |
options | IPDSRequestConfig | Tidak | Parameter permintaan lainnya. |
Bidang IListReq
Bidang | Tipe | Diperlukan | Deskripsi |
limit | number | Ya | Jumlah maksimum entri yang dikembalikan. |
marker | string | Ya | Penanda awal dari kueri. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IListRes<IFileItem> | Ya | Hasil yang dikembalikan. |
Bidang IListRes
Bidang | Tipe | Diperlukan | Deskripsi |
items | array | Ya | Daftar file yang dikembalikan. Untuk informasi lebih lanjut, lihat tabel berikut. |
next_marker | string | Ya | Token paginasi. |
punished_file_count | number | Tidak | Jumlah file yang dikenai hukuman. |
Bidang IFileItem
Bidang | Tipe | Diperlukan | Deskripsi |
action_list | string[] | Tidak | Izin pada file. |
created_at | Date | Ya | Waktu saat file dibuat. |
creator_id | string | Tidak | ID pengguna yang membuat file. |
creator_name | string | Tidak | Nama pengguna yang membuat file. |
creator_type | string | Tidak | Tipe pengguna yang membuat file. |
domain_id | string | Ya | ID domain. |
drive_id | string | Ya | ID drive. |
encrypt_mode | string | Tidak | Mode enkripsi file. |
file_id | string | Tidak | ID file. |
hidden | boolean | Tidak | Menunjukkan apakah file disembunyikan. |
last_modifier_id | string | Tidak | ID pengguna yang terakhir memodifikasi file. |
last_modifier_name | string | Tidak | Nama pengguna yang terakhir memodifikasi file. |
last_modifier_type | string | Tidak | Tipe pengguna yang terakhir memodifikasi file. |
name | string | Tidak | Nama file. |
parent_file_id | string | Tidak | ID direktori induk dari file. |
revision_id | string | Tidak | Versi file. |
starred | boolean | Tidak | Menunjukkan apakah file ditambahkan ke favorit. Nilai true menunjukkan bahwa file ditambahkan ke favorit. |
status | string | Ya | Status file. Nilai valid: available dan enabled. |
type | string | Tidak | Tipe file. Contoh: folder. |
updated_at | Date | Ya | Waktu saat file diperbarui. |
Metode listReceivedFiles
Meminta informasi tentang file yang dibagikan dan diterima.
const result = await client.listReceivedFiles(params, options)Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | IListReq | Tidak | Parameter permintaan yang digunakan untuk meminta informasi tentang file yang dibagikan yang diterima. Jika Anda tidak menentukan parameter ini, nilai default {} akan digunakan. |
options | IPDSRequestConfig | Tidak | Parameter permintaan lainnya. |
Bidang IListReq
Bidang | Tipe | Diperlukan | Deskripsi |
limit | number | Tidak | Jumlah maksimum entri yang dikembalikan. |
marker | string | Tidak | Penanda awal dari kueri. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IListRes<IFileItem> | Ya | Hasil yang dikembalikan. |
Bidang IListRes
Bidang | Tipe | Diperlukan | Deskripsi |
items | array | Ya | Informasi tentang file yang diminta. Untuk informasi lebih lanjut, lihat tabel berikut. |
next_marker | string | Tidak | Token paginasi. |
punished_file_count | number | Tidak | Jumlah file yang dikenai hukuman. |
Metode addFilePermission
Membuat atau memperbarui share untuk sebuah file.
const result = await client.addFilePermission(params, options)Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | IAddFilePermissionReq | Ya | Parameter permintaan yang digunakan untuk membuat atau memperbarui share untuk sebuah file. |
options | IPDSRequestConfig | Tidak | Parameter permintaan lainnya. |
Bidang IAddFilePermissionReq
Bidang | Tipe | Diperlukan | Deskripsi |
drive_id | string | Ya | ID drive. |
file_id | string | Tidak | ID file yang akan dibagikan. |
member_list | array | Tidak | Pengguna dengan siapa Anda ingin membagikan file. Untuk informasi lebih lanjut, lihat tabel berikut. |
Bidang IPermissionStandard
Bidang | Tipe | Diperlukan | Deskripsi |
identity | object | Ya | Identitas pengguna dengan siapa Anda ingin membagikan file. Parameter ini berisi bidang identity_type dan identity_id. |
expire_time | number | Ya | Waktu kedaluwarsa file. Atur nilainya menjadi timestamp UNIX. |
role_id | string | Ya | ID peran. |
disinherit_sub_group | boolean | Ya | Menentukan apakah akan mewarisi subgrup. |
Parameter respons
Jika share dibuat atau diperbarui untuk file dalam mode standar, tidak ada nilai yang dikembalikan. Jika tidak, pesan kesalahan akan dikembalikan.
Metode removeFilePermission
Menghapus share dari sebuah file.
await client.removeFilePermission(params, options)Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | IAddFilePermissionReq | Ya | Parameter permintaan yang digunakan untuk menghapus share dari sebuah file. |
options | IPDSRequestConfig | Tidak | Parameter permintaan lainnya. |
Parameter respons
Jika share dihapus, tidak ada nilai yang dikembalikan. Jika tidak, pesan kesalahan akan dikembalikan.
Metode listFilePermissions
Meminta izin pada sebuah file.
const result = await client.listFilePermission(params, options)Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | IListPermissionReq | Ya | Parameter permintaan yang digunakan untuk meminta izin pada sebuah file. |
options | IPDSRequestConfig | Tidak | Parameter permintaan lainnya. |
Parameter IListPermissionReq
Parameter | Tipe | Diperlukan | Deskripsi |
drive_id | string | Ya | ID drive. |
file_id | string | Ya | ID file. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | array | Ya | Hasil yang dikembalikan. Untuk informasi lebih lanjut, lihat tabel berikut. |
Parameter IPermissionStandard
Parameter | Tipe | Diperlukan | Deskripsi |
identity | object | Ya | Identitas pengguna yang memiliki izin pada file. Parameter ini berisi bidang identity_name, identity_type, dan identity_id. |
expire_time | number | Ya | Waktu kedaluwarsa file. Nilainya adalah timestamp UNIX. |
role_id | string | Ya | ID peran. |
disinherit_sub_group | boolean | Ya | Menunjukkan apakah subgrup diwarisi. |