Skip to content

Commit bed5d01

Browse files
authored
Update README.md
1 parent 6a4c806 commit bed5d01

1 file changed

Lines changed: 29 additions & 18 deletions

File tree

README.md

Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -40,35 +40,37 @@
4040
- 然后调用 `iOSNative` 类中的[方法或其子类中的方法](#子类功能介绍)即可
4141

4242

43-
## 模块介绍
43+
## 原生代码介绍
4444

4545
| 模块名 | 功能 |
4646
|--------------------------|----------------------------------------|
47-
| `iOSNative.cs` | 插件与UnityC#项目的接口,调用里面的方法可以实现与iOS的OC代码交互 |
48-
| `iOSCallbackHelper.cs` | 用于接收从OC代码中的回调 |
49-
| `iOSNative.h` | 头文件,本Native插件的所有类的声明以及公开方法都在这里面 |
50-
| `iOSNative.mm` | 负责将插件的方法暴露给UnityC#端以进行交互 |
51-
| `iCloudKeyValueStore.mm` | 负责iCloud相关功能的实现 |
52-
| `Device.mm` | 负责 iPhone 设备相关功能的实现 |
53-
| `Notification.mm` | 负责 iOS 本地通知推送的实现 |
54-
| `NativeShare.mm` | 负责 iOS 自带的分享功能的实现 |
55-
| `NativeUI.mm` | 包含部分 iOS Native UI的功能(比如应用内显示/隐藏状态栏) |
56-
| `Utils.cs` | cs辅助文件,包含了enum、struct以及delegate等声明 |
47+
| `iOSNative.h` | 头文件 |
48+
| `iOSApplication.mm` | iOS应用相关 |
49+
| `iCloudKeyValueStore.mm` | iCloud相关功能 |
50+
| `Device.mm` | iPhone 设备相关 |
51+
| `Notification.mm` | iOS 本地通知推送 |
52+
| `NativeShare.mm` | iOS 自带的分享文件功能 |
53+
| `NativeUI.mm` | 原生UI相关 |
5754
| `Utils.mm` | OC辅助文件,包含了typedef、静态函数等声明 |
55+
| `ExternC.mm` | 负责将插件的方法暴露给UnityC#端以进行交互 |
5856

59-
## 子类/功能介绍
57+
## C#类/功能介绍
6058

6159
> 方法名前标有星号 “*” 表示该方法尚未经测试,可用性未知
6260
6361
> 在调用插件方法之前先调用 `Initialize` 方法进行插件初始化
6462
65-
### 父类 - iOSNative
63+
### iOSApplication
64+
65+
> iOS应用相关功能
6666
6767
| 方法 | 功能 |
6868
|-------------------------|--------------------------|
6969
| `GetBundleIdentifier()` | 获取当前应用的Bundle Identifier |
7070

71-
### 子类 - iOSNative.iCloudKeyValueStore
71+
### iCloudKeyValueStore
72+
73+
> iCloud相关功能
7274
7375
| 方法 | 功能 |
7476
|---------------------------|----------------------------------------|
@@ -85,7 +87,9 @@
8587
| `iCloudSaveFloatValue()` | 保存Float值到iCloud |
8688
| `iCloudSaveBoolValue()` | 保存Bool值到iCloud |
8789

88-
### 子类 - iOSNative.Notification
90+
### Notification
91+
92+
> iOS 本地通知推送
8993
9094
| 方法 | 功能 |
9195
|-----------------------------------|-----------------------|
@@ -94,7 +98,10 @@
9498
| `RemovePendingNotifications()` | 移除某个待定通知(对于已经推送的通知无效) |
9599
| `RemoveAllPendingNotifications()` | 移除所有待定通知 |
96100

97-
### 子类 - iOSNative.NativeUI
101+
### NativeUI
102+
103+
> 原生UI相关
104+
98105
| 事件 | 功能 |
99106
|------------------------|-----------------------------------------|
100107
| `OnStatusBarOrientationChanged` | UI朝向变更事件 |
@@ -111,7 +118,9 @@
111118
| `SetStatusBarStyle()` | 设置状态栏的样式(白色、黑色、自动) |
112119
| `ShowTempAlert()` | 在应用内顶部展示一个内容为alertString,时长duration秒的横幅 |
113120

114-
### 子类 - iOSNative.Device
121+
### Device
122+
123+
> iPhone 设备相关
115124
116125
| 方法 | 功能 |
117126
|-------------------------|-----------------------------------|
@@ -123,7 +132,9 @@
123132
| * `PlayHaptics()` | 震动 |
124133
| `GetCountryCode()` | 获取当前设备的ISO地区码(ISO 3166-1 alpha-2) |
125134

126-
### 子类 - iOSNative.NativeShare
135+
### NativeShare
136+
137+
> iOS 分享文件功能
127138
128139
| 方法 | 功能 |
129140
|----------------------|---------------------------|

0 commit comments

Comments
 (0)