PHXH
/
TapBootstrap-Unity
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat(README): update doc

xiaoyi 2021-05-07 16:57:54 +08:00
parent f4ce8d51e5
commit c5fadb0eb7
3 changed files with 63 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -23,7 +23,7 @@
.ClientID("client_id")
.ClientSecret("client_secret")
.RegionType(RegionType.CN)
.TapDBConfig("channel", "gameVersion")
.TapDBConfig(true,"channel", "gameVersion")
.Builder();
TapBootstrap.Init(config);
```

46
Documentation/README.md
View File

@ -13,67 +13,87 @@ using TapTap.Bootstrap;
## 接口描述
### 初始化
### 1.初始化
> TapBootstrap 会根据 TapConfig 中的 TapDBConfig 配置来进行 TapDB 的自动初始化。
开启 TapDB
```c#
var config = new TapConfig.TapConfigBuilder()
.ClientID("client_id")
.ClientSecret("client_secret")
.RegionType(RegionType.CN)
.TapDBConfig("channel", "gameVersion")
.TapDBConfig(true,"channel", "gameVersion")
.Builder();
```
关闭 TapDB
```c#
var config = new TapConfig.TapConfigBuilder()
.ClientID("client_id")
.ClientSecret("client_secret")
.RegionType(RegionType.CN)
//# .TapDBConfig(false,null,null)
.EnableTapDB(false)
.Builder();
```
初始化 TapSDK
```c#
TapBootstrap.Init(config);
```
### 登陆
### 2.登陆
```c#
TapBootstrap.Login(LoginType loginType, string[] permissions);
```
### 设置语言
### 3.设置语言
```c#
TapBootstrap.SetPreferLanguage(TapLanguage tapLanguage);
```
### 绑定TapTap账号
### 4.绑定TapTap账号（已废弃）
```c#
TapBootstrap.Bind(LoginType loginType, string[] permissions);
```
### 注册用户状态回调
### 5.注册用户状态回调
```c#
TapBootstrap.RegisterUserStatusChangedListener(ITapUserStatusChangedListener listener);
```
### 注册登陆回调
### 6.注册登陆回调
```c#
TapBootstrap.RegisterLoginResultListener(ITapLoginResultListener listener);
```
### 获取用户信息
### 7.获取用户信息
```c#
TapBootstrap.GetUser(Action<TapUser,TapError> action);
```
### 获取详细用户信息
### 8.获取详细用户信息
```c#
TapBootstrap.GetDetailUser(Action<TapUserDetail, TapError> action);
```
### 获取AccessToken
### 9.篝火测试资格
```c#
TapBootstrap.GetTestQualification(Action<bool,TapError> action);
```
### 10.获取AccessToken
```c#
TapBootstrap.GetDetailUser(Action<TapUserDetail, TapError> action);
```
### 登出
### 11.登出
```c#
TapBootstrap.Logout();
```
### 打开用户中心
### 12.打开用户中心
```c#
TapBootstrap.OpenUserCenter();
```

43
README.md
View File

@ -13,72 +13,87 @@ using TapTap.Bootstrap;
## 接口描述
### 初始化
### 1.初始化
> TapBootstrap 会根据 TapConfig 中的 TapDBConfig 配置来进行 TapDB 的自动初始化。
开启 TapDB
```c#
var config = new TapConfig.TapConfigBuilder()
.ClientID("client_id")
.ClientSecret("client_secret")
.RegionType(RegionType.CN)
.TapDBConfig("channel", "gameVersion")
.TapDBConfig(true,"channel", "gameVersion")
.Builder();
```
关闭 TapDB
```c#
var config = new TapConfig.TapConfigBuilder()
.ClientID("client_id")
.ClientSecret("client_secret")
.RegionType(RegionType.CN)
//# .TapDBConfig(false,null,null)
.EnableTapDB(false)
.Builder();
```
初始化 TapSDK
```c#
TapBootstrap.Init(config);
```
### 登陆
### 2.登陆
```c#
TapBootstrap.Login(LoginType loginType, string[] permissions);
```
### 设置语言
### 3.设置语言
```c#
TapBootstrap.SetPreferLanguage(TapLanguage tapLanguage);
```
### 绑定TapTap账号
### 4.绑定TapTap账号（已废弃）
```c#
TapBootstrap.Bind(LoginType loginType, string[] permissions);
```
### 注册用户状态回调
### 5.注册用户状态回调
```c#
TapBootstrap.RegisterUserStatusChangedListener(ITapUserStatusChangedListener listener);
```
### 注册登陆回调
### 6.注册登陆回调
```c#
TapBootstrap.RegisterLoginResultListener(ITapLoginResultListener listener);
```
### 获取用户信息
### 7.获取用户信息
```c#
TapBootstrap.GetUser(Action<TapUser,TapError> action);
```
### 获取详细用户信息
### 8.获取详细用户信息
```c#
TapBootstrap.GetDetailUser(Action<TapUserDetail, TapError> action);
```
### 篝火测试资格
### 9.篝火测试资格
```c#
TapBootstrap.GetTestQualification(Action<bool,TapError> action);
```
### 获取AccessToken
### 10.获取AccessToken
```c#
TapBootstrap.GetDetailUser(Action<TapUserDetail, TapError> action);
```
### 登出
### 11.登出
```c#
TapBootstrap.Logout();
```
### 打开用户中心
### 12.打开用户中心
```c#
TapBootstrap.OpenUserCenter();
```