畅言Android SDK使用文档.docx

畅言android平台sdk文档北京搜狐新媒体信息技术有限公司版本：CySDK V2.2.0修订记录时间文档版本修订人备注2014/01/072.1.0新增评论框浮层，评论列表页，评论发表页和社交平台分享功能；原有api接口格式有变动2014/03/202.1.1增加评分功能，修改sdk初始化方式，防止泄露appsecret2014/04/112.1.2优化单点登录功能流程2014/08/112.2.0优化评论框浮层、评论列表页、评论发表页和登陆页，新增分频道获取评论功能，优化顶踩接口2014/12/162.2.1完善回复列表，增加消息推送功能增加“我做出的评论” 接口2014/12/242.2.21.增加是否启用消息推送功能的开关2014/12/302.2.3修复评论列表重复显示的bug新增api文档的详细说明增加消息推送中的注意事项修复列表中图片下载失败时有toast显示的bug2015/02/082.2.4修复图片缓存导致评论列表闪退的bug。目录畅言android平台sdk文档1目录2一、 概述4名词解释4二、运行demo程序4三、快速接入41.导入依赖文件42.添加应用权限53.添加畅言配置54.初始化畅言SDK54.1.config——UI类64.2.config——Login类104.3.config——CommentSettings类115.调用SDK接口插入评论框浮层。115.1 activity嵌入115.2 fragement嵌入116. SDK中单点登录功能的使用127. SDK中消息推送的使用12四、api调用示例及说明141.畅言数据接口api141.1 不登录可访问的api接口141.2 需要登录的api202.附带UI界面的api接口232.1 评论列表界面232.2 评论发表界面242.3 用户评论中心界面(包括发出的评论和接收到的评论)243. 消息推送25配置见 三.725设置notification的图标25如何自定义 处理接收到消息推送.25如果使用自定义的评论编辑页面25注意事项26附录26关于代码混淆26一、 概述畅言SDK为开发者提供app内评论功能的嵌入，通过使用畅言SDK，开发者可在app内拥有评论功能和分享功能。本文档将对使用SDK时所用的配置、接口进行说明，并提供简单的实例，帮助开发者方便的使用SDK。名词解释cyan_app_id畅言分配给第三方应用的appId，用来鉴别身份。登录后，点击设置->高级，查看。cyan_app_key畅言分配给第三方应用的appkey，用来进行数据加密和签名校验。登录后，点击设置->高级，查看。accesstoken表示用户身份的token，用于畅言api的调用。oauth_redirect使用oauth方式登录畅言的回调页面地址，登录后，点击设置->高级，进行修改。二、运行demo程序1.下载畅言SDK的zip包，解压。2.将CySDK 2.2.0中的cyan_sdk_test项目导入到eclipse中。4.右键点击cyan_sdk_test，run as->android application即可运行。三、快速接入1.导入依赖文件将CySDK 2.2.0中lib文件夹下的所有jar包和CySDK中bin文件夹下的CySDK.jar复制到工程的libs目录下。2.添加应用权限在AndroidMainfest.xml中添加以下权限配置<uses-permission android:name="android.permission.INTERNET" /><uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /><uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />3.添加畅言配置在AndroidMainfest.xml中添加如下配置项（可参考CySDK 2.1.0下的AndroidManifest.xml）<!-- 评论列表界面 --><activity android:name="com.sohu.cyan.android.sdk.activity.CyanCommentActivity"/><!-- 发表评论页面 --><activity android:name="com.sohu.cyan.android.sdk.activity.CyanPostCommentActivity"/><!-- 社会化账号登陆界面--><activity android:name="com.sohu.cyan.android.sdk.activity.OAuth