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#实现方法：

 /// <summary>
 ///  根据文件ID删除文件
 /// </summary>
 /// <param name="accessToken">令牌</param>
 /// <param name="fileId">文件ID</param>
 /// <returns></returns>
 public virtual FileDeleteResponse DeleteFile(string accessToken, string fileId)
 {
     //DELETE https://file.bimface.com/file
     string url = string.Format(BimfaceConstants.FILE_HOST + "/file?fileId={0}", fileId);

     BimFaceHttpHeaders headers = new BimFaceHttpHeaders();
     headers.AddOAuth2Header(accessToken);

     try
     {
         FileDeleteResponse response;

         HttpManager httpManager = new HttpManager(headers);
         HttpResult httpResult = httpManager.Delete(url);
         if (httpResult.Status == HttpResult.STATUS_SUCCESS)
         {
             response = httpResult.Text.DeserializeJsonToObject<FileDeleteResponse>();
         }
         else
         {
             response = new FileDeleteResponse
             {
                 Message = httpResult.RefText
             };
         }

         return response;
     }
     catch (Exception ex)
     {
         throw new Exception("[根据文件ID删除文件]发生异常！", ex);
     }
 }

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

 /// <summary>
 /// HTTP-DELETE方法，(不包含body数据)。
 /// 发送 HTTP 请求并返回来自 Internet 资源的响应(HTML代码)
 /// </summary>
 /// <param name="url">请求目标URL</param>
 /// <returns>HTTP-POST的响应结果</returns>
 public HttpResult Delete(string url)
 {
     return RequestString(url, null, HttpMethod.DELETE, null);
 }

其中引用的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();
}

系列目录     【已更新最新开发文章，点击查看详细】