跳轉到

資料夾

資料夾物件 FolderModel

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Models.Dms

物件名稱: FolderModel

屬性 型態 說明
Id Guid Folder Id
ParentId Guid? 上一層 Folder Id
Name string Folder 名稱
Path string Folder 路徑

取得文件庫清單

在呼叫所有文件中心的功能前,都必須先知道文件庫的 代碼,代碼由文件庫管理員進行設定,您可以透過下列方法取得您有權限存取的文件庫清單,並查看其代碼...等資訊。

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Service

方法名稱: UofxService.DMS.GetRootFolder

var rootList = await UofxService.DMS.GetRootFolder();

回傳結果

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Models.Dms

物件名稱: RootFolderModel

屬性 型態 說明
Id Guid Folder Id
Code string 文件庫代碼
Name string 文件庫名稱
IsFromAI bool 是AI知識庫

為什麼我的回傳結果是空陣列

代表您的金鑰沒有被 授權 使用任一個文件庫。

為什麼我的文件庫代碼是空值

代表此文件庫尚未設定代碼,請聯絡管理員進行設定。

取得資料夾清單

文件庫的資料夾(folder)是樹狀結構,一次只能取得一個文件庫的資料夾清單,透過下列方法取得:

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Service

方法名稱: UofxService.DMS.GetFolder

var folderList = await UofxService.DMS.GetFolder(new GetFolderReqModel()
{
  RootFolderCode = "rootCode"
});

輸入參數

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Models.Dms

物件名稱: GetFolderReqModel

屬性 型態 必填 預設值 說明
RootFolderCode string V 文件庫(根目錄資料夾)的代碼

回傳結果

回傳的型態為 IEnumerable<FolderModel>,是 FolderModel 類別的集合

在最上層的資料夾,其 ParentId 會是 null

新增資料夾

要在文件庫新增資料夾,須提供 新資料夾 的路徑,例如原本資料夾結構為:

📜 文件庫A
|  └─ 📂 資料夾A
|  └─ 📂 資料夾B
如果想要新增 資料夾D 使其變成如下結構:
📜 文件庫A
|  └─ 📂 資料夾A
|    └─ 📂 資料夾C
|       └─ 📂 資料夾D <== 想新增的資料夾
|  └─ 📂 資料夾B
此時只需設定 資料夾D 的路徑為 /資料夾A/資料夾C/資料夾D,系統即會自動補齊路徑中缺少的 資料夾C

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Service

方法名稱: UofxService.DMS.AddFolder

var newFolderPath = "/資料夾A/資料夾C/資料夾D"; //新資料夾路徑
var folderList = await UofxService.DMS.AddFolder(new AddFolderReqModel()
{
  RootFolderCode = "rootCode",
  FolderPath = newFolderPath
});

輸入參數

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Models.Dms

物件名稱: AddFolderReqModel

屬性 型態 必填 預設值 說明
RootFolderCode string V 文件庫(根目錄資料夾)的代碼
FolderPath string V 新增資料夾的路徑,ex: folder1/folder2

回傳結果

回傳的型態為 IEnumerable<FolderModel>,是 FolderModel 類別的集合

刪除資料夾

要在文件庫刪除資料夾,須提供 預刪除資料夾 的路徑,例如我想刪除 資料夾D :

📜 文件庫A
|  └─ 📂 資料夾A
|    └─ 📂 資料夾C
|       └─ 📂 資料夾D <== 想刪除增的資料夾
|  └─ 📂 資料夾B

資料夾D 的路徑為 /資料夾A/資料夾C/資料夾D,程式撰寫如下:

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Service

方法名稱: UofxService.DMS.DeleteFolder

var delFolderPath = "/資料夾A/資料夾C/資料夾D"; //刪除的資料夾路徑
var folderList = await UofxService.DMS.DeleteFolder(new DeleteFolderReqModel()
{
  RootFolderCode = "rootCode",
  FolderPath = delFolderPath
});

刪除後結構變成:

📜 文件庫A
|  └─ 📂 資料夾A
|    └─ 📂 資料夾C
|  └─ 📂 資料夾B

輸入參數

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Models.Dms

物件名稱: DeleteFolderReqModel

屬性 型態 必填 預設值 說明
RootFolderCode string V 文件庫(根目錄資料夾)的代碼
FolderPath string V 刪除資料夾的路徑,ex: folder1/folder2

回傳結果

回傳的型態為 IEnumerable<FolderModel>,是 FolderModel 類別的集合

修改資料夾名稱

要修改資料夾名稱,須提供 資料夾 的路徑。例如我想將 資料夾C 更名為 資料夾C-1,其路徑為 /資料夾A/資料夾C:

📜 文件庫A
|  └─ 📂 資料夾A
|    └─ 📂 資料夾C
|  └─ 📂 資料夾B

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Service

方法名稱: UofxService.DMS.RenameFolder

var folderPath = "/資料夾A/資料夾C"; //資料夾路徑
var newName = "資料夾C-1";
var folderList = await UofxService.DMS.UpdateFolder(new UpdateFolderReqModel()
{
  RootFolderCode = "rootCode",
  FolderPath = folderPath,
  NewName = newName
});
其正確執行結果將變成:

📜 文件庫A
|  └─ 📂 資料夾A
|    └─ 📂 資料夾C-1
|  └─ 📂 資料夾B

輸入參數

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Models.Dms

物件名稱: UpdateFolderReqModel

屬性 型態 必填 預設值 說明
RootFolderCode string V 文件庫(根目錄資料夾)的代碼
FolderPath string V 要修改的資料夾的路徑,ex: folder1/folder2
NewName string V 新的名稱

回傳結果

回傳的型態為 IEnumerable<FolderModel>,是 FolderModel 類別的集合

取得資料夾權限

SDK 支援取得資料夾或文件庫的權限

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Service

方法名稱: UofxService.DMS.RenameFolder

var folderPath = "/資料夾A/資料夾C"; //資料夾路徑,如要查詢根目錄,請輸入 '/'
var permission = await UofxService.DMS.GetFolderPermission(new GetFolderPermissionModel()
{
  RootFolderCode = "rootCode",
  FolderPath = folderPath,
});

輸入參數

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Models.Dms

物件名稱: GetFolderPermissionModel

屬性 型態 必填 預設值 說明
RootFolderCode string V 文件庫(根目錄資料夾)的代碼
FolderPath string V 資料夾的路徑,ex: folder1/folder2

回傳結果

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Models.Dms

物件名稱: FolderPermissionModel

屬性 型態 說明
Readers List<UserSetItem> 讀者

更新資料夾權限

取得權限後可以對其修改,新增權限請參考 UserSet 章節 > 自己建立 UserSetItem 物件,修改後可以透過下列方式更新權限:

命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Service

方法名稱: UofxService.DMS.UpdateFolderPermission

var folderPath = "/資料夾A/資料夾C"; //資料夾路徑,如要查詢根目錄,請輸入 '/'
var permission = await UofxService.DMS.UpdateFolderPermission(new UpdateFolderPermissionModel()
{
  RootFolderCode = "rootCode",
  FolderPath = folderPath,
  Readers = readerUserSet
});
輸入參數 命名空間: Ede.Uofx.OpenApi.Sdk.NetStd.Models.Dms

物件名稱: UpdateFolderPermissionModel

屬性 型態 必填 預設值 說明
RootFolderCode string V 文件庫(根目錄資料夾)的代碼
FolderPath string V 資料夾的路徑,ex: folder1/folder2
Readers List<UserSetItem> V 新的讀者權限