update iOS_API.md

Author: huangminlinux

example/documents/iOS_API.md

@@ -2,68 +2,65 @@
 
 All apis can find in jpush-react-native/index.js.
 
-- setBadge(badge, cb)
+- setBadge(Int, Function)
 
 设置 badge 值
-```
+```javascript
 JPushModule.setBadge(5, (success) => {
   console.log(success)
 });
 ```
-
-- setLocalNotification( date,
-         textContain,     // date
-         badge,           // int
-         alertAction,     // String
-         notificationKey, // String
-         userInfo,   // Dictionary
-         soundName   // String
+- setLocalNotification
+```javascript
+setLocalNotification(  Date,    		// date  触发本地推送的时间
+                       textContain,     // String 推送消息体内容
+                       badge,           // int   本地推送触发后 应用 Badge（小红点）显示的数字
+                       alertAction,     // String 弹框的按钮显示的内容（IOS 8默认为"打开", 其他默认为"启动"）
+                       notificationKey, // String 本地推送标示符
+                       userInfo,   		// Object 推送的附加字段 (任意键值对)
+                       soundName   		// String 自定义通知声音，设置为 null 为默认声音
          )
 
 设置本地推送
 ```
+```javascript
   JPushModule.setLocalNotification( this.state.date, 
                                     this.state.textContain,
                                     5, 
-                                    'dfsa',
-                                    'dfaas',
-                                    null,
+                                    'Action',
+                                    'notificationIdentify',
+                                    {myInfo: ""},
                                     null);
 ```
 
 ## 事件
-监听 `ReceiveNotification` 事件，收到到推送的时候会回调
-```
-var subscription = NativeAppEventEmitter.addListener(
-  'ReceiveNotification',
-  (notification) => console.log(notification)
-);
-```
+- addOpenNotificationLaunchAppListener(Function) 
 
-监听 `OpenNotificationToLaunchApp` 事件，点击推送**启动 App **的时候会触发这个事件
+  监听：应用没有启动的状态点击推送打开应用
 
-```
-var subscription = NativeAppEventEmitter.addListener(
-  'OpenNotificationToLaunchApp',
-  (notification) => console.log(notification)
-);
-```
+  ```javascript
+    JPushModule.addOpenNotificationLaunchAppListener( (notification) => {
+      
+    })
+  ```
 
+- removeOpenNotificationLaunchAppListener(Function)  
 
+  取消监听：应用没有启动的状态点击推送打开应用，和 `addOpenNotificationLaunchAppListener` 成对使用
 
-监听 `OpenNotification` 事件，点击推送的时候会执行这个回调(注意：iOS10 才开始触发这个事件)
+  ​
 
-```
-var subscription = NativeAppEventEmitter.addListener(
-  'OpenNotification',
-  (notification) => console.log(notification)
-);
-```
 
-监听 `networkDidReceiveMessage` 事件，收到 JPush 应用内消息会执行这个回调
-```
-var subscription = NativeAppEventEmitter.addListener(
-  'networkDidReceiveMessage',
-  (message) => console.log(message)
-);
-```
+- addnetworkDidLoginListener(Function)
+
+  监听：应用连接已登录，setTag 和 setAlias 相关操作需要在这个事件触发后才能起作用
+
+  ```javascript
+  JPushModule.addnetworkDidLoginListener( () => {
+      
+    })
+  ```
+
+- removenetworkDidLoginListener(Function)
+
+  取消监听：应用连接已登录，和 `addnetworkDidLoginListener` 成对使用

index.js

@@ -53,48 +53,59 @@ export default class JPush {
 	}
 
 	/**
-	 * Android
+	 * Android Only
 	 */
 	static stopPush() {
 		JPushModule.stopPush();
 	}
 
 	/**
-	 * Android
+	 * Android Only
 	 */
 	static resumePush() {
 		JPushModule.resumePush();
 	}
 
+	/**
+	 * Android Only
+	 * 
+	 * @param {Function} cb 
+	 */
 	static notifyJSDidLoad(cb) {
 		JPushModule.notifyJSDidLoad((resultCode) => {
 			cb(resultCode);
 		});
 	}
 
 	/**
-	 * Android
+	 * Android Only
 	 */
 	static clearAllNotifications() {
 		JPushModule.clearAllNotifications();
 	}
 
 	/**
-	 * Android
+	 * Android Only
 	 */
 	static clearNotificationById(id) {
 		JPushModule.clearNotificationById(id);
 	}
 
 	/**
-	 * Android
+	 * Android Only
 	 */
 	static getInfo(cb) {
 		JPushModule.getInfo((map) => {
 			cb(map);
 		});
 	}
 
+	/**
+	 * 获取当前连接状态
+	 * @param {Fucntion} cb = (Boolean) => {}
+	 * 如果连接状态变更为已连接返回 true
+	 * 如果连接状态变更为断开连接连接返回 false
+	 */
 	static getConnectionState(cb) {
 		JPushModule.getConnectionState((state) => {
 			cb(state);
@@ -230,7 +241,7 @@ export default class JPush {
 	}
 
 	/**
-	 * Android
+	 * Android Only
 	 */
 	static setStyleBasic() {
 		JPushModule.setStyleBasic();
@@ -258,7 +269,7 @@ export default class JPush {
 	}
 
 	/**
-	 * 监听自定义消息后事件
+	 * 监听：自定义消息后事件
 	 * @param {Function} cb = (Object) => { } 
 	 */
 	static addReceiveCustomMsgListener(cb) {
@@ -269,7 +280,7 @@ export default class JPush {
 	}
 
 	/**
-	 * 取消监听自定义消息后事件
+	 * 取消监听：自定义消息后事件
 	 * @param {Function} cb = (Object) => { } 
 	 */
 	static removeReceiveCustomMsgListener(cb) {
@@ -282,6 +293,7 @@ export default class JPush {
 
 	/**
 	 * iOS Only
+	 * 监听：应用没有启动的状态点击推送打开应用
 	 * @param {Function} cb = (notification) => {}
 	 */
 	static addOpenNotificationLaunchAppListener(cb) {
@@ -293,6 +305,7 @@ export default class JPush {
 
 	/**
 	 * iOS Only
+	 * 取消监听：应用没有启动的状态点击推送打开应用
 	 * @param {Function} cb = () => {}
 	 */
 	static removeOpenNotificationLaunchAppEventListener(cb) {
@@ -306,7 +319,7 @@ export default class JPush {
 	/**
 	 * iOS Only
 	 * 
-	 * 监听应用连接已登录
+	 * 监听：应用连接已登录
 	 * @param {Function} cb = () => {}
 	 */
 	static addnetworkDidLoginListener(cb) {
@@ -319,7 +332,7 @@ export default class JPush {
 	/**
 	 * iOS Only
 	 * 
-	 * 取消监听应用连接已登录
+	 * 取消监听：应用连接已登录
 	 * @param {Function} cb = () => {}
 	 */
 	static removenetworkDidLoginListener(cb) {
@@ -331,7 +344,7 @@ export default class JPush {
 	}
 
 	/**
-	 * 监听接收推送事件
+	 * 监听：接收推送事件
 	 * @param {} cb = (Object）=> {}
 	 */
 	static addReceiveNotificationListener(cb) {
@@ -342,7 +355,7 @@ export default class JPush {
 	}
 
 	/**
-	 * 取消监听接收推送事件
+	 * 取消监听：接收推送事件
 	 * @param {Function} cb = (Object）=> {}
 	 */
 	static removeReceiveNotificationListener(cb) {
@@ -354,7 +367,7 @@ export default class JPush {
 	}
 
 	/**
-	 * 监听点击推送事件
+	 * 监听：点击推送事件
 	 * @param {Function} cb  = (Object）=> {}
 	 */
 	static addReceiveOpenNotificationListener(cb) {
@@ -365,7 +378,7 @@ export default class JPush {
 	}
 
 	/**
-	 * 取消监听点击推送事件
+	 * 取消监听：点击推送事件
 	 * @param {Function} cb  = (Object）=> {}
 	 */
 	static removeReceiveOpenNotificationListener(cb) {
@@ -400,7 +413,7 @@ export default class JPush {
 	}
 
 	/**
-	 * 监听连接状态变更
+	 * 监听：连接状态变更
 	 * @param {Function} cb = (Boolean) => { }
 	 * 如果连接状态变更为已连接返回 true
 	 * 如果连接状态变更为断开连接连接返回 false
@@ -412,6 +425,12 @@ export default class JPush {
 			});
 	}
 
+	/**
+	 * 监听：连接状态变更
+	 * @param {Function} cb = (Boolean) => { }
+	 * 如果连接状态变更为已连接返回 true
+	 * 如果连接状态变更为断开连接连接返回 false
+	 */
 	static removeConnectionChangeListener(cb) {
 		if (!listeners[cb]) {
 			return;
@@ -422,7 +441,7 @@ export default class JPush {
 
 
 	/**
-	 * 
+	 * 获取 RegistrationId 
 	 * @param {Function} cb = (String) => { }
 	 */
 	static getRegistrationID(cb) {
@@ -450,7 +469,6 @@ export default class JPush {
 		});
 	}
 
-
 	/**
 	 * iOS Only
 	 * 设置本地推送