# 前言说明
apk版本信息需要到[比邻云官网](https://www.bilnn.com)去上传，此处只是android sdk的使用说明
# 引用jitpack
在项目的gradle添加maven地址
```
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
在 app的gradle启用 Jetpack DataBinding
```
android {
...
buildFeatures{
dataBinding = true
}
}
```
引用sdk
```
dependencies {
...
implementation 'com.gitee.bilnn:updatex:1.1.1'
}
```
### **注意：必须在app当中启用 DataBinding**
# 配置 APPID 和 Secret
## 方式一
在 AndroidManifest.xml 中配置
```
<application />
<meta-data android:value="[APPID]#[Secret]" android:name="BILN_UPDATEX"/>
</application>
```
## 方式二
初始化的时候配置
```
UpdateX.initialize(context,"[APPID]","[Secret]");
```
从官网获取APPID和Secret并替换。注意，方式一中的“#”不能删除
注意：方式二优先级高于方式一
# 初始化SDK（建议在Application中调用）
```
UpdateX.initialize(context);
UpdateX.initialize(context,"[APPID]","[Secret]");
二选一
```
# 检查更新
## sdk内部集成所有更新app需要的过程，您只需要调用下面这行代码就能完整整体更新流程
```
这里的activity需要是 AppCompatActivity 类型或者继承自 AppCompatActivity
UpdateX.check(activity);
```
## 当然如果您想要自己实现UI显示部分sdk也是支持的，您可以这么做
~~~
UpdateX.versionInfo(new Callback() {
@Override
public void success(VersionInfo versionInfo) {
//在这里可以获取到更新信息以及下载好的apk路径
versionInfo.getVersion(); //版本号
versionInfo.getContent(); //更新内容
versionInfo.getCtime(); //更新时间
versionInfo.getTypes(); //更新方式 1 为推荐更新，2 为强制更新。这里如果拿到值不为1，建议把dialog设置为不可关闭
versionInfo.getApk(); //下载完成的apk完整路径
}
@Override
public void progress(int progress) {
//下载进度百分比
}
@Override
public void fail(String error) {
//下载错误
}
});
~~~
## sdk还支持静默安装，调用方式也很简单，只需要下面这行代码就可以，但此功能需要需要设备root之后才可使用，请慎用
~~~
UpdateX.install();
~~~
