ms-vite-plugin 1.5.8 → 1.5.10

package/docs/apipython/jbclear.md

@@ -0,0 +1,288 @@
+# 清理模块 (JBClear)
+
+仅越狱包可用。免越狱包没有 `jbclear`。
+
+## API 参考
+
+### keychain - 按关联名清理钥匙串。
+
+空串返回 `False`。
+
+```python
+def keychain(identifier: str) -> bool:
+```
+
+**参数:**
+
+| 参数名       | 类型 | 是否必填 | 默认值 | 描述                                   |
+| ------------ | ---- | -------- | ------ | -------------------------------------- |
+| `identifier` | str  | 是       | -      | 钥匙串关联名，例如 `"demo.sample.app"` |
+
+**返回值:**
+
+| 类型   | 描述          |
+| ------ | ------------- |
+| `bool` | 成功为 `True` |
+
+**示例:**
+
+```python
+from kuaijs import jbclear
+jbclear.keychain("demo.sample.app")
+```
+
+### allKeychain - 清理第三方应用钥匙串。
+
+不清理本 App。
+
+```python
+def allKeychain() -> bool:
+```
+
+**返回值:**
+
+| 类型   | 描述          |
+| ------ | ------------- |
+| `bool` | 成功为 `True` |
+
+**示例:**
+
+```python
+jbclear.allKeychain()
+```
+
+### cookies - 清理 Safari Cookies。
+
+```python
+def cookies() -> bool:
+```
+
+**返回值:**
+
+| 类型   | 描述          |
+| ------ | ------------- |
+| `bool` | 成功为 `True` |
+
+**示例:**
+
+```python
+jbclear.cookies()
+```
+
+### caches - 清理系统缓存。
+
+默认会重建图标缓存。传 `{"noUicache": True}` 跳过。
+
+```python
+def caches(options: dict | None = None) -> bool:
+```
+
+**参数:**
+
+| 参数名    | 类型 | 是否必填 | 默认值 | 描述                                     |
+| --------- | ---- | -------- | ------ | ---------------------------------------- |
+| `options` | dict | 否       | -      | `{"noUicache": True}` 时跳过重建图标缓存 |
+
+**返回值:**
+
+| 类型   | 描述          |
+| ------ | ------------- |
+| `bool` | 成功为 `True` |
+
+**示例:**
+
+```python
+jbclear.caches()
+jbclear.caches({"noUicache": True})
+```
+
+### photos - 删除本机相册里的本地照片。
+
+不影响 iCloud 照片。
+
+```python
+def photos() -> bool:
+```
+
+**返回值:**
+
+| 类型   | 描述          |
+| ------ | ------------- |
+| `bool` | 成功为 `True` |
+
+**示例:**
+
+```python
+jbclear.photos()
+```
+
+### appData - 清理指定应用的本地数据，不卸载应用。
+
+先结束该应用进程，再清数据容器、App Group、扩展数据容器，以及该应用钥匙串。不卸载。空包名或本 App 及其扩展返回 `False`。
+
+```python
+def appData(bundleId: str) -> bool:
+```
+
+**参数:**
+
+| 参数名     | 类型 | 是否必填 | 默认值 | 描述                                   |
+| ---------- | ---- | -------- | ------ | -------------------------------------- |
+| `bundleId` | str  | 是       | -      | 应用包标识符，例如 `"demo.sample.app"` |
+
+**返回值:**
+
+| 类型   | 描述          |
+| ------ | ------------- |
+| `bool` | 成功为 `True` |
+
+**示例:**
+
+```python
+jbclear.appData("demo.sample.app")
+```
+
+### getIdfa - 读取整机广告标识（IDFA）。
+
+```python
+def getIdfa() -> str | None:
+```
+
+**返回值:**
+
+| 类型          | 描述                           |
+| ------------- | ------------------------------ |
+| `str \| None` | UUID 字符串；读不到返回 `None` |
+
+**示例:**
+
+```python
+idfa = jbclear.getIdfa()
+```
+
+### resetIdfa - 重置整机广告标识（IDFA）。
+
+之后所有 App 读到的 IDFA 都会变。
+
+```python
+def resetIdfa() -> str | None:
+```
+
+**返回值:**
+
+| 类型          | 描述                           |
+| ------------- | ------------------------------ |
+| `str \| None` | 重置前的 UUID；失败返回 `None` |
+
+**示例:**
+
+```python
+old = jbclear.resetIdfa()
+if old:
+    file.writeFile("idfa.txt", old)
+```
+
+### setIdfa - 写入整机广告标识（IDFA）。
+
+```python
+def setIdfa(value: str) -> str | None:
+```
+
+**参数:**
+
+| 参数名  | 类型 | 是否必填 | 默认值 | 描述                                |
+| ------- | ---- | -------- | ------ | ----------------------------------- |
+| `value` | str  | 是       | -      | `getIdfa` / `resetIdfa` 返回的 UUID |
+
+**返回值:**
+
+| 类型          | 描述                           |
+| ------------- | ------------------------------ |
+| `str \| None` | 写入前的 UUID；失败返回 `None` |
+
+**示例:**
+
+```python
+old = file.readFile("idfa.txt")
+if old:
+    jbclear.setIdfa(old)
+```
+
+### getIdfv - 读取指定应用所属开发商的 IDFV。
+
+```python
+def getIdfv(bundleId: str) -> str | None:
+```
+
+**参数:**
+
+| 参数名     | 类型 | 是否必填 | 默认值 | 描述                                   |
+| ---------- | ---- | -------- | ------ | -------------------------------------- |
+| `bundleId` | str  | 是       | -      | 应用包标识符，例如 `"demo.sample.app"` |
+
+**返回值:**
+
+| 类型          | 描述                           |
+| ------------- | ------------------------------ |
+| `str \| None` | UUID 字符串；读不到返回 `None` |
+
+**示例:**
+
+```python
+idfv = jbclear.getIdfv("demo.sample.app")
+```
+
+### resetIdfv - 重置指定应用所属开发商的 IDFV。
+
+同一开发商的 App 会一起变。
+
+```python
+def resetIdfv(bundleId: str) -> str | None:
+```
+
+**参数:**
+
+| 参数名     | 类型 | 是否必填 | 默认值 | 描述                                   |
+| ---------- | ---- | -------- | ------ | -------------------------------------- |
+| `bundleId` | str  | 是       | -      | 应用包标识符，例如 `"demo.sample.app"` |
+
+**返回值:**
+
+| 类型          | 描述                           |
+| ------------- | ------------------------------ |
+| `str \| None` | 重置前的 UUID；失败返回 `None` |
+
+**示例:**
+
+```python
+old = jbclear.resetIdfv("demo.sample.app")
+if old:
+    file.writeFile("idfv.txt", old)
+```
+
+### setIdfv - 写入指定应用所属开发商的 IDFV。
+
+```python
+def setIdfv(bundleId: str, value: str) -> str | None:
+```
+
+**参数:**
+
+| 参数名     | 类型 | 是否必填 | 默认值 | 描述                                   |
+| ---------- | ---- | -------- | ------ | -------------------------------------- |
+| `bundleId` | str  | 是       | -      | 应用包标识符，例如 `"demo.sample.app"` |
+| `value`    | str  | 是       | -      | `getIdfv` / `resetIdfv` 返回的 UUID    |
+
+**返回值:**
+
+| 类型          | 描述                           |
+| ------------- | ------------------------------ |
+| `str \| None` | 写入前的 UUID；失败返回 `None` |
+
+**示例:**
+
+```python
+old = file.readFile("idfv.txt")
+if old:
+    jbclear.setIdfv("demo.sample.app", old)
+```