From 66ebb8e03b90575e370b387e92dd29a1337c7817 Mon Sep 17 00:00:00 2001
From: Hevin <liuhw@jpush.cn>
Date: Thu, 19 Oct 2017 14:05:13 +0800
Subject: [PATCH 1/2] Add common API doc
---
README.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/README.md b/README.md
index f8e27d9..4a81afe 100644
--- a/README.md
+++ b/README.md
@@ -138,6 +138,8 @@
## API 说明
+Android 与 iOS [通用 API](/Doc/CommonAPI.md)。
+
### Android
在 Plugins\Android\src 目录下是一些 Java 文件，可以将其引入到 Android 工程中对其进行扩展，重新生成 Jar 包替换掉工程中 Assets\Plugins\Android 目录下的 JPush_Bridge.jar 文件。
From 423d42cdcdc463577ecf01889b0056ed27108906 Mon Sep 17 00:00:00 2001
From: Hevin <liuhw@jpush.cn>
Date: Thu, 19 Oct 2017 14:10:47 +0800
Subject: [PATCH 2/2] Add doc of CommonAPI.md
---
Doc/CommonAPI.md | 43 ++++++++++++++++++++++++++++++++-----------
1 file changed, 32 insertions(+), 11 deletions(-)
diff --git a/Doc/CommonAPI.md b/Doc/CommonAPI.md
index 86c3a23..954c49a 100644
--- a/Doc/CommonAPI.md
+++ b/Doc/CommonAPI.md
@@ -2,6 +2,27 @@
以下除事件监听之外的方法都基于 `JPushBinding` 对象进行调用。
+- [初始化与调试](#初始化与调试)
+ - [Init(string gameObject)](#initstring-gameobject)
+ - [SetDebug(bool enable)](#setdebugbool-enable)
+ - [GetRegistrationId()](#getregistrationid)
+- [标签与别名](#标签与别名)
+ - [SetTags(int sequence, List<string> tags)](#settagsint-sequence-liststring-tags)
+ - [AddTags(int sequence, List<string> tags)](#addtagsint-sequence-liststring-tags)
+ - [DeleteTags(int sequence, List<string> tags)](#deletetagsint-sequence-liststring-tags)
+ - [CleanTags(int sequence)](#cleantagsint-sequence)
+ - [GetAllTags(int sequence)](#getalltagsint-sequence)
+ - [CheckTagBindState(int sequence, string tag)](#checktagbindstateint-sequence-string-tag)
+ - [SetAlias(int sequence, string alias)](#setaliasint-sequence-string-alias)
+ - [DeleteAlias(int sequence)](#deletealiasint-sequence)
+ - [GetAlias(int sequence)](#getaliasint-sequence)
+- [事件监听](#事件监听)
+ - [OnReceiveNotification(string notification)](#onreceivenotificationstring-notification)
+ - [OnReceiveMessage(string msg)](#onreceivemessagestring-msg)
+ - [OnOpenNotification(string notification)](#onopennotificationstring-notification)
+ - [OnJPushTagOperateResult(result)](#onjpushtagoperateresultresult)
+ - [OnJPushAliasOperateResult(result)](#onjpushaliasoperateresultresult)
+
## 初始化与调试
### Init(string gameObject)
@@ -131,7 +152,7 @@
Android 的通知内容格式为：
-```json
+```text
{
"title": "通知标题",
"content": "通知内容",
@@ -143,7 +164,7 @@ Android 的通知内容格式为：
iOS 的通知内容格式为：
-```json
+```text
{
"aps":{
"alert":"通知内容",
@@ -168,7 +189,7 @@ iOS 的通知内容格式为：
Android 的通知内容格式为：
-```json
+```text
{
"message": "自定义消息内容",
"extras": { // 自定义键值对
@@ -180,12 +201,12 @@ Android 的通知内容格式为：
iOS 的自定义消息内容格式为：
-```json
+```text
{
- "content":"自定义消息内容"，
+ "content": "自定义消息内容",
"extras": { // 自定义键值对
- "key1":"value1",
- "key2":"value2"
+ "key1": "value1",
+ "key2": "value2"
}
}
```
@@ -200,7 +221,7 @@ iOS 的自定义消息内容格式为：
Android 的通知内容格式为：
-```json
+```text
{
"message": "自定义消息内容",
"extras": { // 自定义键值对
@@ -212,7 +233,7 @@ Android 的通知内容格式为：
iOS 的通知内容格式为：
-```json
+```text
{
"aps":{
"alert":"通知内容",
@@ -235,7 +256,7 @@ JPush 的标签相关操作回调。
- result: Json 格式字符串。格式为：
-```json
+```text
{
"sequence": 1, // 调用标签或别名方法时传入的。
"code": 0, // 结果码。0：成功；其他：失败（详细说明可参见官网文档）。
@@ -252,7 +273,7 @@ JPush 的别名相关操作回调。
- result: Json 格式字符串。格式为：
-```json
+```text
{
"sequence": 1, // 调用标签或别名方法时传入的。
"code": 0, // 结果码。0：成功；其他：失败（详细说明可参见官网文档）。