From bf003c84c10f1bb9b68213e197a30fa349d2db60 Mon Sep 17 00:00:00 2001
From: zhangqinghe <xd01051235@163.com>
Date: Mon, 30 Mar 2015 11:13:52 +0800
Subject: [PATCH] add registrationID in document

---
 README.md                        |  33 ++++++++++
 document/android_auto_install.md | 105 +++++++++++++++++++++++++++++++
 2 files changed, 138 insertions(+)
 create mode 100644 document/android_auto_install.md

diff --git a/README.md b/README.md
index 6cf2538..6966433 100644
--- a/README.md
+++ b/README.md
@@ -307,6 +307,39 @@
 这里只说明public的函数
 
 
+
+#### API - getRegistrationID
+
+RegistrationID 定义
+
+集成了 JPush SDK 的应用程序在第一次成功注册到 JPush 服务器时，JPush 服务器会给客户端返回一个唯一的该设备的标识 - RegistrationID。JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
+
+应用程序可以把此 RegistrationID 保存以自己的应用服务器上，然后就可以根据 RegistrationID 来向设备推送消息或者通知。
+
+
+
+##### 接口定义
+
+	JPushPlugin.prototype.getRegistrationID = function(callback)
+
+##### 参数说明
+无
+##### 返回值
+
+调用此 API 来取得应用程序对应的 RegistrationID。 只有当应用程序成功注册到 JPush 的服务器时才返回对应的值，否则返回空字符串。
+
+##### 调用示例
+
+ 	window.plugins.jPushPlugin.getRegistrationID(onGetRegistradionID);
+	var onGetRegistradionID = function(data) {
+		try{
+			console.log("JPushPlugin:registrationID is "+data)		}
+		catch(exception){
+			console.log(exception);
+		}
+	}
+
+
 #### API - setTagsWithAlias,setTags,setAlias
 
 提供几个相关 API 用来设置别名（alias）与标签（tags）。
diff --git a/document/android_auto_install.md b/document/android_auto_install.md
new file mode 100644
index 0000000..0f20299
--- /dev/null
+++ b/document/android_auto_install.md
@@ -0,0 +1,105 @@
+###Android 手工安装###
+1. 复制src/android/*.java 到cn/jpush/phonega/目录下(即：cn.jpush.phonegap的包下)
+2. 复制src/android/armeabi/libjpush.so 到lib/armeabi/
+3. 复制src/android/jpush-sdk-release1.5.0.jar 到lib/
+4. 复制src/android/test_notification_layout.xml到res/layout/
+5. 复制src/android/jpush_notification_icon.png 到res/drawable/
+6. 修改 AndroidManifest.xml 在 manifest 节点下添加以下权限
+
+		<!-- Required  一些系统要求的权限，如访问网络等-->
+		<uses-permission android:name="$PACKAGE_NAME.permission.JPUSH_MESSAGE"/>
+		<uses-permission android:name="android.permission.RECEIVE_USER_PRESENT"/>
+		<uses-permission android:name="android.permission.INTERNET"/>
+		<uses-permission android:name="android.permission.WAKE_LOCK"/>
+		<uses-permission android:name="android.permission.READ_PHONE_STATE"/>
+		<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
+		<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
+		<uses-permission android:name="android.permission.VIBRATE"/>
+		<uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/>
+		<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
+		<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW"/>
+		<permission
+		      android:name="$PACKAGE_NAME.permission.JPUSH_MESSAGE"
+		      android:protectionLevel="signature"/>
+
+7. 修改AndroidManifest.xml 在 manifest/application 节点下添加SDK相关组件声明
+
+		<activity
+			android:name="cn.jpush.android.ui.PushActivity"
+			android:theme="@android:style/Theme.Translucent.NoTitleBar"
+			android:configChanges="orientation|keyboardHidden">
+			<intent-filter>
+			<action android:name="cn.jpush.android.ui.PushActivity"/>
+			<category android:name="android.intent.category.DEFAULT"/>
+			<category android:name="$PACKAGE_NAME"/>
+			</intent-filter>
+		</activity>
+		<!-- Required  SDK核心功能-->
+		<service
+			android:name="cn.jpush.android.service.DownloadService"
+			android:enabled="true"
+			android:exported="false">
+		</service>
+		<!-- Required SDK 核心功能-->
+		<service
+			android:name="cn.jpush.android.service.PushService"
+			android:enabled="true"
+			android:exported="false">
+			<intent-filter>
+				<action android:name="cn.jpush.android.intent.REGISTER"/>
+				<action android:name="cn.jpush.android.intent.REPORT"/>
+				<action android:name="cn.jpush.android.intent.PushService"/>
+				<action android:name="cn.jpush.android.intent.PUSH_TIME"/>
+			
+			</intent-filter>
+		</service>
+		<!-- Required SDK核心功能-->
+		<receiver
+		android:name="cn.jpush.android.service.PushReceiver"
+		android:enabled="true">
+			<intent-filter android:priority="1000">
+				<action android:name="cn.jpush.android.intent.NOTIFICATION_RECEIVED_PROXY"/>
+				<!--Required  显示通知栏 -->
+				<category android:name="$PACKAGE_NAME"/>
+			</intent-filter>
+			<intent-filter>
+				<action android:name="android.intent.action.USER_PRESENT"/>
+				<action android:name="android.net.conn.CONNECTIVITY_CHANGE"/>
+			</intent-filter>
+			<!-- Optional -->
+			<intent-filter>
+				<action android:name="android.intent.action.PACKAGE_ADDED"/>
+				<action android:name="android.intent.action.PACKAGE_REMOVED"/>
+				<data android:scheme="package"/>
+			</intent-filter>
+		</receiver>
+		
+		<!-- User defined.  For test only  用户自定义的广播接收器 -->
+		<receiver
+		android:name="cn.jpush.phonegap.MyReceiver"
+		android:enabled="true">
+			<intent-filter android:priority="1000">
+				<action android:name="cn.jpush.android.intent.NOTIFICATION_RECEIVED_PROXY"/>
+				<!-- Required  显示通知栏 -->
+				<category android:name="$PACKAGE_NAME"/>
+				</intent-filter>
+			<intent-filter>
+			<action android:name="cn.jpush.android.intent.REGISTRATION"/>
+			<!-- Required  用户注册SDK的intent -->
+			<action android:name="cn.jpush.android.intent.UNREGISTRATION"/>
+			<action android:name="cn.jpush.android.intent.MESSAGE_RECEIVED"/>
+			<!-- Required  用户接收SDK消息的intent -->
+			<action android:name="cn.jpush.android.intent.NOTIFICATION_RECEIVED"/>
+			<!-- Required  用户接收SDK通知栏信息的intent -->
+			<action android:name="cn.jpush.android.intent.NOTIFICATION_OPENED"/>
+			<!-- Required  用户打开自定义通知栏的intent -->
+			<action android:name="cn.jpush.android.intent.ACTION_RICHPUSH_CALLBACK"/>
+			<!-- Optional 用户接受Rich Push Javascript 回调函数的intent -->
+			<category android:name="$PACKAGE_NAME"/>
+			</intent-filter>
+		</receiver>
+		<!-- Required SDK核心功能-->
+		<receiver android:name="cn.jpush.android.service.AlarmReceiver"/>
+		<!-- Required  . Enable it you can get statistics data with channel -->
+		<meta-data android:name="JPUSH_CHANNEL" android:value="developer-default"/>
+		<meta-data android:name="JPUSH_APPKEY" android:value="299d0fee887820e7d90a68b2"/>