WxJava/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/WxOpenMaPrivacyService.java at 7e6b23042e3d74404fedfb1c21417dd25d3a1543 · hywr/WxJava · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
package me.chanjar.weixin.open.api;

import me.chanjar.weixin.common.error.WxErrorException;
import me.chanjar.weixin.open.bean.ma.privacy.GetPrivacySettingResult;
import me.chanjar.weixin.open.bean.ma.privacy.SetPrivacySetting;
import me.chanjar.weixin.open.bean.ma.privacy.UploadPrivacyFileResult;
import org.jetbrains.annotations.Nullable;

/**
 * 微信第三方平台 小程序用户隐私保护指引接口
 * https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/privacy_config/set_privacy_setting.html
 *
 * @author <a href="https://www.sacoc.cn">广州跨界</a>
 */
public interface WxOpenMaPrivacyService {

  /**
   * 1 设置小程序用户隐私保护指引
   */
  String OPEN_SET_PRIVACY_SETTING = "https://api.weixin.qq.com/cgi-bin/component/setprivacysetting";

  /**
   * 2 查询小程序用户隐私保护指引
   */
  String OPEN_GET_PRIVACY_SETTING = "https://api.weixin.qq.com/cgi-bin/component/getprivacysetting";

  /**
   * 3 上传小程序用户隐私保护指引文件
   */
  String OPEN_UPLOAD_PRIVACY_FILE = "https://api.weixin.qq.com/cgi-bin/component/uploadprivacyextfile";


  /**
   * 查询小程序用户隐私保护指引
   * 文档地址:https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/privacy_config/get_privacy_setting.html
   *
   * @param privacyVer 1表示现网版本，即，传1则该接口返回的内容是现网版本的；2表示开发版，即，传2则该接口返回的内容是开发版本的。默认是2。
   * @return 查询结果
   * @throws WxErrorException 如果出错,抛出此异常
   */
  GetPrivacySettingResult getPrivacySetting(@Nullable Integer privacyVer) throws WxErrorException;


  /**
   * 设置小程序用户隐私保护指引
   * 文档地址:https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/privacy_config/set_privacy_setting.html
   *
   * @param dto 参数对象
   * @throws WxErrorException 如果出错,抛出此异常
   */
  void setPrivacySetting(SetPrivacySetting dto) throws WxErrorException;


  /**
   * 上传小程序用户隐私保护指引文件
   * 本接口用于上传自定义的小程序的用户隐私保护指引
   * 仅限文本文件, 限制文件大小为不超过100kb，否则会报错
   * 文档地址:https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/privacy_config/upload_privacy_exfile.html
   *
   * @param content 文本文件内容
   * @return 上传结果
   * @throws WxErrorException 如果出错,抛出此异常
   */
  UploadPrivacyFileResult uploadPrivacyFile(String content) throws WxErrorException;
}