cn.felord.reactive.api

Interface DocApi

public interface DocApi

文档-管理文档

Since:

2023 /7/19

Author:

dax

Method Summary

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

Method Detail

createDoc

@POST(value="wedoc/create_doc")
io.reactivex.rxjava3.core.Single<CreateDocResponse> createDoc(@Body
                                                                                              CreateDocRequest request)

新建文档

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

Parameters:

request - the request

Returns:

the create doc response

renameDoc

@POST(value="wedoc/rename_doc")
io.reactivex.rxjava3.core.Single<WeComResponse> renameDoc(@Body
                                                                                          DocId docId)

重命名文档

Parameters:

docId - the doc id

Returns:

the we com response

renameDoc

@POST(value="wedoc/rename_doc")
io.reactivex.rxjava3.core.Single<WeComResponse> renameDoc(@Body
                                                                                          FormId docId)

重命名收集表

Parameters:

docId - the doc id

Returns:

the we com response

delDoc

@POST(value="wedoc/del_doc")
io.reactivex.rxjava3.core.Single<WeComResponse> delDoc(@Body
                                                                                    DocId docId)

删除文档

Parameters:

docId - the doc id

Returns:

the we com response

delDoc

@POST(value="wedoc/del_doc")
io.reactivex.rxjava3.core.Single<WeComResponse> delDoc(@Body
                                                                                    FormId docId)

删除收集表

Parameters:

docId - the doc id

Returns:

the we com response

getDocBaseInfo

@POST(value="wedoc/get_doc_base_info")
io.reactivex.rxjava3.core.Single<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")
io.reactivex.rxjava3.core.Single<GenericResponse<String>> docShare(@Body
                                                                                                  DocId docId)

分享文档

Parameters:

docId - the doc id

Returns:

the we com response

docGetAuth

@POST(value="wedoc/doc_get_auth")
io.reactivex.rxjava3.core.Single<DocAuthResponse> docGetAuth(@Body
                                                                                               DocId docId)

获取文档权限信息

Parameters:

docId - the doc id

Returns:

the doc auth response

modDocJoinRule

@POST(value="wedoc/mod_doc_join_rule")
io.reactivex.rxjava3.core.Single<WeComResponse> modDocJoinRule(@Body
                                                                                                      AccessRuleUpdateRequest request)

修改文档查看规则

Parameters:

request - the request

Returns:

the we com response

modDocMember

@POST(value="wedoc/mod_doc_member")
io.reactivex.rxjava3.core.Single<WeComResponse> modDocMember(@Body
                                                                                                 FileMemberUpdateRequest request)

修改文档通知范围及权限

Parameters:

request - the request

Returns:

the we com response

modDocSaftySetting

@POST(value="wedoc/mod_doc_safty_setting")
io.reactivex.rxjava3.core.Single<WeComResponse> modDocSaftySetting(@Body
                                                                                                              DocSecuritySetting setting)

修改文档安全设置

Parameters:

setting - the setting

Returns:

the we com response