目录

文件评论

场景介绍

华为云空间服务支持用户对云端文件进行评论,并对评论进行查看、更新和删除操作。

创建评论

功能简介

Comments.create接口实现对某个文件的评论。

限制

发送一个创建评论的请求

  1. 创建一个对Comments.create接口的POST请求。
  2. 添加查询参数fileId和fields。

    例如:

    POST https://driveapis.cloud.huawei.com.cn/drive/v1/files/{fileId}/comments?fields=*

  3. 填入HTTP headers。

    • Accept:接收回复的报文格式
    • Content-Type:发送报文格式
    • Cache-Control:缓存控制
    • Authorization:填入从华为帐号获取的authorization code

  4. 发送请求。

    请求示例:
    POST https://driveapis.cloud.huawei.com.cn/drive/v1/files/AAAB9Wn0DTQCIqPbW9avGjAQo9dbxg04A/comments?fields=* HTTP/1.1 
    Accept: application/json 
    Content-Type: application/json 
    Authorization: Bearer CV3PnPLZXyr9K2GV7RYZkF962JZvoEkMQhTho3QHQAPQUyma/lEyZskP/IMWrc7FvaeHivO7y0lyibI/fQvulBnTgtXArSVPsjaLKvYNkDsJSaIR2/sx+K40bYDWWpKFvJNKg2U47jRwz2mfiF3ortNk 
    Cache-Control: no-cache 
    
    { 
        "description":"2020/02/17 11:20",
        "quotedContent":{"mimeType":"text/html","content":"222222"},
        "position":"{'revision':'1-0','region':[{'line':{'ln':1,'len':2,'flen':10}}]}"
    }

    响应:

    HTTP/1.1 200 OK 
    {  
        "creator": {
            "permissionId": "299639512454136576",
            "displayName": "*******3121@**3.com",
            "me": true,
            "category": "drive#user"
        },
        "editedTime": "2020-02-19T13:13:23.635Z",
        "deleted": false,
        "description": "2020/02/17 11:20",
        "createdTime": "2020-02-19T13:13:23.635Z",
        "position": "{'revision':'1-0','region':[{'line':{'ln':1,'len':2,'flen':10}}]}",
        "id": "BkytC_85-y5hoiLxCRnNCHZcDynNC_siY",
        "htmlDescription": "2020/02/17 11:20",
        "category": "drive#comment",
        "quotedContent": {
            "mimeType": "text/html",
            "content": "222222"
        }
    }

获取评论

功能简介

Comments.get接口实现获取某个评论。

限制

发送一个获取评论的请求

  1. 创建一个对Comments.get接口的GET请求。
  2. 添加查询参数fileId、commentId和fields。

    例如:

    GET https://driveapis.cloud.huawei.com.cn/drive/v1/files/{fileId}/comments/{commentId}?fields=*

  3. 填入HTTP headers。

    • Accept:接收回复的报文格式
    • Cache-Control:缓存控制
    • Authorization:填入从华为帐号获取的authorization code

  4. 发送请求。

    请求示例:
    GET https://driveapis.cloud.huawei.com.cn/drive/v1/files/AAAB9Wn0DTQCIqPbW9avGjAQo9dbxg04A/comments/BkytC_85-y5hoiLxCRnNCHZcDynNC_siY?fields=* HTTP/1.1 Accept: application/json
    Authorization: Bearer CV3PnPLZXyr9K2GV7RYZkF962JZvoEkMQhTho3QHQAPQUyma/lEyZskP/IMWrc7FvaeHivO7y0lyibI/fQvulBnTgtXArSVPsjaLKvYNkDsJSaIR2/sx+K40bYDWWpKFvJNKg2U47jRwz2mfiF3ortNk 
    Cache-Control: no-cache 

    响应:

    HTTP/1.1 200 OK 
    {  
        "creator": {
            "permissionId": "299639512454136576",
            "displayName": "*******3121@**3.com",
            "me": true,
            "category": "drive#user"
        },
        "editedTime": "2020-02-19T13:13:23.635Z",
        "deleted": false,
        "description": "2020/02/17 11:20",
        "createdTime": "2020-02-19T13:13:23.635Z",
        "position": "{'revision':'1-0','region':[{'line':{'ln':1,'len':2,'flen':10}}]}",
        "id": "BkytC_85-y5hoiLxCRnNCHZcDynNC_siY",
        "htmlDescription": "2020/02/17 11:20",
        "category": "drive#comment",
        "quotedContent": {
            "mimeType": "text/html",
            "content": "222222"
        }
    }

获取评论列表

功能简介

Comments.list接口实现列出所有对某个文件的评论,用户可以根据startEditedTime设定评论创建的起始时间、根据pageSize的设定获取需要的页面大小等。

限制

说明

includeDeleted参数功能暂时不支持使用。

发送一个获取评论列表的请求

  1. 创建一个对Comments.list接口的GET请求。
  2. 添加查询参数fileId和fields。

    例如:

    GET https://driveapis.cloud.huawei.com.cn/drive/v1/files/{fileId}/comments?fields=*

  3. 填入HTTP headers。

    • Accept:接收回复的报文格式
    • Cache-Control:缓存控制
    • Authorization:填入从华为帐号获取的authorization code

  4. 发送请求。

    请求示例:
    GET https://driveapis.cloud.huawei.com.cn/drive/v1/files/AAAB9Wn0DTQCIqPbW9avGjAQo9dbxg04A/comments?fields=* HTTP/1.1 
    Accept: application/json
    Authorization: Bearer CV3PnPLZXyr9K2GV7RYZkF962JZvoEkMQhTho3QHQAPQUyma/lEyZskP/IMWrc7FvaeHivO7y0lyibI/fQvulBnTgtXArSVPsjaLKvYNkDsJSaIR2/sx+K40bYDWWpKFvJNKg2U47jRwz2mfiF3ortNk 
    Cache-Control: no-cache 

    响应:

    HTTP/1.1 200 OK 
    {
        "nextCursor": "BF5D1350B585F44D5A359F0BF8883A195",
        "comments": [
            {
                "creator": {
                    "permissionId": "299639512454136576",
                    "displayName": "*******3121@**3.com",
                    "me": true,
                    "category": "drive#user"
                },
                "editedTime": "2020-02-18T06:09:33Z",
                "deleted": false,
                "description": "2020/02/1777 11:70",
                "createdTime": "2020-02-18T06:09:33Z",
                "position": "{'revision':'1-0','region':[{'line':{'ln':1,'len':2,'flen':10}}]}",
                "id": "BnGCVaQyhH6CMBTwGXE1BV5hIHeWAIRyg",
                "htmlDescription": "2020/02/1777 11:70",
                "category": "drive#comment",
                "quotedContent": {
                    "mimeType": "text/html",
                    "content": "222222"
                }
            },
            {
                "creator": {
                    "permissionId": "299639512454136576",
                    "displayName": "*******3121@**3.com",
                    "me": true,
                    "category": "drive#user"
                },
                "editedTime": "2020-02-18T06:21:21Z",
                "deleted": false,
                "description": "2020/02/1777 11:70",
                "createdTime": "2020-02-18T06:21:21Z",
                "position": "{'revision':'1-0','region':[{'line':{'ln':1,'len':2,'flen':10}}]}",
                "id": "Bg98CUePG7_oH4b9qLUhJ04f3it1vRuz6",
                "htmlDescription": "2020/02/1777 11:70",
                "category": "drive#comment",
                "quotedContent": {
                    "mimeType": "text/html",
                    "content": "222222"
                }
            },
             {
                "creator": {
                    "permissionId": "299639512454136576",
                    "displayName": "*******3121@**3.com",
                    "me": true,
                    "category": "drive#user"
                },
                "editedTime": "2020-02-18T07:18:22Z",
                "deleted": false,
                "description": "2020/02/178 11:70",
                "createdTime": "2020-02-18T07:18:22Z",
                "position": "{'revision':'1-0','region':[{'line':{'ln':1,'len':2,'flen':10}}]}",
                "id": "BkvcvwRTGlCS9V1SPh0FPLZbfp02YRpck",
                "htmlDescription": "2020/02/178 11:70",
                "category": "drive#comment",
                "quotedContent": {
                    "mimeType": "text/html",
                    "content": "222222"
                }
            },
            {
                "creator": {
                    "permissionId": "299639512454136576",
                    "displayName": "*******3121@**3.com",
                    "me": true,
                    "category": "drive#user"
                },
                "editedTime": "2020-02-19T13:13:24Z",
                "deleted": false,
                "description": "2020/02/17 11:20",
                "createdTime": "2020-02-19T13:13:24Z",
                "position": "{'revision':'1-0','region':[{'line':{'ln':1,'len':2,'flen':10}}]}",
                "id": "BkytC_85-y5hoiLxCRnNCHZcDynNC_siY",
                "htmlDescription": "2020/02/17 11:20",
                "category": "drive#comment",
                "quotedContent": {
                    "mimeType": "text/html",
                    "content": "222222"
                }
            }
        ],
        "category": "drive#commentList"
    }

删除评论

功能简介

Comments.delete接口实现删除某个评论。

限制

发送一个删除评论的请求

  1. 创建一个对Comments.delete接口的DELETE请求。
  2. 添加查询参数fileId、commentId。

    例如:

    DELETE https://driveapis.cloud.huawei.com.cn/drive/v1/files/{fileId}/comments/{commentId}

  3. 填入HTTP headers。

    • Cache-Control:缓存控制
    • Authorization:填入从华为帐号获取的authorization code

  4. 发送请求。

    请求示例:
    DELETE https://driveapis.cloud.huawei.com.cn/drive/v1/files/AAAB9Wn0DTQCIqPbW9avGjAQo9dbxg04A/comments/BkytC_85-y5hoiLxCRnNCHZcDynNC_siY HTTP/1.1 
    Authorization: Bearer CV3PnPLZXyr9K2GV7RYZkF962JZvoEkMQhTho3QHQAPQUyma/lEyZskP/IMWrc7FvaeHivO7y0lyibI/fQvulBnTgtXArSVPsjaLKvYNkDsJSaIR2/sx+K40bYDWWpKFvJNKg2U47jRwz2mfiF3ortNk 
    Cache-Control: no-cache 

    响应:

    HTTP/1.1 204 OK

修改评论

功能简介

Comments.update接口实现修改某个评论。

限制

发送一个修改评论的请求

  1. 创建一个对Comments.update接口的PATCH请求。
  2. 添加查询参数fileId、commentId和fields。

    例如:

    PATCH https://driveapis.cloud.huawei.com.cn/drive/v1/files/{fileId}/comments/{commentId}?fields=*

  3. 填入HTTP headers。

    • Accept:接收回复的报文格式
    • Content-Type:发送报文格式
    • Cache-Control:缓存控制
    • Authorization:填入从华为帐号获取的authorization code

  4. 发送请求。

    请求示例:
    PATCH https://driveapis.cloud.huawei.com.cn/drive/v1/files/AAAB9Wn0DTQCIqPbW9avGjAQo9dbxg04A/comments/BkytC_85-y5hoiLxCRnNCHZcDynNC_siY?fields=* HTTP/1.1
    Accept: application/json 
    Content-Type: application/json 
    Authorization: Bearer CV3PnPLZXyr9K2GV7RYZkF962JZvoEkMQhTho3QHQAPQUyma/lEyZskP/IMWrc7FvaeHivO7y0lyibI/fQvulBnTgtXArSVPsjaLKvYNkDsJSaIR2/sx+K40bYDWWpKFvJNKg2U47jRwz2mfiF3ortNk 
    Cache-Control: no-cache 
    
    { 
        "description":"2020/02/18 11:20"
    }

    响应:

    HTTP/1.1 200 OK 
    {  
        "creator": {
            "permissionId": "299639512454136576",
            "displayName": "*******3121@**3.com",
            "me": true,
            "category": "drive#user"
        },
        "editedTime": "2020-02-19T13:13:23.635Z",
        "deleted": false,
        "description": "2020/02/18 11:20",
        "createdTime": "2020-02-19T13:13:23.635Z",
        "position": "{'revision':'1-0','region':[{'line':{'ln':1,'len':2,'flen':10}}]}",
        "id": "BkytC_85-y5hoiLxCRnNCHZcDynNC_siY",
        "htmlDescription": "2020/02/17 11:20",
        "category": "drive#comment",
        "quotedContent": {
            "mimeType": "text/html",
            "content": "222222"
        }
    }