暢言AndroidSDK使用文檔

1、.北京搜狐新媒體信息技術(shù)有限公司;暢言android平臺sdk文檔北京搜狐新媒體信息技術(shù)有限公司版本：CySDK V2.2.0修訂記錄時間文檔版本修訂人備注2014/01/072.1.0新增評論框浮層，評論列表頁，評論發(fā)表頁和社交平臺分享功能；原有api接口格式有變動2014/03/202.1.1增加評分功能，修改sdk初始化方式，防止泄露appsecret2014/04/112.1.2優(yōu)化單點登錄功能流程2014/08/112.2.0優(yōu)化評論框浮層、評論列表頁、評論發(fā)表頁和登陸頁，新增分頻道獲取評論功能，優(yōu)化頂踩接口2014/12/162.2.1完善回復(fù)列表，增加消息推送功能增加“我做出的評

2、論” 接口2014/12/242.2.21.增加是否啟用消息推送功能的開關(guān)2014/12/302.2.3修復(fù)評論列表重復(fù)顯示的bug新增api文檔的詳細說明增加消息推送中的注意事項修復(fù)列表中圖片下載失敗時有toast顯示的bug2015/02/082.2.4修復(fù)圖片緩存導(dǎo)致評論列表閃退的bug。目錄 TOC o 1-3 h z u HYPERLINK l _Toc13024 暢言android平臺sdk文檔 PAGEREF _Toc13024 1 HYPERLINK l _Toc10942 目錄 PAGEREF _Toc10942 2 HYPERLINK l _Toc160 一、 概述 PAG

3、EREF _Toc160 4 HYPERLINK l _Toc16631 名詞解釋 PAGEREF _Toc16631 4 HYPERLINK l _Toc2731 二、運行demo程序 PAGEREF _Toc2731 4 HYPERLINK l _Toc23375 三、快速接入 PAGEREF _Toc23375 4 HYPERLINK l _Toc13908 1.導(dǎo)入依賴文件 PAGEREF _Toc13908 4 HYPERLINK l _Toc31716 2.添加應(yīng)用權(quán)限 PAGEREF _Toc31716 5 HYPERLINK l _Toc12042 3.添加暢言配置 PAGER

4、EF _Toc12042 5 HYPERLINK l _Toc13062 4.初始化暢言SDK PAGEREF _Toc13062 5 HYPERLINK l _Toc5108 4.1.configUI類 PAGEREF _Toc5108 6 HYPERLINK l _Toc6901 4.2.configLogin類 PAGEREF _Toc6901 10 HYPERLINK l _Toc30527 4.3.configCommentSettings類 PAGEREF _Toc30527 11 HYPERLINK l _Toc623 5.調(diào)用SDK接口插入評論框浮層。 PAGEREF _Toc

5、623 11 HYPERLINK l _Toc25836 5.1 activity嵌入 PAGEREF _Toc25836 11 HYPERLINK l _Toc17593 5.2 fragement嵌入 PAGEREF _Toc17593 11 HYPERLINK l _Toc5427 6. SDK中單點登錄功能的使用 PAGEREF _Toc5427 12 HYPERLINK l _Toc790 7. SDK中消息推送的使用 PAGEREF _Toc790 12 HYPERLINK l _Toc20133 四、api調(diào)用示例及說明 PAGEREF _Toc20133 14 HYPERLIN

6、K l _Toc21189 1.暢言數(shù)據(jù)接口api PAGEREF _Toc21189 14 HYPERLINK l _Toc24243 1.1 不登錄可訪問的api接口 PAGEREF _Toc24243 14 HYPERLINK l _Toc19439 1.2 需要登錄的api PAGEREF _Toc19439 20 HYPERLINK l _Toc853 2.附帶UI界面的api接口 PAGEREF _Toc853 23 HYPERLINK l _Toc2368 2.1 評論列表界面 PAGEREF _Toc2368 23 HYPERLINK l _Toc14040 2.2 評論發(fā)表界

7、面 PAGEREF _Toc14040 24 HYPERLINK l _Toc25845 2.3 用戶評論中心界面(包括發(fā)出的評論和接收到的評論) PAGEREF _Toc25845 24 HYPERLINK l _Toc5915 3. 消息推送 PAGEREF _Toc5915 25 HYPERLINK l _Toc26533 配置見 三.7 PAGEREF _Toc26533 25 HYPERLINK l _Toc11207 設(shè)置notification的圖標 PAGEREF _Toc11207 25 HYPERLINK l _Toc15890 如何自定義 處理接收到消息推送. PAGER

8、EF _Toc15890 25 HYPERLINK l _Toc11083 如果使用自定義的評論編輯頁面 PAGEREF _Toc11083 25 HYPERLINK l _Toc30404 注意事項 PAGEREF _Toc30404 26 HYPERLINK l _Toc7323 附錄 PAGEREF _Toc7323 26 HYPERLINK l _Toc3391 關(guān)于代碼混淆 PAGEREF _Toc3391 26一、 概述暢言SDK為開發(fā)者提供app內(nèi)評論功能的嵌入，通過使用暢言SDK，開發(fā)者可在app內(nèi)擁有評論功能和分享功能。本文檔將對使用SDK時所用的配置、接口進行說明，并提供簡

9、單的實例，幫助開發(fā)者方便的使用SDK。名詞解釋cyan_app_id暢言分配給第三方應(yīng)用的appId，用來鑒別身份。登錄后，點擊設(shè)置-高級，查看。cyan_app_key暢言分配給第三方應(yīng)用的appkey，用來進行數(shù)據(jù)加密和簽名校驗。登錄后，點擊設(shè)置-高級，查看。accesstoken表示用戶身份的token，用于暢言api的調(diào)用。oauth_redirect使用oauth方式登錄暢言的回調(diào)頁面地址，登錄后，點擊設(shè)置-高級，進行修改。二、運行demo程序1.下載暢言SDK的zip包，解壓。2.將CySDK 2.2.0中的cyan_sdk_test項目導(dǎo)入到eclipse中。4.右鍵點擊cyan

10、_sdk_test，run as-android application即可運行。三、快速接入1.導(dǎo)入依賴文件將CySDK 2.2.0中l(wèi)ib文件夾下的所有jar包和CySDK中bin文件夾下的CySDK.jar復(fù)制到工程的libs目錄下。2.添加應(yīng)用權(quán)限在AndroidMainfest.xml中添加以下權(quán)限配置3.添加暢言配置在AndroidMainfest.xml中添加如下配置項（可參考CySDK 2.1.0下的AndroidManifest.xml）暢言的注冊地址： HYPERLINK http:/ http:/ 4.初始化暢言SDK Config config = new Config

11、();config.ui.toolbar_bg = Color.WHITE;ment.showScore = true;ment.uploadFiles = true; ment.anonymous_token = z6e0 xTejZBmqP-dQcAGN2lWmTZu8_yk9fW_w7oUvJP8;config.login.loginActivityClass = AppLoginActivity.class;CyanSdk.register(cy2uLn0jfoQS, 16bd0e2533092b96e3e55958ef19d08a , http:/51:8081/login-succ

12、ess.html, config);cyanSdk = CyanSdk.getInstance(this.getActivity();黃色高亮部分修改為你自己的appid、appkey、callbackUri，Appidhe和appkey設(shè)置方式為: 登錄 HYPERLINK http:/ （需要登錄），點擊設(shè)置 - 通用設(shè)置 - 高級設(shè)置，可以看到Appid和Appkey的值（Appkey不要泄露給其他人）。callbackUri的設(shè)置選項在：登錄 HYPERLINK http:/ （需要登錄），點擊設(shè)置 - 通用設(shè)置 - 高級設(shè)置 - 回調(diào)地址：如果不需要暢言oauth的OAUTH2.0認

13、證，這里的回調(diào)地址可以設(shè)置為網(wǎng)站的域名。確認回調(diào)地址不留空即可。如果這里沒有對回調(diào)地址進行設(shè)置，會導(dǎo)致“redirect_uri illegal 錯誤碼20108”的Error。綠色高亮代碼是自定義評論框的顯示風格，需要在config類中進行設(shè)置，詳細參數(shù)說明如下：4.1.configUI類1.顏色設(shè)置可設(shè)置評論框浮層的背景色、按鈕色、文字顏色等，不修改則使用默認值。toolbar_bg ：toolbar背景色 toolbar_border ：toolbar邊框色toolbar_btn： toolbar按鈕顏色 before_clk ：頂按鈕點擊之前顏色after_clk：頂按鈕點擊之后顏色l

14、ist_title：熱門評論、最新評論標題的文字和邊框顏色 login_bg：登陸界面背景顏色 login_btn：登陸界面按鈕顏色 login_btn_text：登陸界面按鈕文字顏色login_input ：登陸界面昵稱顯示框背景顏色 login_input_text： 登陸界面昵稱顯示框文字顏色 edit_cmt_bg：評論輸入框背景顏色以上屬性對應(yīng)評論框外觀如下所示：圖1 bottomtoolbar顏色參數(shù)指示圖圖2 評論展示界面顏色參數(shù)指示圖圖3 評論界面顏色參數(shù)指示圖圖4 登陸界面顏色參數(shù)指示圖2.排列風格設(shè)置評論顯示方式分為蓋樓（floor）和縮進（indent）兩種方式，通過 s

15、tyle 設(shè)置，默認值為”floor”，當選擇indent風格時，需設(shè)置depth和sub_size的值，depth表示縮進顯示的深度，sub_size 表示縮進顯示的評論條數(shù)。 具體展示形式如下圖5 蓋樓風格圖6 縮進風格(depth = 1，sub_size=20)設(shè)置方法：修改config屬性： config.ui.style=indent; config.ui.depth = 1; config.ui.sub_size = 20;4.2.configLogin類 可設(shè)置登陸相關(guān)選項，不修改則使用默認值。SSOLogin ：是否允許單點登錄SSO_Assets_Icon：單點登陸圖標的名

16、稱(需將圖片文件放在assets文件夾中)，SSOLogin為true時必須設(shè)置。loginActivityClass ：單點登錄的Activity，SSOLogin為true時必須設(shè)置。Custom_oauth_login：第三方登錄是否自己獲得授權(quán)，默認設(shè)置為false，即授權(quán)給暢言。QQ_btn_listerner/ SINA_btn_listerner ：(Custom_oauth_login為true時，必須設(shè)置。) 用戶自己綁定在QQ/SINA登錄按鈕上的監(jiān)聽事件。 QQ/SINA/SOHU : Custom_oauth_login為false時，選取第三方登錄方式。 4.3.co

17、nfigCommentSettings類 可設(shè)置評論相關(guān)選項，不修改則使用默認值。 showScore：是否允許用戶評分 uploadFiles：是否允許上傳附件useFace：是否使用表情功能 anonymous_token：匿名登錄的access token，為null時，不允許匿名登錄，在暢言站長后臺 HYPERLINK http:/ http:/ 設(shè)置 - wap設(shè)置中獲取這個token。hotsize：顯示的熱門評論數(shù)latestsize：顯示的最新評論數(shù)pagesize：加載更多時顯示的評論數(shù)5.調(diào)用SDK接口插入評論框浮層。目前SDK開發(fā)的評論框浮層支持嵌入到LinearLayo

18、ut和RelativeLayout兩種布局中，LinearLayout的嵌入需要將布局中的其他view整體包裹在一個布局中，并設(shè)置layout_weight屬性為1，layout_height為0。請參照cyan_sdk_test項目下的res/toolbar_demo.xml，是如何實現(xiàn)在LinearLayout中實現(xiàn)評論框浮層的嵌入的。RelativeLayout的嵌入不需要做特殊處理。5.1 activity嵌入如果在activity中直接嵌入評論框浮層，那么可以在onCreate()中直接調(diào)用CySDK.addCommentToolbar(final Activity activity

19、, final String topicSourceId, String topicTitle, String topicUrl)接口：5.2 fragement嵌入com.example.cyan_sdk_test.CyActivity.java中的FixToolBarSectionFragment類展示了如何在Fragment中嵌入評論框浮層。先要在onCreate方法中出事化暢言SDK實例，暢言SDK采用單例模式，調(diào)用暢言SDK的api之前需要先初始化，然后在onCreateView中調(diào)用CyanSDk.addCommentToolbar(ViewGroup rootView, Stri

20、ng topicSourceId, String topicTitle, String topicUrl)，需要將fragment的rootView轉(zhuǎn)為ViewGroup類型傳入。Overridepublic View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) View rootView = inflater.inflate(R.layout.toolbar_demo, container, false);WebView webview = (WebView) ro

21、otView.findViewById(R.id.webview);webview.loadUrl(http:/ rootView, 20131125, F-35戰(zhàn)機,http:/ rootView;6. SDK中單點登錄功能的使用初始化SDK時需要設(shè)置單點登錄相關(guān)配置項：Config config = new Config();/ 是否在發(fā)表評論時允許使用單點登錄config.login.SSOLogin = true;/ 登錄圖標名稱(需將圖片文件放在assets文件夾中)config. login.SSO_Assets_Icon = ico31.png;/ 登錄界面activity的cl

22、assconfig.loginActivityClass = AppLoginActivity.class;CyanSdk.register(cy2uLn0jfoQS, 16bd0e2533092b96e3e55958ef19d08a, http:/51:8081/login-success.html, config);AdnroidMainfest.xml需要添加的配置項:登錄成功后需要調(diào)用的sdk接口，以實現(xiàn)暢言的同步登錄：AccountInfo account = new AccountInfo();/應(yīng)用自己的用戶idaccount.isv_refer_id = 10001;accou

23、nt.nickname = testuser;account.img_url = http:/ AndroidMainfest.xml中配置權(quán)限AndroidMainfest.xml中配置android:name=com.sohu.cyan.android.sdk.push.CyanPushApplication或者public class MyApplication extends CyanPushApplication Override public void onCreate() super.onCreate(); android:name=包名.MyApplicationAndroid

24、Mainfest.xml中注冊RepliesActivityJava代碼中啟用消息推送(需要寫在CyanSdk.register(.)之后)PushManager.setUseService(Context, boolean);四、api調(diào)用示例及說明1.暢言數(shù)據(jù)接口api調(diào)用暢言api的數(shù)據(jù)接口需要先將CySDK 2.1.0目錄中l(wèi)ibs文件夾下的fastjson-1.1.36.jar和httpmime-4.1.2.jar復(fù)制到工程的libs目錄下。然后在項目的AndroidMainfest.xml中加入以下配置信息:調(diào)用api接口前需要初始化暢言sdk：Config config = ne

25、w Config();CyanSdk.register(cy2uLn0jfoQS, 16bd0e2533092b96e3e55958ef19d08a, http:/51:8081/login-success.html, config);cyanSdk = CyanSdk.getInstance(this.getActivity();高亮部分修改為暢言授權(quán)的appid、appkey、callbackUri，設(shè)置方法詳見 HYPERLINK l _4.初始化暢言SDK 第三章第4節(jié)。 SDK的api使用示例參見com.example.cyan_sdk_test.CyActivity.java中的A

26、piSectionFragment。暢言SDK的網(wǎng)絡(luò)數(shù)據(jù)請求采用異步方式，需要開發(fā)者自己實現(xiàn)CyanRequestListener接口處理返回數(shù)據(jù)，數(shù)據(jù)的反序列化采用泛型方式，需要開發(fā)者指定CyanRequestListener的泛型類型。CyanRequestListener中有onRequestSucceeded和onRequestFailed兩個接口，前者處理正常響應(yīng)，處理異常響應(yīng)，下文中api參數(shù)介紹中出現(xiàn)該實現(xiàn)接口的類，不再詳細說明。1.1 不登錄可訪問的api接口接口名稱loadTopic描述首次加載文章頁面時調(diào)用，創(chuàng)建在暢言中的文章信息，加載最新最熱列表。參數(shù)名稱說明topicS

27、ourceId應(yīng)用提供的文章唯一標識，與topicUrl二選一，優(yōu)先使用topicSourceIdtopicUrl文章url地址，與topicSourceId二選一topicTitle文章標題topicCategoryId新聞分類/頻道id，可選參數(shù)，不使用傳nullpageSize查詢的最新評論數(shù)量hotSize查詢的最熱評論數(shù)量style評論展示風格，可選擇蓋樓模式（floor）或縮進模式（indent），傳null時默認蓋樓模式depth列表縮進深度，默認為1，即只縮進一次sub_size子列表最大顯示幾條listener實現(xiàn)CyanRequestListener接口類的實例 返回值無l

28、istener回調(diào)方法onRequestSucceeded的參數(shù)值TopicLoadResp.java屬性類型說明topic_idlong評論idtotal_page_noint總頁數(shù)participation_sumint參與數(shù)share_sumint分享數(shù)cmt_sumint評論總數(shù)hotsArrayList最熱評論列表commentsArrayList最新評論列表error_codeint錯誤碼error_msgString錯誤信息Comment.java屬性名類型說明contentString內(nèi)容create_timelong評論時間comment_idlong評論idsupport_

29、countint頂數(shù)oppose_countint參數(shù)reply_countint回復(fù)數(shù)topboolean是否置頂ipStringip_locationString地域信息fromStringpassportPassport評論用戶信息scorefloat文章評分metadataStringchildCommentCommentcommentsArrayList蓋樓列表attachmentsArrayList圖片附件reply_idlong被回復(fù)評論id接口名稱getCommentCount 描述查詢單個文章評論數(shù)，可實時查詢參數(shù)名稱說明topicSourceIds應(yīng)用提供的文章唯一標識，與

30、topicUrl，topicIds三選一topicUrl文章url地址，與topicSourceId，topicIds三選一topicIds文章在暢言中的ID，通過loadTopic接口獲取，與topicSourceId，topicIds三選一，優(yōu)先使用topicIds，其次使用topicSourceIdslistener實現(xiàn)CyanRequestListener接口類的實例返回值無listener回調(diào)方法onRequestSucceeded的參數(shù)值TopicCountResp.java屬性值類型說明countint單個文章評論數(shù)error_codeint錯誤碼error_msgString錯

31、誤信息接口名稱getCommentCount描述批量獲取文章評論數(shù)，批量接口無法實時更新緩存，所以此接口查詢評論數(shù)無法實時參數(shù)名稱說明ListtopicSourceIds應(yīng)用提供的文章唯一標識，與topicUrl，topicIds三選一ListtopicUrl文章url地址，與topicSourceId，topicIds三選一ListtopicIds文章在暢言中的ID，通過loadTopic接口獲取，與topicSourceId，topicIds三選一，優(yōu)先使用topicIds，其次使用topicSourceIdslistener實現(xiàn)CyanRequestListener接口類的實例返回值無l

32、istener回調(diào)方法onRequestSucceeded的參數(shù)值TopicsCountResp.java屬性值類型說明resultMaperror_codeint錯誤碼error_msgString錯誤信息TopicCount.java屬性名類型說明idlong暢言中的新聞idsidStringsource idsumint評論數(shù)，不推薦使用，請使用commentscommentsint評論數(shù)sharesint分享數(shù)likesint喜歡數(shù)partsint參與數(shù)接口名稱getTopicComments描述分頁查詢文章評論數(shù)據(jù)參數(shù)名稱說明topicId暢言分配的文章唯一ID，通過loadTopi

33、c接口獲取pageSize分頁大小pageNo頁數(shù)style評論展示風格，可選擇蓋樓模式（floor）或縮進模式（indent），傳null時默認蓋樓模式depth列表縮進深度，默認為1，即只縮進一次sub_size子列表最大顯示幾條listener實現(xiàn)CyanRequestListener接口類的實例返回值無listener回調(diào)方法onRequestSucceeded的參數(shù)值TopicCommentsResp.java屬性名類型說明topic_idlong文章 idcommentsList評論cmt_sumint評論總數(shù)接口名稱commentAction描述評論頂踩接口參數(shù)名稱說明topic

34、Id暢言分配的文章唯一ID，通過loadTopic接口獲取commentId評論idtype操作類型，枚舉類CommentActionTypelistener實現(xiàn)CyanRequestListener接口類的實例返回值無listener回調(diào)方法onRequestSucceeded的參數(shù)值CommentActionResp.java服務(wù)器返回的JSON數(shù)據(jù):接口名稱commentReplies描述獲取一條評論的所有回復(fù)參數(shù)名稱說明topicId暢言分配的文章唯一ID，通過loadTopic接口獲取commentId評論idpageSize分頁大小pageNo頁數(shù)listener實現(xiàn)CyanReq

35、uestListener接口類的實例返回值無listener回調(diào)方法onRequestSucceeded的參數(shù)值CommentReplyResp.java屬性名類型說明commentsList一條評論的所有回復(fù)error_codeint錯誤碼error_msgString錯誤信息startAuthorize為登錄接口，使用時需要在AndroidMainfest.xml中注冊暢言的LoginActivity調(diào)用startAuthorize接口的activity需要實現(xiàn)onActivityResult接口，接受登錄是否成功的返回信息，參考com.example.cyan_sdk_test. Log

36、inActivity。接口名稱startAuthorize描述登錄接口，獲取用戶信息，用戶收到的回復(fù)，調(diào)用評論發(fā)表接口前需要先登錄參數(shù)名稱說明platform_id通過oauth方式登錄的第三方平臺，見com.sohu.cyan.android.sdk.util. Constants. PlatFormIdactivity調(diào)用登錄接口的activity返回值無接口名稱getAnonymousUserInfo描述根據(jù)Config中設(shè)置的anonymous_token，獲取匿名用戶信息接口，包括匿名用戶的昵稱，頭像地址等信息。參數(shù)名稱說明listener實現(xiàn)CyanRequestListener接

37、口類的實例返回值無listener回調(diào)方法onRequestSucceeded的參數(shù)值UserInfoResp.java屬性名類型說明nicknameString昵稱fromString賬號來源img_urlString頭像signStringlatest_reply_sumint最近回復(fù)數(shù)comment_sumint發(fā)表評論數(shù)user_idlong用戶id接口名稱anonymousSubmitComment描述發(fā)表評論接口參數(shù)名稱說明topicId暢言分配的文章ID，通過loadTopic接口獲取content評論內(nèi)容replyId回復(fù)的評論，默認為0attachUrl附件圖片地址，通過at

38、tachUpload接口上傳后獲取score打分appType平臺類型，40:ipone,41:ipad,43:androidaccessToken匿名用戶token，在站長后臺wap設(shè)置中生成listener實現(xiàn)CyanRequestListener接口類的實例返回值無listener回調(diào)方法onRequestSucceeded的參數(shù)值SubmitResp.java屬性名類型說明idlong服務(wù)器返回JSON樣例id: 10011.2 需要登錄的api接口名稱submitComment描述發(fā)表評論接口參數(shù)名稱說明topicId暢言分配的文章ID，通過loadTopic接口獲取content評

39、論內(nèi)容replyId回復(fù)的評論，默認為0attachUrl附件圖片地址，通過attachUpload接口上傳后獲取score打分appType平臺類型，40:ipone,41:ipad,43:androidlistener實現(xiàn)CyanRequestListener接口類的實例返回值無listener回調(diào)方法onRequestSucceeded的參數(shù)值SubmitResp.java屬性名類型說明idlong服務(wù)器返回JSON樣例id: 1001接口名稱attachUpload描述發(fā)表評論接口參數(shù)名稱說明file要上傳的圖片listener實現(xiàn)CyanRequestListener接口類的實例返回值無listener回調(diào)方法onRequestSucceeded的參數(shù)值A(chǔ)ttachementResp.java屬性名類型說明urlString附件的url服務(wù)器返回JSON,例如：url : “http:/ 評論列表界面使用viewComment或getCommentBtn需要在項目的AndroidMainfest.xml中注冊CyanCommentActivity接口名稱viewComment描述調(diào)用暢言SDK的評論列表界面和發(fā)表評論界面參數(shù)名稱說明topicSourceId文章在app中的唯一標識