Skip to content

Commit

Permalink
update api
Browse files Browse the repository at this point in the history
  • Loading branch information
huangminlinux committed Jul 10, 2018
1 parent 15d09a6 commit 6b464eb
Showing 1 changed file with 26 additions and 20 deletions.
46 changes: 26 additions & 20 deletions documents/api.md
@@ -1,6 +1,7 @@
[English document](api_en.md)

* [Common API](#common-api)
* [initPush](#initpush)
* [getRegistrationID](#getregistrationid)
* [stopPush](#stoppush)
* [resumePush](#resumepush)
Expand All @@ -24,7 +25,6 @@
* [点击推送启动应用事件](#open-notification-launch-app-event)
* [网络成功登陆事件](#network-did-login-event)
* [Android Only API](#android-only-api)
* [initPush](#initpush)
* [crashLogOFF](#crashlogoff)
* [crashLogON](#crashlogno)
* [notifyJSDidLoad](#notifyjsdidload)
Expand All @@ -37,12 +37,26 @@
* [addGetRegistrationIdListener](#addgetregistrationIdlistener)
* [removeGetRegistrationIdListener](#removegetregistrationidlistener)

注意: 在 Android 需要先调用 `initPush` 方法, iOS 端不需要
注意: 需要调用先调用 `initPush` 方法才能正常使用

### Common API

Android 和 iOS 通用 API。

#### initPush

初始化 JPush,这个方法初始化推送功能 iOS 会弹出获取推送权限的提示框(注意这个系统提示框只会触发一次,如果用户首次不同意,之后需要用户到设置中修改推送权限)。

```
JPushModule.initPush()
```

Android 建议在原生 `MainActivity``onCreate` 中调用:

```
// java 原生代码
JPushInterface.init(this);
```
#### getRegistrationID

* getRegistrationID(function)
Expand All @@ -61,20 +75,19 @@ Android 和 iOS 通用 API。
JPushModule.stopPush();
```

* #### resumePush
#### resumePush

恢复推送。建议在 `MainActivity``onResume` 中调用:
恢复推送。建议在 `MainActivity``onResume` 中调用:

```
// android native java
JPushInterface.onResume(this);
```

```
// iOS - javascirpt
JPushModule.resumePush();
```
```
// android native java
JPushInterface.onResume(this);
```

```
// iOS - javascirpt
JPushModule.resumePush();
```
#### setAlias

* setAlias(alias, successCallback)
Expand Down Expand Up @@ -365,13 +378,6 @@ JPushModule.getLaunchAppNotification( notification => {

### Android Only API

* #### initPush

初始化 JPush。建议在 `MainActivity``onCreate` 中调用:

```
JPushInterface.init(this);
```

* #### crashLogOFF

Expand Down

0 comments on commit 6b464eb

Please sign in to comment.