Class UofxService.DMS
文管服務
Inheritance
System.Object
UofxService.DMS
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Ede.Uofx.PubApi.Sdk.NetStd.Service
Assembly: Ede.Uofx.PubApi.Sdk.NetStd.dll
Syntax
public static class DMS
Methods
View SourceAddFolder(String, String)
新增資料夾
Declaration
public static async Task<IEnumerable<FolderModel>> AddFolder(string rootFolderCode, string folderPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | rootFolderCode | 文件庫(根目錄資料夾)的代碼 |
System.String | folderPath | 新增資料夾的路徑,ex: folder1/folder2 |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<FolderModel>> |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
CheckDocDuplication(String, String, List<FileViewModel>)
檢查資料夾內是否有同名的檔案
Declaration
public static async Task<bool> CheckDocDuplication(string rootFolderCode, string folderPath, List<FileViewModel> docs)
Parameters
Type | Name | Description |
---|---|---|
System.String | rootFolderCode | 文件庫(根目錄資料夾)的代碼 |
System.String | folderPath | 資料夾的路徑,如要在根目錄,請輸入 '/',ex: folder1/folder2 |
System.Collections.Generic.List<FileViewModel> | docs | 檢查的檔案 |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Boolean> |
CheckDocDuplication(String, String, List<String>)
檢查資料夾內是否有同名的檔案
Declaration
public static async Task<bool> CheckDocDuplication(string rootFolderCode, string folderPath, List<string> docNames)
Parameters
Type | Name | Description |
---|---|---|
System.String | rootFolderCode | 文件庫(根目錄資料夾)的代碼 |
System.String | folderPath | 資料夾的路徑,如要在根目錄,請輸入 '/',ex: folder1/folder2 |
System.Collections.Generic.List<System.String> | docNames | 檢查的檔名 |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Boolean> |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
DeleteDoc(String, String)
刪除文件
Declaration
public static async Task DeleteDoc(string rootFolderCode, string docPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | rootFolderCode | 文件庫(根目錄資料夾)的代碼 |
System.String | docPath | 文件路徑,ex: folder/file.docx |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
DeleteFolder(String, String)
刪除資料夾
Declaration
public static async Task<IEnumerable<FolderModel>> DeleteFolder(string rootFolderCode, string folderPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | rootFolderCode | 文件庫(根目錄資料夾)的代碼 |
System.String | folderPath | 刪除資料夾的路徑 |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<FolderModel>> |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
GetFolder(String)
取得文件庫(根目錄資料夾)的資料夾清單
Declaration
public static async Task<IEnumerable<FolderModel>> GetFolder(string rootFolderCode)
Parameters
Type | Name | Description |
---|---|---|
System.String | rootFolderCode | 文件庫(根目錄資料夾)的代碼 |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<FolderModel>> |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
GetFolderContent(String, String, PageRequestModel)
取得資料夾內容清單
Declaration
public static async Task<SearchByPage<FolderDetailResponseModel>> GetFolderContent(string rootFolderCode, string folderPath, PageRequestModel pageModel)
Parameters
Type | Name | Description |
---|---|---|
System.String | rootFolderCode | 文件庫(根目錄資料夾)的代碼 |
System.String | folderPath | 資料夾的路徑,如要查詢根目錄,請輸入 '/',ex: folder1/folder2 |
PageRequestModel | pageModel | 分頁設定 |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<SearchByPage<FolderDetailResponseModel>> |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
GetRootFolder()
取得文件庫(根目錄資料夾)清單
Declaration
public static async Task<IEnumerable<RootFolderModel>> GetRootFolder()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<RootFolderModel>> |
RenameFolder(String, String, String)
資料夾更名
Declaration
public static async Task<IEnumerable<FolderModel>> RenameFolder(string rootFolderCode, string folderPath, string newName)
Parameters
Type | Name | Description |
---|---|---|
System.String | rootFolderCode | 文件庫(根目錄資料夾)的代碼 |
System.String | folderPath | 資料夾的路徑,ex: folder1/folder2 |
System.String | newName | 新的名稱 |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<FolderModel>> |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
UploadDoc(String, String, DocumentDuplicateAction, FileViewModel)
上傳檔案到指定資料夾
Declaration
public static async Task UploadDoc(string rootFolderCode, string folderPath, DocumentDuplicateAction action, FileViewModel doc)
Parameters
Type | Name | Description |
---|---|---|
System.String | rootFolderCode | 文件庫(根目錄資料夾)的代碼 |
System.String | folderPath | 資料夾的路徑,如要在根目錄,請輸入 '/',ex: folder1/folder2 |
DocumentDuplicateAction | action | 檔名重複時的處置方式 |
FileViewModel | doc | 要上傳的檔案 |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
UploadDoc(String, String, DocumentDuplicateAction, List<FileViewModel>)
上傳檔案到指定資料夾
Declaration
public static async Task UploadDoc(string rootFolderCode, string folderPath, DocumentDuplicateAction action, List<FileViewModel> docs)
Parameters
Type | Name | Description |
---|---|---|
System.String | rootFolderCode | 文件庫(根目錄資料夾)的代碼 |
System.String | folderPath | 資料夾的路徑,如要在根目錄,請輸入 '/',ex: folder1/folder2 |
DocumentDuplicateAction | action | 檔名重複時的處置方式 |
System.Collections.Generic.List<FileViewModel> | docs | 要上傳的檔案 |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |