cn.felord.api

Interface DocApi

public interface DocApi

文档-管理文档

Since:

2023 /7/19

Author:

dax

Method Summary

Modifier and Type	Method and Description
CreateDocResponse	createDoc(CreateDocRequest request) 新建文档
WeComResponse	delDoc(DocId docId) 删除文档
WeComResponse	delDoc(FormId formId) 删除收集表
DocAuthResponse	docGetAuth(DocId docId) 获取文档权限信息
GenericResponse<String>	docShare(DocId docId) 分享文档
GenericResponse<String>	docShare(FormId formId) 分享收集表
GenericResponse<DocBaseInfo>	getDocBaseInfo(DocId docId) Gets doc base info.
WeComResponse	modDocJoinRule(AccessRuleUpdateRequest request) 修改文档查看规则
WeComResponse	modDocMember(FileMemberUpdateRequest request) 修改文档通知范围及权限
WeComResponse	modDocSaftySetting(DocSecuritySetting setting) 修改文档安全设置
WeComResponse	renameDoc(DocId docId) 重命名文档
WeComResponse	renameDoc(FormId docId) 重命名收集表

Method Detail

createDoc

@POST(value="wedoc/create_doc")
CreateDocResponse createDoc(@Body
                                                            CreateDocRequest request)

新建文档

该接口用于新建文档和表格，新建收集表可前往FormApi查看。

Parameters:

request - the request

Returns:

the create doc response

renameDoc

@POST(value="wedoc/rename_doc")
WeComResponse renameDoc(@Body
                                                        DocId docId)

重命名文档

Parameters:

docId - the doc id

Returns:

the we com response

renameDoc

@POST(value="wedoc/rename_doc")
WeComResponse renameDoc(@Body
                                                        FormId docId)

重命名收集表

Parameters:

docId - the doc id

Returns:

the we com response

delDoc

@POST(value="wedoc/del_doc")
WeComResponse delDoc(@Body
                                                  DocId docId)

删除文档

Parameters:

docId - the doc id

Returns:

the we com response

delDoc

@POST(value="wedoc/del_doc")
WeComResponse delDoc(@Body
                                                  FormId formId)

删除收集表

Parameters:

formId - the form id

Returns:

the we com response

getDocBaseInfo

@POST(value="wedoc/get_doc_base_info")
GenericResponse<DocBaseInfo> getDocBaseInfo(@Body
                                                                                   DocId docId)

Gets doc base info.

Parameters:

docId - the doc id

Returns:

the doc base info

docShare

@POST(value="wedoc/doc_share")
GenericResponse<String> docShare(@Body
                                                                DocId docId)

分享文档

Parameters:

docId - the doc id

Returns:

the we com response

docShare

@POST(value="wedoc/doc_share")
GenericResponse<String> docShare(@Body
                                                                FormId formId)

分享收集表

Parameters:

formId - the form id

Returns:

the we com response

docGetAuth

@POST(value="wedoc/doc_get_auth")
DocAuthResponse docGetAuth(@Body
                                                             DocId docId)

获取文档权限信息

Parameters:

docId - the doc id

Returns:

the doc auth response

modDocJoinRule

@POST(value="wedoc/mod_doc_join_rule")
WeComResponse modDocJoinRule(@Body
                                                                    AccessRuleUpdateRequest request)

修改文档查看规则

Parameters:

request - the request

Returns:

the we com response

modDocMember

@POST(value="wedoc/mod_doc_member")
WeComResponse modDocMember(@Body
                                                               FileMemberUpdateRequest request)

修改文档通知范围及权限

Parameters:

request - the request

Returns:

the we com response

modDocSaftySetting

@POST(value="wedoc/mod_doc_safty_setting")
WeComResponse modDocSaftySetting(@Body
                                                                            DocSecuritySetting setting)

修改文档安全设置

Parameters:

setting - the setting

Returns:

the we com response