个信Android平台SDK文档.doc

个信互动（北京）网络科技有限公司 普通个信Android平台SDK文档（JAR模式）个信Android平台SDK接口文档-JAR模式个信互动（北京）网络科技有限公司编号: GEXIN_ANDROID_SDK_JAR版本: GEXIN_ANDROID_SDK_JAR V1.1.1修订记录时间文档版本修订人备注2011/6/61.0.0董霖初稿2011/11/301.1.0董霖基于新版SDK架构接口2011/12/031.1.1全博伟增加权限设置和推送图标设置2011/12/231.1.2董霖增加流量统计接口2012/1/181.1.3全博伟增加自定义tag接口目录概述3名词解释3SDK详细介绍3SDK包含内容3SDK Tutorial3SDK接口Reference3GexinSdk3GexinSdkObserver3其他注意事项3附录3附录一3概述个信Android平台SDK为第三方应用提供了稳定易用的推送通知服务，使得第三方客户端无需定时查询服务器，即可实现将服务端数据即时发送至第三方客户端。对于Relay方式的消息，请参阅个信Android平台SlaveSDK文档名词解释GPN: Gexin Push Notification个信推送服务SDK详细介绍关于个信推送服务整体框架和SDK交互流程的说明，请参见个信推送服务说明文档SDK包含内容个信Android平台SDK（JAR模式）提供个信服务层jar包（文件名为GexinSdk.jar）、测试客户端项目工程SDK_Demo_Master以及SDK文档。SDK Tutorial1. 将GexinSdk.jar添加到工程中，并在AndroidManifest.xml里添加SDK所需的服务声明和权限声明：Application:标签内加入Application:标签外加入 2. 当应用运行在后台时SDK能调用应用弹出广告，需在主Activity标签中加入android:launchMode=singleTop。3. 设置推送消息在Notification栏显示的图标：把图片命名为push.png, 放入工程res/ drawable目录中。SDK默认读取该push.png，如果不存在，则使用系统默认图标。4. 实现GexinSdkObserver相关接口5. 在应用程序启动初始化阶段，调用GexinSdk.initialize()进行SDK初始化6. 通过GexinSdkObserver.onRegistered()获取SDK注册到的ClientID信息，保存到第三方服务器7. 服务器推送下来的消息，通过GexinSdkObserver.onPayloadReceived()接口获得通知，取得payloadID，然后使用GexinSdk.getPayload()获取具体的消息内容SDK接口ReferenceGexinSdkSDK功能接口，以类方法形式提供给第三方应用程序调用。每个应用程序只能初始化一次SDK，使用一个推送通道。ensureInstall描述确认SDK服务层已经正确安装。如果SDK服务层未安装，会启动APK安装过程。原型public static void ensureInstall()返回值无有效性仅对APK模式有效，JAR模式忽略该接口initialize描述SDK初始化，完成注册和登录过程，同时进行应用绑定。原型public static void initialize(Context context, GexinSdkObserver observer,String appID)参数context：第三方Android应用程序Context主对象observer：第三方实现的观察器对象appID：为每个应用分配的唯一标识串返回值无有效性From 1.0getPayload描述获取push消息数据，也即Payload原型public static byte getPayload(String payloadID)参数context：消息标识，通过GexinSdkObserver.onPayloadReceived获取返回值Payload数据，以byte数组形式返回有效性From 1.0bindService描述进行应用绑定原型public static void bindService(String appID)参数appID：为每个应用分配的唯一标识串返回值无有效性From 1.0unbindService描述取消应用绑定原型public static void unbindService(String appID)参数appID：为每个应用分配的唯一标识串返回值无有效性From 1.0getNetstat描述获取网络信息原型public static void getNetstat(GexinSdkNetstat &stat)参数stat：网络信息，包括网络流量等。参见GexinSdkNetstat返回值无有效性From 1.0addTag描述添加/设置Tag原型public static final void addTag(Tag tag)参数tag：标签结构等。参见Tag返回值无有效性From 1.0removeTag描述删除Tag原型public static final void removeTag (Tag tag)参数tag：标签结构等。参见Tag返回值无有效性From 1.0GexinSdkObserver获取SDK事件通知，获取相应的状态和数据。由第三方应用程序实现该接口，并在SDK初始化时传入相应的实例对象。onRegistered描述SDK注册成功通知原型public void onRegistered(String clientID)参数clientID：SDK用户标识信息，获取后建议保存到服务端返回值无有效性From 1.0onPayloadReceived描述推送消息通知原型public void onPayloadReceived(String payloadID)参数payloadID：消息ID，后续通过GexinSdk.getPayload()获取完整的Payload数据返回值无有效性From 1.0onBindService描述应用绑定结果通知原型public void onBindService(String appID,String result)参数appID：第三方应用IDresult：绑定结果。succeed成功 failed失败返回值无有效性暂不支持onUnbindService描述应用解绑结果通知原型public void onUnbindService(String appID,String result)参数appID：第三方应用IDresult：解绑结果。succeed成功 failed失败返回值无有效性暂不支持GexinSdkNetstat从getNetstat获取的网络信息结构。包括流量信息，网络状态等。long inboundBytes从SDK启动开始，从网络接收到的总字节数（包括WIFI和移动网络）long outboundBytes从SDK启动开始，向网络发送的总字节数（包括WIFI和移动网络）Tag自定义标签结构。public void setName(String name)自定义标签名，只允许中文、英文、数字、和+-*_.public void setTypeInt()自定义标签value类型为Int型。public void setTypeString()自定义标签value类型为String型。public void setTypeFloat()自定义标签value类型为float型。public void setTypeDate()自定义标签value类型为date型。public void setValueInt(int value)设置type类型为Int型，标签的value值。public void setValueString(String value)设置type类型为String型，标签的value值