资源预览内容
第1页 / 共29页
第2页 / 共29页
第3页 / 共29页
第4页 / 共29页
第5页 / 共29页
第6页 / 共29页
第7页 / 共29页
第8页 / 共29页
第9页 / 共29页
第10页 / 共29页
亲,该文档总共29页,到这儿已超出免费预览范围,如果喜欢就下载吧!
资源描述
北京搜狐新媒体信息技术有限公司畅言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.11. 完善回复列表,增加消息推送功能2. 增加“我做出的评论” 接口2014/12/242.2.21.增加是否启用消息推送功能的开关2014/12/302.2.31. 修复评论列表重复显示的bug2. 新增api文档的详细说明3. 增加消息推送中的注意事项4. 修复列表中图片下载失败时有toast显示的bug2015/02/082.2.41. 修复图片缓存导致评论列表闪退的bug。目录畅言android平台sdk文档1目录2一、 概述4名词解释4二、运行demo程序4三、快速接入41.导入依赖文件42.添加应用权限53.添加畅言配置54.初始化畅言SDK54.1.configUI类64.2.configLogin类104.3.configCommentSettings类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,用来鉴别身份。登录changyan.sohu.com后,点击设置-高级,查看。cyan_app_key畅言分配给第三方应用的appkey,用来进行数据加密和签名校验。登录changyan.sohu.com后,点击设置-高级,查看。accesstoken表示用户身份的token,用于畅言api的调用。oauth_redirect使用oauth方式登录畅言的回调页面地址,登录changyan.sohu.com后,点击设置-高级,进行修改。二、运行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中添加以下权限配置3.添加畅言配置在AndroidMainfest.xml中添加如下配置项(可参考CySDK 2.1.0下的AndroidManifest.xml)畅言的注册地址:http:/www.kuaizhan.com/passport/?refer 4.初始化畅言SDK Config config = new Config();config.ui.toolbar_bg = Color.WHITE;config.comment.showScore = true;config.comment.uploadFiles = true; config.comment.anonymous_token = z6e0xTejZBmqP-dQcAGN2lWmTZu8_yk9fW_w7oUvJP8;config.login.loginActivityClass = AppLoginActivity.class;CyanSdk.register(cy2uLn0jfoQS, 16bd0e2533092b96e3e55958ef19d08a , http:/10.2.58.251:8081/login-success.html, config);cyanSdk = CyanSdk.getInstance(this.getActivity();黄色高亮部分修改为你自己的appid、appkey、callbackUri,Appidhe和appkey设置方式为: 登录changyan.kuaizhan.com(需要登录),点击设置 - 通用设置 - 高级设置,可以看到Appid和Appkey的值(Appkey不要泄露给其他人)。callbackUri的设置选项在:登录changyan.kuaizhan.com(需要登录),点击设置 - 通用设置 - 高级设置 - 回调地址:如果不需要畅言oauth的OAUTH2.0认证,这里的回调地址可以设置为网站的域名。确认回调地址不留空即可。如果这里没有对回调地址进行设置,会导致“redirect_uri illegal 错误码20108”的Error。绿色高亮代码是自定义评论框的显示风格,需要在config类中进行设置,详细参数说明如下:4.1.configUI类1.颜色设置可设置评论框浮层的背景色、按钮色、文字颜色等,不修改则使用默认值。toolbar_bg :toolbar背景色 toolbar_border :toolbar边框色toolbar_btn: toolbar按钮颜色 before_clk :顶按钮点击之前颜色after_clk:顶按钮点击之后颜色list_title:热门评论、最新评论标题的文字和边框颜色 login_bg:登陆界面背景颜色 login_btn:登陆界面按钮颜色 login_btn_text:登陆界面按钮文字颜色login_input :登陆界面昵称显示框背景颜色 login_input_text: 登陆界面昵称显示框文字颜色 edit_cmt_bg:评论输入框背景颜色以上属性对应评论框外观如下所示:图1 bottomtoolbar颜色参数指示图图2 评论展示界面颜色参数指示图图3 评论界面颜色参数指示图图4 登陆界面颜色参数指示图2.排列风格设置评论显示方式分为盖楼(floor)和缩进(indent)两种方式,通过 style 设置,默认值为”floor”,当选择indent风格时,需设置depth和sub_size的值,depth表示缩进显示的深度,sub_size 表示缩进显示的评论条数。 具体展示形式如下图5 盖楼风格图6 缩进风格(depth = 1,sub_size=20)设置方法:修改config属性: config.ui.indent; config.ui.depth = 1; config.ui.sub_size = 20;4.2.configLogin类 可设置登陆相关选项,不修改则使用默认值。SSOLogin :是否允许单点登录SSO_Assets_Icon:单点登陆图标的名称(需将图片文件放在assets文件夹中),SSOLogin为true时必须设置。loginActivityClass :单点登录的Activity,SSOLogin为true时必须设置。Custom_oauth_login:第三方登录是否自己获得授权,默认设置为false,即授权给畅言。QQ_btn_listerner/ SINA_btn_listerner :(Custom_oauth_login为true时,必须设置。) 用户自己绑定在QQ/SINA登录按钮上的监听事件。 QQ/SINA/SOHU : Custom_oauth_login为false时,选取第三方登录方式。 4.3.configCommentSettings类 可设置评论相关选项,不修改则使用默认值。 showScore:是否允许用户评分 uploadFiles:是否允许上传附件useFace:是否使用表情功能 anonymous_token:匿名登录的access token,为null时,不允许匿名登录,在畅言站长后台http:/changyan.kuaizhan.com/setting/wap(需要登录)- 设置 - wap设置中获取这个token。hotsize:显示的热门评论数latestsize:显示的最新评论数pagesize:加载更多时显示的评论数5.调用SDK接口插入评论框浮层。目前SDK开发的评论框浮层支持嵌入到LinearLayout和RelativeLayout两种布局中,LinearLayout的嵌入需要将布局中的其他view整体包裹在一
网站客服QQ:2055934822
金锄头文库版权所有
经营许可证:蜀ICP备13022795号 | 川公网安备 51140202000112号