個(gè)信Android平臺(tái)SDK文檔.doc

個(gè)信互動(dòng)（北京）網(wǎng)絡(luò)科技有限公司 普通個(gè)信Android平臺(tái)SDK文檔（JAR模式）個(gè)信Android平臺(tái)SDK接口文檔-JAR模式個(gè)信互動(dòng)（北京）網(wǎng)絡(luò)科技有限公司編號: GEXIN_ANDROID_SDK_JAR版本: GEXIN_ANDROID_SDK_JAR V1.1.1修訂記錄時(shí)間文檔版本修訂人備注2011/6/61.0.0董霖初稿2011/11/301.1.0董霖基于新版SDK架構(gòu)接口2011/12/031.1.1全博偉增加權(quán)限設(shè)置和推送圖標(biāo)設(shè)置2011/12/231.1.2董霖增加流量統(tǒng)計(jì)接口2012/1/181.1.3全博偉增加自定義tag接口目錄概述3名詞解釋3SDK詳細(xì)介紹3SDK包含內(nèi)容3SDK Tutorial3SDK接口Reference3GexinSdk3GexinSdkObserver3其他注意事項(xiàng)3附錄3附錄一3概述個(gè)信Android平臺(tái)SDK為第三方應(yīng)用提供了穩(wěn)定易用的推送通知服務(wù)，使得第三方客戶端無需定時(shí)查詢服務(wù)器，即可實(shí)現(xiàn)將服務(wù)端數(shù)據(jù)即時(shí)發(fā)送至第三方客戶端。對于Relay方式的消息，請參閱個(gè)信Android平臺(tái)SlaveSDK文檔名詞解釋GPN: Gexin Push Notification個(gè)信推送服務(wù)SDK詳細(xì)介紹關(guān)于個(gè)信推送服務(wù)整體框架和SDK交互流程的說明，請參見個(gè)信推送服務(wù)說明文檔SDK包含內(nèi)容個(gè)信Android平臺(tái)SDK（JAR模式）提供個(gè)信服務(wù)層jar包（文件名為GexinSdk.jar）、測試客戶端項(xiàng)目工程SDK_Demo_Master以及SDK文檔。SDK Tutorial1. 將GexinSdk.jar添加到工程中，并在AndroidManifest.xml里添加SDK所需的服務(wù)聲明和權(quán)限聲明：Application:標(biāo)簽內(nèi)加入Application:標(biāo)簽外加入 2. 當(dāng)應(yīng)用運(yùn)行在后臺(tái)時(shí)SDK能調(diào)用應(yīng)用彈出廣告，需在主Activity標(biāo)簽中加入android:launchMode=singleTop。3. 設(shè)置推送消息在Notification欄顯示的圖標(biāo)：把圖片命名為push.png, 放入工程res/ drawable目錄中。SDK默認(rèn)讀取該push.png，如果不存在，則使用系統(tǒng)默認(rèn)圖標(biāo)。4. 實(shí)現(xiàn)GexinSdkObserver相關(guān)接口5. 在應(yīng)用程序啟動(dòng)初始化階段，調(diào)用GexinSdk.initialize()進(jìn)行SDK初始化6. 通過GexinSdkObserver.onRegistered()獲取SDK注冊到的ClientID信息，保存到第三方服務(wù)器7. 服務(wù)器推送下來的消息，通過GexinSdkObserver.onPayloadReceived()接口獲得通知，取得payloadID，然后使用GexinSdk.getPayload()獲取具體的消息內(nèi)容SDK接口ReferenceGexinSdkSDK功能接口，以類方法形式提供給第三方應(yīng)用程序調(diào)用。每個(gè)應(yīng)用程序只能初始化一次SDK，使用一個(gè)推送通道。ensureInstall描述確認(rèn)SDK服務(wù)層已經(jīng)正確安裝。如果SDK服務(wù)層未安裝，會(huì)啟動(dòng)APK安裝過程。原型public static void ensureInstall()返回值無有效性僅對APK模式有效，JAR模式忽略該接口initialize描述SDK初始化，完成注冊和登錄過程，同時(shí)進(jìn)行應(yīng)用綁定。原型public static void initialize(Context context, GexinSdkObserver observer,String appID)參數(shù)context：第三方Android應(yīng)用程序Context主對象observer：第三方實(shí)現(xiàn)的觀察器對象appID：為每個(gè)應(yīng)用分配的唯一標(biāo)識串返回值無有效性From 1.0getPayload描述獲取push消息數(shù)據(jù)，也即Payload原型public static byte getPayload(String payloadID)參數(shù)context：消息標(biāo)識，通過GexinSdkObserver.onPayloadReceived獲取返回值Payload數(shù)據(jù)，以byte數(shù)組形式返回有效性From 1.0bindService描述進(jìn)行應(yīng)用綁定原型public static void bindService(String appID)參數(shù)appID：為每個(gè)應(yīng)用分配的唯一標(biāo)識串返回值無有效性From 1.0unbindService描述取消應(yīng)用綁定原型public static void unbindService(String appID)參數(shù)appID：為每個(gè)應(yīng)用分配的唯一標(biāo)識串返回值無有效性From 1.0getNetstat描述獲取網(wǎng)絡(luò)信息原型public static void getNetstat(GexinSdkNetstat &stat)參數(shù)stat：網(wǎng)絡(luò)信息，包括網(wǎng)絡(luò)流量等。參見GexinSdkNetstat返回值無有效性From 1.0addTag描述添加/設(shè)置Tag原型public static final void addTag(Tag tag)參數(shù)tag：標(biāo)簽結(jié)構(gòu)等。參見Tag返回值無有效性From 1.0removeTag描述刪除Tag原型public static final void removeTag (Tag tag)參數(shù)tag：標(biāo)簽結(jié)構(gòu)等。參見Tag返回值無有效性From 1.0GexinSdkObserver獲取SDK事件通知，獲取相應(yīng)的狀態(tài)和數(shù)據(jù)。由第三方應(yīng)用程序?qū)崿F(xiàn)該接口，并在SDK初始化時(shí)傳入相應(yīng)的實(shí)例對象。onRegistered描述SDK注冊成功通知原型public void onRegistered(String clientID)參數(shù)clientID：SDK用戶標(biāo)識信息，獲取后建議保存到服務(wù)端返回值無有效性From 1.0onPayloadReceived描述推送消息通知原型public void onPayloadReceived(String payloadID)參數(shù)payloadID：消息ID，后續(xù)通過GexinSdk.getPayload()獲取完整的Payload數(shù)據(jù)返回值無有效性From 1.0onBindService描述應(yīng)用綁定結(jié)果通知原型public void onBindService(String appID,String result)參數(shù)appID：第三方應(yīng)用IDresult：綁定結(jié)果。succeed成功 failed失敗返回值無有效性暫不支持onUnbindService描述應(yīng)用解綁結(jié)果通知原型public void onUnbindService(String appID,String result)參數(shù)appID：第三方應(yīng)用IDresult：解綁結(jié)果。succeed成功 failed失敗返回值無有效性暫不支持GexinSdkNetstat從getNetstat獲取的網(wǎng)絡(luò)信息結(jié)構(gòu)。包括流量信息，網(wǎng)絡(luò)狀態(tài)等。long inboundBytes從SDK啟動(dòng)開始，從網(wǎng)絡(luò)接收到的總字節(jié)數(shù)（包括WIFI和移動(dòng)網(wǎng)絡(luò)）long outboundBytes從SDK啟動(dòng)開始，向網(wǎng)絡(luò)發(fā)送的總字節(jié)數(shù)（包括WIFI和移動(dòng)網(wǎng)絡(luò)）Tag自定義標(biāo)簽結(jié)構(gòu)。public void setName(String name)自定義標(biāo)簽名，只允許中文、英文、數(shù)字、和+-*_.public void setTypeInt()自定義標(biāo)簽value類型為Int型。public void setTypeString()自定義標(biāo)簽value類型為String型。public void setTypeFloat()自定義標(biāo)簽value類型為float型。public void setTypeDate()自定義標(biāo)簽value類型為date型。public void setValueInt(int value)設(shè)置type類型為Int型，標(biāo)簽的value值。public void setValueString(String value)設(shè)置type類型為String型，標(biāo)簽的value值