8. API 接口分类（红色为几乎必有的接口）
优质
小牛编辑
135浏览
2023-12-01
| 接口 | 描述 | ||||||||
| 初始化 | setLoginResultListener | 设置VPN登录结果监听器 | |||||||
| addAllowedL3VPNApps | 添加可以使用L3VPN的应用列表(称之为白名单应用) | ||||||||
| disableAutoLogin | 设置是否关闭后台自动重连，默认开启，不建议调用此接口 | ||||||||
| setAuthConnectTimeOut | 设置认证连接的超时时间 | ||||||||
| setDeviceLanguage | 设置VPN语言环境 | ||||||||
| setLogLevel | 设置日志打印等级 | ||||||||
| 主认证 | startPasswordAuthLogin | SDK初始化以及进行用户名/密码认证，最常用的认证方式 | |||||||
| startTicketAuthLogin | SDK初始化以及进行免密登录，最常用的登录类型 | ||||||||
| startCertificateAuthLogin | SDK初始化以及进行证书认证 | ||||||||
| startSessionAuthLogin | SDK初始化以及进行共享session认证 | ||||||||
| startDingTalkCodeAuthLogin | 专门用于钉钉的code认证 | ||||||||
| 辅助认证 | doRenewPasswordAuth | 强制修改密码 | |||||||
| doRandCodeAuth | 组合认证：图形校验码认证 | ||||||||
| doCertificateAuth | 组合认证：证书认证 | ||||||||
| doPasswordAuth | 组合认证：用户名密码认证 | ||||||||
| doSMSAuth | 组合认证：短信认证 | ||||||||
| doTokenAuth | 组合认证：动态令牌认证 | ||||||||
| doRadiusAuth | 组合认证：Radius挑战认证 | ||||||||
| 状态监听 | addStatusChangedListener | 添加vpn状态变化监听器，可注册多个监听器 | |||||||
| clearStatusChangedListener | 清除所有vpn状态变化监听器 | ||||||||
| removeStatusChangedListener | 移除vpn状态变化监听器 | ||||||||
| queryStatus | 主动获取当前VPN的登录状态 | ||||||||
| 注销 | vpnLogout | 主动注销VPN，该接口为异步接口，目前没有回调， 需要监听vpn状态才能知道注销情况，后续可以考虑加上 | |||||||
| 异常处理 | onActivityResult | L3vpn模式必须调用该函数，传递vpn用户授权结果 | |||||||
| reacquireRandCode | 重新获取获取图形校验码 | ||||||||
| reacquireSmsCode | 重新获取短信验证码 | ||||||||
| setRandCodeListener | 设置要展示校验码的实体类，用于在vpnRndCodeCallback中进行回调 | ||||||||
| 其他 | changePassword | 主动修改密码 | |||||||
| enableByPassMode | 开启ByPass模式，开启后，所有SDK功能将失效 | ||||||||
| getInstance | 获取VPN认证管理类的实例 | ||||||||
| getSession | 获取共享登录的Session | ||||||||
| getVpnMode | 获取vpn模式 | ||||||||
| ticketAuthAvailable | 判断当前是否允许免密登录 | ||||||||