Update 公共SDK扩展接口接入文档.md

tangweijun
Commit 77af29c115387f9609c18cf892aeed7e517f2b93 77af29c1 1 parent bd13e3f9
Showing 1 changed file with 171 additions and 0 deletions
doc/公共SDK扩展接口接入文档.md
--- a/doc/公共SDK扩展接口接入文档.md
View file @77af29c
+++ b/doc/公共SDK扩展接口接入文档.md
View file @77af29c
@@ -3,33 +3,52 @@
 ## 接入必读
 1.公共获取状态接口(用于获取各种状态)
     `public static boolean hasFunction(String functionName)`
+    
 |  参数名称   |  字段说明  |
+|----------------|------------------------------------------|
 |  functionName  |  需要获取的状态名称(eg:hasBindFunction)  |
 2.公共扩展功能接口
     `public static String callFunc(String funcName,Map<Object,Object> param)`
+    
 |  参数名称        |  字段说明  |
+|-----------------|------------------------------|
 |  functionName   | 功能方法名(eg:bindFunction)  |
 |  param        |  扩展参数(具体看对应接口说明)  |
+
 ### 具体接口说明如下
 #### facebook好友界面
 *是否有facebook好友界面接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|--------------------------|------------------------------|-----------------------|
 |  hasFaceBookFriendsView  |  是否有facebook好友界面接口  |  true:有，false:没有  |
+
     调用事例: `boolean hasFaceBookFriendsView = PoolSdkHelper.hasFunction("hasFaceBookFriendsView");`
+    
 *facebook好友界面功能接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|---------------------------|------------------------|------|
 |  showFaceBookFriendsView  |  facebook好友界面接口  |  无  |
+
     调用事例: `PoolSdkHelper.callFunc("showFaceBookFriendsView",null);`
 #### 优惠券
 *是否有优惠券接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|-------------|--------------------|-----------------------|
 |  hasCoupon  |  是否有优惠券接口  |  true:有，false:没有  |
+
     调用事例: `boolean hasCoupon = PoolSdkHelper.hasFunction("hasCoupon");`
+    
 *优惠券功能接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|-------------|-----------|---------------------------------------------------------------------------------------------|
 |  coupon  |  优惠券接口  |  成功 1102(PoolSDKCode.POOLSDK_COUPON_SUCCESS)  失败 1202(PoolSDKCode.POOLSDK_COUPON_FAIL)  |
+
     调用事例: 
     `Map<Object,Object> map = new HashMap();`
     `map.put("优惠券码","");`
@@ -37,52 +56,87 @@
 #### 删除账号
 *是否有删除账号接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|-------------------|----------------------|-----------------------|
 |  hasDeleteMember  |  是否有删除账号接口  |  true:有，false:没有  |
+
     调用事例: `boolean hasDeleteMember = PoolSdkHelper.hasFunction("hasDeleteMember");`
+    
 *删除账号券功能接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|----------------|----------------|-----------------------------------------------------------------------------------------------------|
 |  deleteMember  |  删除账号接口  |  成功 1107(PoolSDKCode.POOLSDK_DEL_MEMBER_SUCCESS)  失败 1207(PoolSDKCode.POOLSDK_DEL_MEMBER_FAIL)  |
+
     调用事例: `PoolSdkHelper.callFunc("deleteMember",null);`
 #### 显示公告
 *是否有显示公告接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|-----------------|----------------------|-----------------------|
 |  hasShowNotice  |  是否有显示公告接口  |  true:有，false:没有  |
+
     调用事例: `boolean hasShowNotice = PoolSdkHelper.hasFunction("hasShowNotice");`
+    
 *显示公告功能接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|--------------|----------------|---------|
 |  showNotice  |  显示公告接口  |  无 |
+
     调用事例: `PoolSdkHelper.callFunc("showNotice",null);`
 #### 显示cafe窗口
 *是否有显示cafe窗口接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|--------------------|--------------------------|-----------------------|
 |  hasNaverCafePlug  |  是否有显示cafe窗口接口  |  true:有，false:没有  |
+
     调用事例: `boolean hasNaverCafePlug = PoolSdkHelper.hasFunction("hasNaverCafePlug");`
+    
 *显示cafe窗口功能接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|---------------------|--------------------|-----|
 |  showNaverCafePlug  |  显示cafe窗口接口  |  无 |
+
     调用事例: `PoolSdkHelper.callFunc("showNaverCafePlug",null);`
 #### 谷歌评论
 *是否有谷歌评论接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|--------------------|----------------------|-----------------------|
 |  hasGoogleComment  |  是否有谷歌评论接口  |  true:有，false:没有  |
+
     调用事例: `boolean hasGoogleComment = PoolSdkHelper.hasFunction("hasGoogleComment");`
+    
 *谷歌评论功能接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|--------------------|--------------------|----------------------------------------------------------------------------------------------------------|
 |  showGoogleComment  |  谷歌评论接口  |  成功 1106(PoolSDKCode.POOLSDK_GOOGLE_COMMENT_SUCCESS)  失败 1206(PoolSDKCode.POOLSDK_GOOGLE_COMMENT_FAIL)  |
+
     调用事例: `PoolSdkHelper.callFunc("showGoogleComment",null);`
 #### facebook截屏分享
 *是否有facebook截屏分享接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|---------------------------|------------------------------|-----------------------|
 |  hasFacebookCaptureShare  |  是否有facebook截屏分享接口  |  true:有，false:没有  |
+
     调用事例: `boolean hasFacebookCaptureShare = PoolSdkHelper.hasFunction("hasFacebookCaptureShare");`
+    
 *facebook截屏分享功能接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|-----------------|------------------------|-------------------------------------------------------------------------------------------|
 |  showShareView  |  facebook截屏分享接口  |  成功 1104(PoolSDKCode.POOLSDK_SHARE_SUCCESS)  失败 1204(PoolSDKCode.POOLSDK_SHARE_FAIL)  |
+
     调用事例: 
     `Map<Object,Object> map = new HashMap();`
     `map.put("facebook_capture","");`
@@ -90,12 +144,19 @@
 #### twitter分享
 *是否有twitter分享接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|-------------------|-------------------------|-----------------------|
 |  hasTwitterShare  |  是否有twitter分享接口  |  true:有，false:没有  |
+
     调用事例: `boolean hasTwitterShare = PoolSdkHelper.hasFunction("hasTwitterShare");`
+    
 *twitter分享功能接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|-----------------|-------------------|-------------------------------------------------------------------------------------------|
 |  showShareView  |  twitter分享接口  |  成功 1104(PoolSDKCode.POOLSDK_SHARE_SUCCESS)  失败 1204(PoolSDKCode.POOLSDK_SHARE_FAIL)  |
+
     调用事例: 
     `Map<Object,Object> map = new HashMap();`
     `map.put("twitter","");`
@@ -103,12 +164,19 @@
 #### twitter截屏分享
 *是否有twitter截屏分享接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|--------------------------|-----------------------------|-----------------------|
 |  hasTwitterCaptureShare  |  是否有twitter截屏分享接口  |  true:有，false:没有  |
+
     调用事例: `boolean hasTwitterCaptureShare = PoolSdkHelper.hasFunction("hasTwitterCaptureShare");`
+    
 *twitter截屏分享功能接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|-----------------|-----------------------|-------------------------------------------------------------------------------------------|
 |  showShareView  |  twitter截屏分享接口  |  成功 1104(PoolSDKCode.POOLSDK_SHARE_SUCCESS)  失败 1204(PoolSDKCode.POOLSDK_SHARE_FAIL)  |
+
     调用事例: 
     `Map<Object,Object> map = new HashMap();`
     `map.put("twitter_capture","");`
@@ -116,12 +184,19 @@
 #### line截屏分享
 *是否有line截屏分享接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|-----------------------|--------------------------|-----------------------|
 |  hasLineCaptureShare  |  是否有line截屏分享接口  |  true:有，false:没有  |
+
     调用事例: `boolean hasLineCaptureShare = PoolSdkHelper.hasFunction("hasLineCaptureShare");`
+    
 *line截屏分享功能接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|-----------------|--------------------|-------------------------------------------------------------------------------------------|
 |  showShareView  |  line截屏分享接口  |  成功 1104(PoolSDKCode.POOLSDK_SHARE_SUCCESS)  失败 1204(PoolSDKCode.POOLSDK_SHARE_FAIL)  |
+
     调用事例: 
     `Map<Object,Object> map = new HashMap();`
     `map.put("line_capture","");`
@@ -129,12 +204,19 @@
 #### instagram截屏分享
 *是否有instagram截屏分享接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|----------------------------|-------------------------------|-----------------------|
 |  hasInstagramCaptureShare  |  是否有instagram截屏分享接口  |  true:有，false:没有  |
+
     调用事例: `boolean hasInstagramCaptureShare = PoolSdkHelper.hasFunction("hasInstagramCaptureShare");`
+    
 *instagram截屏分享功能接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|-----------------|-------------------------|-------------------------------------------------------------------------------------------|
 |  showShareView  |  instagram截屏分享接口  |  成功 1104(PoolSDKCode.POOLSDK_SHARE_SUCCESS)  失败 1204(PoolSDKCode.POOLSDK_SHARE_FAIL)  |
+
     调用事例: 
     `Map<Object,Object> map = new HashMap();`
     `map.put("instagram_capture","");`
@@ -142,23 +224,38 @@
 #### google绑定
 *是否有google绑定接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|-----------------------|------------------------|-----------------------|
 |  hasLinkedGoogleView  |  是否有google绑定接口  |  true:有，false:没有  |
+
     调用事例: `boolean hasLinkedGoogleView = PoolSdkHelper.hasFunction("hasLinkedGoogleView");`
+    
 *获取google绑定状态接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|------------------------|--------------------|-------------------------------|
 |  getLinkedGoogleStatu  |  是否绑定了google  |  true:绑定了，false:没有绑定  |
+
     调用事例: `boolean getLinkedGoogleStatu = PoolSdkHelper.hasFunction("getLinkedGoogleStatu");`
+    
 *google绑定功能接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------|
 |  createLinkingAccount  |  google绑定接口  |  成功 1100(PoolSDKCode.POOLSDK_CREATE_LINKING_ACCOUNT_SUCCESS)  失败 1200(PoolSDKCode.POOLSDK_CREATE_LINKING_ACCOUNT_FAIL)  |
+
     调用事例: 
     `Map<Object,Object> map = new HashMap();`
     `map.put("google","");`
     `PoolSdkHelper.callFunc("createLinkingAccount",map);`
+    
 *google解绑功能接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|------------------------|----------------------|-----------------------------------------------------------------------------------------------------------------------|
 |  deleteLinkingAccount  |  google解除绑定接口  |  成功 1101(PoolSDKCode.POOLSDK_DEL_LINKING_ACCOUNT_SUCCESS)  失败 1201(PoolSDKCode.POOLSDK_DEL_LINKING_ACCOUNT_FAIL)  |
+
     调用事例: 
     `Map<Object,Object> map = new HashMap();`
     `map.put("google","");`
@@ -166,23 +263,38 @@
 #### facebook绑定
 *是否有facebook绑定接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|-------------------------|--------------------------|-----------------------|
 |  hasLinkedFacebookView  |  是否有facebook绑定接口  |  true:有，false:没有  |
+
     调用事例: `boolean hasLinkedFacebookView = PoolSdkHelper.hasFunction("hasLinkedFacebookView");`
+    
 *获取facebook绑定状态接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|--------------------------|----------------------|-------------------------------|
 |  getLinkedFacebookStatu  |  是否绑定了facebook  |  true:绑定了，false:没有绑定  |
+
     调用事例: `boolean getLinkedFacebookStatu = PoolSdkHelper.hasFunction("getLinkedFacebookStatu");`
+    
 *facebook绑定功能接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|------------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------|
 |  createLinkingAccount  |  facebook绑定接口  |  成功 1100(PoolSDKCode.POOLSDK_CREATE_LINKING_ACCOUNT_SUCCESS)  失败 1200(PoolSDKCode.POOLSDK_CREATE_LINKING_ACCOUNT_FAIL)  |
+
     调用事例: 
     `Map<Object,Object> map = new HashMap();`
     `map.put("facebook","");`
     `PoolSdkHelper.callFunc("createLinkingAccount",map);`
+    
 *facebook解绑功能接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|------------------------|------------------------|-----------------------------------------------------------------------------------------------------------------------|
 |  deleteLinkingAccount  |  facebook解除绑定接口  |  成功 1101(PoolSDKCode.POOLSDK_DEL_LINKING_ACCOUNT_SUCCESS)  失败 1201(PoolSDKCode.POOLSDK_DEL_LINKING_ACCOUNT_FAIL)  |
+
     调用事例: 
     `Map<Object,Object> map = new HashMap();`
     `map.put("facebook","");`
@@ -190,23 +302,38 @@
 #### 无确切绑定平台
 *是否有无确切绑定平台接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|----------------------|----------------------------|-----------------------|
 |  hasLinkedOtherView  |  是否有无确切绑定平台接口  |  true:有，false:没有  |
+
     调用事例: `boolean hasLinkedOtherView = PoolSdkHelper.hasFunction("hasLinkedOtherView");`
+    
 *获取无确切绑定平台绑定状态接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|-----------------------|----------------------|-------------------------------|
 |  getLinkedOtherStatu  |  是否绑定了某个平台  |  true:绑定了，false:没有绑定  |
+
     调用事例: `boolean getLinkedOtherStatu = PoolSdkHelper.hasFunction("getLinkedOtherStatu");`
+    
 *无确切绑定平台绑定功能接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|------------------------|--------------------------|-----------------------------------------------------------------------------------------------------------------------------|
 |  createLinkingAccount  |  无确切绑定平台绑定接口  |  成功 1100(PoolSDKCode.POOLSDK_CREATE_LINKING_ACCOUNT_SUCCESS)  失败 1200(PoolSDKCode.POOLSDK_CREATE_LINKING_ACCOUNT_FAIL)  |
+
     调用事例: 
     `Map<Object,Object> map = new HashMap();`
     `map.put("other","");`
     `PoolSdkHelper.callFunc("createLinkingAccount",map);`
+    
 *无确切绑定平台解绑功能接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|------------------------|------------------------------|-----------------------------------------------------------------------------------------------------------------------|
 |  deleteLinkingAccount  |  无确切绑定平台解除绑定接口  |  成功 1101(PoolSDKCode.POOLSDK_DEL_LINKING_ACCOUNT_SUCCESS)  失败 1201(PoolSDKCode.POOLSDK_DEL_LINKING_ACCOUNT_FAIL)  |
+
     调用事例: 
     `Map<Object,Object> map = new HashMap();`
     `map.put("other","");`
@@ -214,23 +341,37 @@
 #### 设置全体推送
 *是否全体推送接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|------------------------|------------------------------|---------------|
 |  hasAllPushEnableView  |  是否有全体推送接口  |  true:有，false:没有  |
+
     调用事例: `boolean hasAllPushEnableView = PoolSdkHelper.hasFunction("hasAllPushEnableView");`
+    
 *获取全体推送状态接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|-------------------------|----------------------|-------------------------------|
 |  getAllPushEnableStatu  |  是否开启了全体推送  |  true:开启了，false:没有开启  |
+
     调用事例: `boolean getAllPushEnableStatu = PoolSdkHelper.hasFunction("getAllPushEnableStatu");`
+    
 *全体推送功能开启接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|-----------------|--------------------|-------------------------------------------------------------------------------------------------------|
 |  setPushEnable  |  全体推送开启接口  |  成功 1103(PoolSDKCode.POOLSDK_PUSH_ENABLE_SUCCESS)  失败 1203(PoolSDKCode.POOLSDK_PUSH_ENABLE_FAIL)  |
+
     调用事例: 
     `Map<Object,Object> map = new HashMap();`
     `map.put("all","");`
     `PoolSdkHelper.callFunc("setPushEnable",map);`
+    
 *全体推送关闭功能接口
 |  参数名称   |  功能说明  |  返回值说明  |
+|------------------|--------------------|---------------------------------------------------------------------------------------------------------|
 |  setPushDisable  |  全体推送关闭接口  |  成功 1105(PoolSDKCode.POOLSDK_PUSH_DISABLE_SUCCESS)  失败 1205(PoolSDKCode.POOLSDK_PUSH_DISABLE_FAIL)  |
+
     调用事例: 
     `Map<Object,Object> map = new HashMap();`
     `map.put("all","");`
@@ -238,23 +379,38 @@
 #### 设置夜间推送
 *是否全体推送接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|--------------------------|----------------------|-----------------------|
 |  hasNightPushEnableView  |  是否有夜间推送接口  |  true:有，false:没有  |
+
     调用事例: `boolean hasNightPushEnableView = PoolSdkHelper.hasFunction("hasNightPushEnableView");`
+    
 *获取夜间推送状态接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|---------------------------|----------------------|-------------------------------|
 |  getNightPushEnableStatu  |  是否开启了夜间推送  |  true:开启了，false:没有开启  |
+
     调用事例: `boolean getNightPushEnableStatu = PoolSdkHelper.hasFunction("getNightPushEnableStatu");`
+    
 *夜间推送功能开启接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|-----------------|--------------------|-------------------------------------------------------------------------------------------------------|
 |  setPushEnable  |  夜间推送开启接口  |  成功 1103(PoolSDKCode.POOLSDK_PUSH_ENABLE_SUCCESS)  失败 1203(PoolSDKCode.POOLSDK_PUSH_ENABLE_FAIL)  |
+
     调用事例: 
     `Map<Object,Object> map = new HashMap();`
     `map.put("night","");`
     `PoolSdkHelper.callFunc("setPushEnable",map);`
+    
 *夜间推送关闭功能接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|------------------|--------------------|---------------------------------------------------------------------------------------------------------|
 |  setPushDisable  |  夜间推送关闭接口  |  成功 1105(PoolSDKCode.POOLSDK_PUSH_DISABLE_SUCCESS)  失败 1205(PoolSDKCode.POOLSDK_PUSH_DISABLE_FAIL)  |
+
     调用事例: 
     `Map<Object,Object> map = new HashMap();`
     `map.put("night","");`
@@ -262,23 +418,38 @@
 #### 设置广告推送
 *是否广告推送接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|-----------------------|----------------------|-----------------------|
 |  hasAdPushEnableView  |  是否有广告推送接口  |  true:有，false:没有  |
+
     调用事例: `boolean hasAdPushEnableView = PoolSdkHelper.hasFunction("hasAdPushEnableView");`
+    
 *获取广告推送状态接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|------------------------|----------------------|-------------------------------|
 |  getAdPushEnableStatu  |  是否开启了广告推送  |  true:开启了，false:没有开启  |
+
     调用事例: `boolean getAdPushEnableStatu = PoolSdkHelper.hasFunction("getAdPushEnableStatu");`
+    
 *广告推送功能开启接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|-----------------|--------------------|-------------------------------------------------------------------------------------------------------|
 |  setPushEnable  |  广告推送开启接口  |  成功 1103(PoolSDKCode.POOLSDK_PUSH_ENABLE_SUCCESS)  失败 1203(PoolSDKCode.POOLSDK_PUSH_ENABLE_FAIL)  |
+
     调用事例: 
     `Map<Object,Object> map = new HashMap();`
     `map.put("ad","");`
     `PoolSdkHelper.callFunc("setPushEnable",map);`
+    
 *广告推送关闭功能接口
+
 |  参数名称   |  功能说明  |  返回值说明  |
+|------------------|--------------------|---------------------------------------------------------------------------------------------------------|
 |  setPushDisable  |  广告推送关闭接口  |  成功 1105(PoolSDKCode.POOLSDK_PUSH_DISABLE_SUCCESS)  失败 1205(PoolSDKCode.POOLSDK_PUSH_DISABLE_FAIL)  |
+
     调用事例: 
     `Map<Object,Object> map = new HashMap();`
     `map.put("ad","");`