ShiWangMeSDK Android版接口文档 0.2.0 版
android 总共有 14 个接口，分别涉及到初始化和对界面的一些细节的控制。下面详细介绍接口，如果没有特殊说明，接口都在 ShiWangMeSDK 这个类下(需总览该类可见附录)。
1.初始化
1.1 初始化方法 init
说明：
该函数是SDK的核心函数，使用
SDK任何方法之前必须先调用该函数，如果没有调用该方法，SDK没有被正确的初始化。
函数签名如下：
public static void init(Application app, String apiKey);
参数类型：
app为的类型为当前应用的Application，必填选项;apiKey为到ShiWangMe申请用key，必填选项;
返回值：
- 无
注意事项：
- 该方法应该在应用启动时就调用，一般放在
Application初始化函数中。 - 该方法已经做了异步处理，不用担心会影响
App启动时间，可以放心的在主线程中执行。
1.2 进入主界面 go
说明：
该方法是进入
SDK主界面的唯一正确的方法。
函数签名如下：
public static void go(Activity activity);
参数类型：
activity为android中的Activity类
返回值：
- 无
注意事项：
- 进入
SDK界面的唯一方法
2.返回按钮 leftButton
2.1 可见性 setLeftButtonVisibility
说明：
设置左上角导航的可见性
函数签名：
public static void setLeftButtonVisibility(boolean visibility)
参数类型：
visibility的型形为boolean。当设置为true时，可见，false不可见。默认值为true。
返回值：
- 无
注意事项：
- 无
2.2 图标样式 setleftButtonImage
说明：
设置左上角导航的图标样式
函数签名：
public static void setleftButtonImage(int resId)
参数类型：
redId的取值为int类型。为android resourceId。默认值为-1, 使用SDK的默认图标。
返回值：
- 无
注意事项：
- 无
2.3 点击事件 setOnLeftButtonClickListener
说明：
设置左上角导航的点标事件
函数签名：
public static void setOnLeftButtonClickListener(OnArViewClickListener listener)
参数类型：
listener的类型为OnArViewClickListener(请参考附录)。默认行为是SDK的默认行为，返回上一个Activity。
返回值：
- 无
注意事项：
- 无
3.帮助按钮 rightButton
3.1 可见性 setRightButtonVisibility
说明：
设置右上角帮助按钮的可见性
函数签名：
public static void setRightButtonVisibility(boolean visibility)
参数类型：
visibility的型形为boolean。当设置为true时，可见，false不可见。默认值为true。
返回值：
- 无
注意事项：
- 无
3.2 图标样式 setRightButtonImage
说明：
设置右上角帮助的图标样式
函数签名：
public static void setRightButtonImage(int resId)
参数类型：
- redId 的取值为 int 类型。为 android resourceId。默认值为 -1, 使用SDK的默认图标。
返回值：
- 无
3.3 点击事件 setOnRightButtonClickListener
说明：
设置右上角帮助的点标事件
函数签名：
public static void setOnRightButtonClickListener(OnArViewClickListener listener)
参数类型：
- listener 的类型为 OnArViewClickListener (请参考附录)。默认行为是 SDK的默认行为，打开 ShiWangMe 官网。
返回值：
- 无
注意事项：
- 无
4.选择栏 midButton
4.1 可见性 setMidButtonVisibility
说明：
设置选择主题按钮的可见性
函数签名：
public static void setMidButtonVisibility(boolean visibility)
参数类型：
visibility的型形为boolean。当设置为true时，可见，false不可见。默认值为true。
返回值：
- 无
注意事项：
- 无
4.2 文本内容 setMidButtonText
说明：
设置选择主题按钮的文本内容
函数签名：
public static void setMidButtonText(String text)
参数类型：
text的取值类型为String。默认值为：请使用对应日期报纸
返回值：
- 无
注意事项：
- 无
4.3 点击事件 setOnMidButtonClickListener
说明：
设置选择主题按钮的点击事件
函数签名：
public static void setOnMidButtonClickListener(OnArViewClickListener listener)
参数类型：
listener的类型为OnArViewClickListener(请参考附录)。默认行为:打开 主题列表的 Activity。
返回值：
- 无
注意事项：
- 无
5.选择列表 theme
5.1 标题内容 setThemeText
说明：
设置主题列表
toolbar的文本内容
函数签名：
public static void setThemeText(String text)
参数类型：
text的取值类型为String。默认值为：往期报纸列表
返回值：
- 无
注意事项：
- 无
6 特殊事件
6.1 二维码 setOnArQrCodeResultListener
说明：
该回调会在扫描之后的结果之后，再调用
SDK内部功能之前调用
函数签名：
public static void setOnArQrCodeResultListener(OnArQrCodeScanListener listener)
参数类型：
listener的类型为OnArQrCodeScanListener(请参考附录)。当前传入的是扫描后的结果，默认实现:返回原值。
返回值：
- 无
注意事项：
- 无
6.2 AR扫描之打开的链接 setOnArRenderLinkOpenListener
说明：
该回调会在
SDK内置浏览器，将要打开链接的时候调用。
函数签名：
public static void setOnArRenderLinkOpenListener(OnArRenderLinkOpenListener listener)
参数类型：
listener的类型为OnArRenderLinkOpenListener(请参考附录)。当前传入的是需要打开的url值， 默认实现是返回原值。
返回值：
- 无
注意事项：
- 无
附录
OnArViewClickListener
/**
* Created by ShiWangMe on 2017/2/13.
* 如果消费了该点击事件，返回true, 否则返回 false
*/
public interface OnArViewClickListener {
boolean onClick(View view);
}
OnArQrCodeScanListener
/**
* Created by ShiWangMe on 2017/2/13.
* 参数为：result 为 QrCode 扫描后的结果
* 返回值为： 修改后的值，可以保持原值
*/
public interface OnArQrCodeScanListener {
String onScan(String result);
}
OnArRenderLinkOpenListener
/**
* Created by ShiWangMe on 2017/2/13.
* 参数为：result 为 将要打开的 url
* 返回值为： 修改后的 url 值，可以保持原值
*/
public interface OnArRenderLinkOpenListener {
String onOpen(String result);
}
ShiWangMeSDK
public class ShiWangMeSDK {
public static void init(Application app, String apiKey);
public static void go(Activity activity);
public static void setOnArQrCodeResultListener(OnArQrCodeScanListener listener);
public static void setOnArRenderLinkOpenListener(OnArRenderLinkOpenListener listener);
public static void setLeftButtonVisibility(boolean visibility);
public static void setleftButtonImage(int resId);
public static void setOnLeftButtonClickListener(OnArViewClickListener listener);
public static void setRightButtonVisibility(boolean visibility);
public static void setRightButtonImage(int resId);
public static void setOnRightButtonClickListener(OnArViewClickListener listener);
public static void setMidButtonVisibility(boolean visibility);
public static void setMidButtonText(String text);
public static void setOnMidButtonClickListener(OnArViewClickListener listener);
public static void setThemeText(String text);
}