7 uap mobile api referenceuap_plug_apiuexgetui

1、uexGetui1、简介 2、API概览 3、更新历史 接入指引部分：4、打开个推开发者平台注册成为开发者 5、 注册成功后登陆并登记应用 6、 打包个推插件 7、在线打包 1、 简介本插件封装了个推消息推送平台的 SDK，使用此模块可轻松实现服务端向客户端推送和透传消息的功能。2.0.0版本更新了部分方法，请此版本之前的插件重新集成。 1.1 说明插件作者：来自个推官方 仅需在线打包编译 1.2 使用插件需要的相关配置自定义插件（ 建议在线使用 ）下载： 跳转到插件中心，可参考详细操作文档：点击跳转 Android 下载插件包解压修改其中的 AndroidManifest.xml 文件： 替

2、换第 10 行到 21 行中 您的AppId、您的AppKey、您的AppSecret 为申请到的对应值。 替换第 26 行 name 值中 appId 为申请到的 您的AppId。 替换第 86 行 name 值中 appId 为申请到的 您的AppId。 changePushStatusdestroyversioninitializeclientIdsetTagsbindAliasunbindAlias getPushStatussendMessagesendFeedbackMessagesetSilentTime registerDeviceTokenonGetVersiononInit

3、ializePusheronSetTags onGetPushStatusonGetClientIdonBindAliasonUnbindAlias onSendMessageonReceiveMessageonRegisterDeviceTokenonErrorOccur onSetSilentTimeonSendFeedbackMessage替换第 71 行 authorities 值中 您的应用包名 为自己的包名。 适配 Android 5.0 以上需要修改自定义权限名称，替换第 4 行到 8 行 name 值中 您的应用包名 为自己的包名。 因 Android 5.0 系统自身限制,多

4、个应用安装时,如果拥有同一个 Service 权限,会导致权限冲突,只能安装一个带有此权限的应用,其他应用都不能再安装上去。 目前有许多客户在 Android 5.0 系统上接入个推 SDK 时,会发现如果其他集成个推 SDK 的应用已经安装 在 手 机 , 此 应 用 就 不 能 再 安 装 上 去 ， 会 出 现 权 限 冲 突 。 报 错 信 息 如 下 : INSTALL_FAILED_DUPLICATE_PERMISSIONperm=getui.permission.GetuiServicepkg=com.XXX.XXXXX 官 方 说 明 : Starting in Android

5、 5.0, the system enforces a new uniqueness restriction on custom permissions for apps that are signed with differentkeys. Now only one app on a device can define a given custom permission (as determined by its name), unless the other app defining the permission is signed with the same key. If the us

6、er tries to install an app with a duplicate custom permission andis not signed with the same key as the resident app that defines the permission, the system blocks the installation.修改完成后重新在线打包，上传为自定义的插件供打包使用。 2、API概览2.1 方法changePushStatus /开始或暂停推送服务描述 开始或暂停推送服务参数status: (Int 类型) 必选 0 代表开始推送，1 代表暂停推送

7、。 平台支持Android 2.2+版本支持3.0.0+示例代码AndroiduexGetui.changePushStatus(0);destroy /停止并销毁推送服务描述 停止并销毁推送服务参数无平台支持Android 2.2+iOS 6.0+版本支持3.0.0+示例代码uexGetui.destroy();2.2 调用方法version /获取SDK版本号描述 获取 SDK 版本号，回调 onGetVersion。 参数无平台支持Android 2.2+iOS 6.0+版本支持3.0.0+示例代码uexGetui.version();uexGetui.onGetVersion = fu

8、nction(opId, dataType, data)/ Handle datainitialize /初始化推送服务描述 初始化推送服务，回调 onInitializePusher。 参数Android无iOSappId: 申 请 到 的 appId appKey: 申请到的 appKeyappSecret: 申请到的 appSecret平台支持Android 2.2+iOS 6.0+版本支持3.0.0+示例代码AndroiduexGetui.initialize();uexGetui.onInitializePusher = function(opId, dataType, data)/

9、 Handle dataiOSvar params = appId:h5AH1rK4KW7vfFGZjT7fG, appKey:aiMe49ehZa7IK8sevOTiY8, appSecret:wx7779c7c063a9d4d9;var data = JSON.stringify(params); uexGetui.initialize(data);uexGetui.onInitializePusher = function(opId, dataType, data)/ Handle dataclientId /获取当前用户的clientId描述 获取当前用户的 clientId，回调 o

10、nGetClientId。 参数无平台支持Android 2.2+iOS 6.0+版本支持3.0.0+示例代码uexGetui.clientId();uexGetui.onGetClientId = function(opId, dataType, data)/ Handle datasetTags /为用户设置标签描述 为用户设置标签，回调 onSetTags。 参数tags: (String 类型) 必选 标签字符串（以逗号,分割） sn:用户自定义的序列号,用来唯一标识该动作, 自定义 receiver 中会回执该结果平台支持Android 2.2+iOS 6.0+版本支持3.0.0+示

11、例代码var params = tag1,tag2; var sn=getui;uexGetui.setTags(params,sn); uexGetui.onSetTags = function(opId, dataType, data)/ Handle databindAlias /绑定用户别名描述 绑定用户别名，回调 onBindAlias。 参数alias: (String 类型) 必选 别名字符串 平台支持Android 2.2+iOS 6.0+版本支持3.0.0+示例代码var alias = name; var isSelf=true;uexGetui.bindAlias(ali

12、as,isSelf); uexGetui.onBindAlias = function(opId, dataType, data)/ Handle dataunbindAlias /解绑用户别名描述 解绑用户别名，回调 onUnbindAlias。 参数alias: (String 类型) 必选 别名字符串 isSelf:(boolean类型)必选，是否只对当前 cid 有效,如果是 true,只对当前cid做解绑;如果是 false,对所有绑定该别名的 cid列表做解绑平台支持Android 2.2+iOS 6.0+版本支持3.0.0+示例代码var alias = name; var is

13、Self=true;uexGetui.unbindAlias(alias,isSelft); uexGetui.onUnbindAlias = function(opId, dataType, data)/ Handle datagetPushStatus /获取推送服务的服务状态描述 获取推送服务的服务状态，回调 onGetPushStatus。 参数无平台支持Android 2.2+iOS 6.0+版本支持3.0.0+示例代码uexGetui.getPushStatus();uexGetui.onGetPushStatus = function(opId, dataType, data)/

14、 Handle datasendMessage /发送上行消息到应用服务器描述 发送上行消息到应用服务器，回调 onSendMessage。 参数taskId: (String 类型) 必选 task iddata: (String 类型) 必选 需要发送的字符串内容 平台支持Android 2.2+iOS 6.0+版本支持3.0.0+示例代码var params = taskId:TASK_ID, data:any string;var data = JSON.stringify(params); uexGetui.sendMessage(data);uexGetui.onSendMessa

15、ge = function(opId, dataType, data)/ Handle datasendFeedbackMessage /上行第三方自定义回执描述 上行第三方自定义回执，回调 onSendFeedbackMessage。 参数taskId: (String 类 型 ) 必 选 task id messageId: (String 类型) 必选 message idactionId: (String 类型) 必选 action id平台支持Android 2.2+版本支持3.0.0+示例代码Androidvar params = taskId:TASK_ID, messageId

16、:MESSAGE_ID, actionId:90001;var data = JSON.stringify(params); uexGetui.sendFeedbackMessage(data); uexGetui.onSendFeedbackMessage = function(opId, dataType, data)/ Handle datasetSilentTime /设置静默时间描述 设置静默时间，回调 onSetSilentTime。 参数beginHour: (Int 类型) 必选 开始时间 0-23duration: (Int 类型) 必选 持续时间 0-23平台支持Andro

17、id 2.2+版本支持3.0.0+示例代码Androidvar params = beginHour:10, duration:6;var data = JSON.stringify(params); uexGetui.setSilentTime(data);uexGetui.onSetSilentTime = function(opId, dataType, data)/ Handle dataregisterDeviceToken /注册设备token描述 注册设备 token，回调 onRegisterDeviceToken。 参数无平台支持iOS 6.0+版本支持3.0.0+示例代码u

18、exGetui.registerDeviceToken(); uexGetui.onRegisterDeviceToken = function(opId, dataType, data)/ Handle data2.3回调方法onGetVersion /取得SDK 版本号方法参数opId:(Int 类型) 操作IDdataType:(Int 类型) 数据类型 详见CONSTANT中Callback方法数据类型 data:(String 类型) 版本字符串 平台支持Android 2.2+iOS 6.0+版本支持3.0.0+示例代码uexGetui.onGetVersion = functio

19、n(opId, dataType, data) alert(data);onInitializePusher /初始化推送服务方法参数opId:(Int 类型) 操作IDdataType:(Int 类型) 数据类型 详见CONSTANT中Callback方法数据类型 data:(String 类型) JSON 字符串 result 初始化结果：成功 0，失败 1。clientId 注册的 ClientIderror 错误消息（初始化成功错误消息为空）平台支持Android 2.2+iOS 6.0+版本支持3.0.0+示例代码uexGetui.onInitializePusher = funct

20、ion(opId, dataType, data) var object = JSON.parse(data);var result = object.result; var clientId = object.clientId; var error = object.error;onSetTags /设置用户标签方法参数opId:(Int 类型) 操作IDdataType:(Int 类型) 数据类型 详见CONSTANT中Callback方法数据类型 data:(Int 类型) 设置用户标签结果 成功返回 0，失败返回 1。平台支持Android 2.2+iOS 6.0+版本支持3.0.0+

21、示例代码uexGetui.onSetTags = function(opId, dataType, data) alert(data);onGetPushStatus /获取推送服务的服务状态方法参数opId:(Int 类型) 操作IDdataType:(Int 类型) 数据类型 详见CONSTANT中Callback方法数据类型 data:(Int 类型) 推送服务状态 运行返回 0，停止返回 1。平台支持Android 2.2+iOS 6.0+版本支持3.0.0+示例代码uexGetui.onGetPushStatus = function(opId, dataType, data) al

22、ert(data);onGetClientId /获取当前用户的clientId方法参数opId:(Int 类型) 操作IDdataType:(Int 类型) 数据类型 详见CONSTANT中Callback方法数据类型 data:(String 类型) ClientId 字符串 平台支持Android 2.2+iOS 6.0+版本支持3.0.0+示例代码uexGetui.onGetClientId = function(opId, dataType, data) alert(data);onBindAlias /绑定用户别名方法参数opId:(Int 类型) 操作IDdataType:(In

23、t 类型) 数据类型 详见CONSTANT中Callback方法数据类型 data:(Int 类型) 绑定别名结果 成功返回 0，失败返回 1。平台支持Android 2.2+iOS 6.0+版本支持3.0.0+示例代码uexGetui.onBindAlias = function(opId, dataType, data) alert(data);onUnbindAlias /解绑用户别名方法参数opId:(Int 类型) 操作IDdataType:(Int 类型) 数据类型 详见CONSTANT中Callback方法数据类型 data:(Int 类型) 解绑别名结果 成功返回 0，失败返回

24、 1。平台支持Android 2.2+iOS 6.0+版本支持3.0.0+示例代码uexGetui.onUnbindAlias = function(opId, dataType, data) alert(data);onSendMessage /发送上行消息方法参数opId:(Int 类型) 操作IDdataType:(Int 类型) 数据类型 详见CONSTANT中Callback方法数据类型 data:(Int 类型) 发送上行消息结果 成功返回 0，失败返回 1。平台支持Android 2.2+iOS 6.0+版本支持3.0.0+示例代码uexGetui.onSendMessage =

25、 function(opId, dataType, data) alert(data);onReceiveMessage /接收到消息方法参数opId:(Int 类型) 操作IDdataType:(Int 类型) 数据类型 详见CONSTANT中Callback方法数据类型 data:(String 类型) JSON 消息字符串 result 注册结果：成功 0，失败 1。appId 应 用 Id data 消息内容 平台支持Android 2.2+iOS 6.0+版本支持3.0.0+示例代码uexGetui.onReceiveMessage = function(opId, dataType

26、, data) var object = JSON.parse(data);var result = object.result; var appId = object.appId; var message = object.data;onRegisterDeviceToken /注册设备token方法参数opId:(Int 类型) 操作IDdataType:(Int 类型) 数据类型 详见CONSTANT中Callback方法数据类型 data:(String 类型) JSON 消息字符串 result 注册结果：成功 0，失败 1。token 获得的 token 字符串 error 错误消

27、息（成功时错误消息为空）平台支持iOS 6.0+版本支持3.0.0+示例代码uexGetui.onRegisterDeviceToken = function(opId, data) var object = JSON.parse(data);var result = object.result; var token = object.token; var error = object.error;dataType,onErrorOccur /错误发生方法参数opId:(Int 类型) 操作IDdataType:(Int 类型) 数据类型 详见CONSTANT中Callback方法数据类型 d

28、ata:(String 类型) 错误消息字符串 平台支持iOS 6.0+版本支持3.0.0+示例代码uexGetui.onErrorOccur = function(opId, dataType, data) alert(data);onSetSilentTime /设置静默时间方法参数opId:(Int 类型) 操作IDdataType:(Int 类型) 数据类型 详见CONSTANT中Callback方法数据类型 data:(Int 类型) 设置静默结果 成功返回 0，失败返回 1。平台支持Android 2.2+版本支持3.0.0+示例代码uexGetui.onSetSilentTime = function(opId, dataType, data) alert(data);onSendFeedbackMessage /上行第三方自定义回执方法参数opId:(Int 类型) 操作IDdataType:(Int 类型) 数据类型 详见CONSTANT中