diff --git a/README.md b/README.md index cb68968..17bedec 100644 --- a/README.md +++ b/README.md @@ -121,6 +121,12 @@ window.plugins.jPushPlugin.setTagsWithAlias(tags,alias) window.plugins.jPushPlugin.setTags(tags) window.plugins.jPushPlugin.setAlias(alias) ++ 停止与恢复推送服务 API + + window.plugins.jPushPlugin.init() + window.plugins.jPushPlugin.stopPush() + window.plugins.jPushPlugin.resumePush() + window.plugins.jPushPlugin.isPushStopped(callback) [通用API详细说明](document/Common_detail_api.md) @@ -144,7 +150,8 @@ window.plugins.jPushPlugin.resetBadge() window.plugins.jPushPlugin.setApplicationIconBadgeNumber(badge) + 本地通知 - 后续版本加入 + + + 后续版本加入 + 日志等级设置 @@ -156,15 +163,8 @@ #### adnroid API简介 -+ 停止与恢复推送服务 API - - window.plugins.jPushPlugin.init() - window.plugins.jPushPlugin.stopPush() - window.plugins.jPushPlugin.resumePush() - window.plugins.jPushPlugin.isPushStopped(callback) + 获取集成日志 - window.plugins.jPushPlugin.setDebugMode(mode) + 接收推送消息Receiver @@ -201,3 +201,6 @@ window.plugins.jPushPlugin.clearLocalNotifications() [Android API详细说明](document/Android_detail_api.md) + +###更多 + [JPush官网文档](http://docs.jpush.io/) \ No newline at end of file diff --git a/document/Android_detail_api.md b/document/Android_detail_api.md index 55bae27..ebd78c1 100644 --- a/document/Android_detail_api.md +++ b/document/Android_detail_api.md @@ -1,91 +1,6 @@ ## adnroid API简介 -### 停止与恢复推送服务 API -#### API - init - -调用此API,用来开启 -JPush SDK 提供的推送服务。 - -开发者App可以通过调用停止推送服务API来停止极光推送服务。当又需要使用极光推送服务时,则必须要调用恢复推送服务 API。 - -``` -本功能是一个完全本地的状态操作。也就是说:停止推送服务的状态不会保存到服务器上。 - -如果停止推送服务后,开发者App被重新安装,或者被清除数据, - -JPush SDK 会恢复正常的默认行为。(因为保存在本地的状态数据被清除掉了)。 -本功能其行为类似于网络中断的效果,即:推送服务停止期间推送的消息, - -恢复推送服务后,如果推送的消息还在保留的时长范围内,则客户端是会收到离线消息。 -``` - -##### 接口定义 - - window.plugins.jPushPlugin.init() - -#### API - stopPush -+ 在android平台 - - + 开发者App可以通过调用停止推送服务API来停止极光推送服务。当又需要使用极光推送服务时,则必须要调用恢复推送服务 API。 - - - + 调用了本 API 后,JPush 推送服务完全被停止。具体表现为: - - + JPush Service 不在后台运行 - + 收不到推送消息 - + 不能通过 JPushInterface.init 恢复,需要调用resumePush恢复 - + 极光推送所有的其他 API 调用都无效 - -+ iOS平台 - - + 不推荐调用,因为这个API只是让你的DeviceToken失效,在设置-通知 中您的应用程序没有任何变化 - + 推荐:设置一个UI界面, 提醒用户在在设置-通知关闭推送服务 - -##### 接口定义 - - window.plugins.jPushPlugin.stopPush() - -#####平台 -android,iOS - -#### API - resumePush - -恢复推送服务。 -调用了此 API 后,在android平台上极光推送完全恢复正常工作,在iOS平台上重新去APNS注册 - -#####平台 -android iOS - -##### 接口定义 - - window.plugins.jPushPlugin.resumePush() - -#### API - isPushStopped - -在android 用来检查 Push Service 是否已经被停止 -在iOS 平台检查推送服务是否注册 - -##### 接口定义 - - window.plugins.jPushPlugin.isPushStopped(callback) - -#####平台 -android iOS - -##### 参数说明 - -+ callback 回调函数,用来通知JPush的推送服务是否开启 - -####代码示例 - window.plugins.jPushPlugin.resumePush(callback) - var onCallback = function(data) { - if(data>0){ - //开启 - }else{ - //关闭 - } - } ### 获取集成日志 diff --git a/document/Common_detail_api.md b/document/Common_detail_api.md index 706ea12..fdff5b5 100644 --- a/document/Common_detail_api.md +++ b/document/Common_detail_api.md @@ -1,6 +1,104 @@ #通用API说明 + +## 停止与恢复推送服务 API +### API - init + +调用此API,用来开启 +JPush SDK 提供的推送服务。 + +开发者App可以通过调用停止推送服务API来停止极光推送服务。当又需要使用极光推送服务时,则必须要调用恢复推送服务 API。 + +``` +本功能是一个完全本地的状态操作。也就是说:停止推送服务的状态不会保存到服务器上。 + +如果停止推送服务后,开发者App被重新安装,或者被清除数据, + +JPush SDK 会恢复正常的默认行为。(因为保存在本地的状态数据被清除掉了)。 +本功能其行为类似于网络中断的效果,即:推送服务停止期间推送的消息, + +恢复推送服务后,如果推送的消息还在保留的时长范围内,则客户端是会收到离线消息。 +``` + +#### 接口定义 + + window.plugins.jPushPlugin.init() + +### API - stopPush ++ 在android平台 + + + 开发者App可以通过调用停止推送服务API来停止极光推送服务。当又需要使用极光推送服务时,则必须要调用恢复推送服务 API。 + + + + 调用了本 API 后,JPush 推送服务完全被停止。具体表现为: + + + JPush Service 不在后台运行 + + 收不到推送消息 + + 不能通过 JPushInterface.init 恢复,需要调用resumePush恢复 + + 极光推送所有的其他 API 调用都无效 + ++ iOS平台 + + + 不推荐调用,因为这个API只是让你的DeviceToken失效,在设置-通知 中您的应用程序没有任何变化 + + 推荐:设置一个UI界面, 提醒用户在在设置-通知关闭推送服务 + +### 接口定义 + + window.plugins.jPushPlugin.stopPush() + + +#### API - resumePush + + +恢复推送服务。调用了此 API 后 + ++ 在android平台 + + + 极光推送完全恢复正常工作, + ++ iOS平台 + + + 重新去APNS注册 + + + +##### 接口定义 + + window.plugins.jPushPlugin.resumePush() + +#### API - isPushStopped + ++ 在android平台 + + + 用来检查 Push Service 是否已经被停止 + ++ iOS平台 + + + 平台检查推送服务是否注册 + + +##### 接口定义 + + window.plugins.jPushPlugin.isPushStopped(callback) + + +##### 参数说明 + ++ callback 回调函数,用来通知JPush的推送服务是否开启 + +####代码示例 + window.plugins.jPushPlugin.resumePush(callback) + var onCallback = function(data) { + if(data>0){ + //开启 + }else{ + //关闭 + } + } + + ##获取 RegistrationID API + ### API - getRegistrationID RegistrationID 定义