C#開發BIMFACE系列11 服務端API之源文件刪除

系列目錄     【已更新最新開發文章，點擊查看詳細】

經過BIMFACE控制檯或者調用服務接口上傳文件成功後，若是再也不須要該文件，則能夠經過BIMFACE平臺提供的「源文件刪除」服務接口刪除具體的文件。下面詳細介紹其使用方法。

請求地址：DELETE https://file.bimface.com/file

說明：根據文件ID刪除文件

參數：

請求 path(示例)：https://file.bimface.com/file?fileId=1418750515413120

請求 header(示例)："Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"

HTTP響應示例(200)：

{
  "code" : "success",
  "data" : "object",  // 若是刪除成功，則該值爲 null
  "message" : ""
}

C#實現方法：

 1 /// <summary>
 2 ///  根據文件ID刪除文件
 3 /// </summary>
 4 /// <param name="accessToken">令牌</param>
 5 /// <param name="fileId">文件ID</param>
 6 /// <returns></returns>
 7 public virtual FileDeleteResponse DeleteFile(string accessToken, string fileId)
 8 {
 9     //DELETE https://file.bimface.com/file
10     string url = string.Format(BimfaceConstants.FILE_HOST + "/file?fileId={0}", fileId);
11 
12     BimFaceHttpHeaders headers = new BimFaceHttpHeaders();
13     headers.AddOAuth2Header(accessToken);
14 
15     try
16     {
17         FileDeleteResponse response;
18 
19         HttpManager httpManager = new HttpManager(headers);
20         HttpResult httpResult = httpManager.Delete(url);
21         if (httpResult.Status == HttpResult.STATUS_SUCCESS)
22         {
23             response = httpResult.Text.DeserializeJsonToObject<FileDeleteResponse>();
24         }
25         else
26         {
27             response = new FileDeleteResponse
28             {
29                 Message = httpResult.RefText
30             };
31         }
32 
33         return response;
34     }
35     catch (Exception ex)
36     {
37         throw new Exception("[根據文件ID刪除文件]發生異常！", ex);
38     }
39 }

其中引用的 httpManager.Delete() 方法以下：

 1 /// <summary>
 2 /// HTTP-DELETE方法，(不包含body數據)。
 3 /// 發送 HTTP 請求並返回來自 Internet 資源的響應(HTML代碼)
 4 /// </summary>
 5 /// <param name="url">請求目標URL</param>
 6 /// <returns>HTTP-POST的響應結果</returns>
 7 public HttpResult Delete(string url)
 8 {
 9     return RequestString(url, null, HttpMethod.DELETE, null);
10 }

 其中引用的RequestString()方法，請參考《C#開發BIMFACE系列6 服務端API之獲取文件信息》，方法徹底同樣。

測試

 在BIMFACE的控制檯中能夠看到咱們上傳的文件列表

選擇任意一個文件的ID來作測試

能夠看到刪除文件成功。

再次刷新BIMFACE控制檯，只剩下了一筆記錄，1681963336074720 文件被成功刪除。

 測試程序以下：

// 根據文件ID刪除文件
protected void btnDeleteFile_Click(object sender, EventArgs e)
{
    txtFileInfo.Text = string.Empty;

    string token = txtAccessToken.Text;
    string fileId = txtFileId.Text;

    FileApi api = new FileApi();
    FileDeleteResponse response = api.DeleteFile(token, fileId);
    
    txtFileInfo.Text = response.Code
                     + Environment.NewLine
                     + response.Message
                     + Environment.NewLine
                     + response.Data.ToString2();
}

 

系列目錄     【已更新最新開發文章，點擊查看詳細】