mix-public 1.2.4 → 1.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/customMethod/currentPath.js +3 -1
- package/docs/02.API/BATCH_GENERATION_COMPLETE.md +4 -4
- package/docs/02.API//345/272/224/347/224/250/347/256/241/347/220/206/113-SetAccountType.md +66 -0
- package/docs/02.API//345/272/224/347/224/250/347/256/241/347/220/206/114-GetAccountType.md +62 -0
- package/docs/02.API//345/272/224/347/224/250/347/256/241/347/220/206/115-LookProtocol.md +61 -0
- package/docs/02.API//345/272/224/347/224/250/347/256/241/347/220/206/116-GetIsLookProtocol.md +71 -0
- package/docs/02.API//345/274/271/347/252/227/346/212/275/345/261/211/004-Drawer.md +2 -2
- package/main/mixappfunc.ts +5 -5
- package/package.json +1 -1
|
@@ -1 +1,3 @@
|
|
|
1
|
-
|
|
1
|
+
const path = window.location.pathname
|
|
2
|
+
const patharr = path.split('.html')[0].split('/')
|
|
3
|
+
export default !path.includes('.html') ? 'index' : patharr[patharr.length - 1]
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# API 文档批量生成完成
|
|
2
2
|
|
|
3
|
-
所有
|
|
3
|
+
所有 116 个 API 方法文档已根据 001-Goto.md 的格式标准成功生成。
|
|
4
4
|
|
|
5
5
|
## 生成完成时间
|
|
6
|
-
2026-03-
|
|
6
|
+
2026-03-25 16:44:47
|
|
7
7
|
|
|
8
8
|
## 文档统计
|
|
9
|
-
- 总文档数量:
|
|
10
|
-
- 文档范围: 001-Goto.md 到
|
|
9
|
+
- 总文档数量: 116
|
|
10
|
+
- 文档范围: 001-Goto.md 到 116-GetIsLookProtocol.md
|
|
11
11
|
- 格式标准: 参考 001-Goto.md 文档格式
|
|
12
12
|
- 内容来源: mixappfunc.ts 文件中的所有方法注释
|
|
13
13
|
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: SetAccountType
|
|
3
|
+
date: 2026-03-25
|
|
4
|
+
permalink: /api/set-account-type/
|
|
5
|
+
categories:
|
|
6
|
+
- API
|
|
7
|
+
- 应用管理
|
|
8
|
+
tags:
|
|
9
|
+
- 账户类型
|
|
10
|
+
- Cookie
|
|
11
|
+
author: mix-public
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# SetAccountType
|
|
15
|
+
|
|
16
|
+
设置账户类型并存储到Cookie中。
|
|
17
|
+
|
|
18
|
+
## 调用类型
|
|
19
|
+
同步类
|
|
20
|
+
|
|
21
|
+
## 方法说明
|
|
22
|
+
设置账户类型并存储到名为 `app_login_for_auditAccount` 的Cookie中，用于审计账户类型标识。
|
|
23
|
+
|
|
24
|
+
## 参数表格
|
|
25
|
+
|
|
26
|
+
| 参数名 | 类型 | 必填 | 说明 | 默认值 |
|
|
27
|
+
|--------|------|------|------|--------|
|
|
28
|
+
| type | string | 否 | 账户类型字符串 | "" |
|
|
29
|
+
|
|
30
|
+
## 返回值说明
|
|
31
|
+
无返回值
|
|
32
|
+
|
|
33
|
+
## 代码示例
|
|
34
|
+
|
|
35
|
+
### JavaScript
|
|
36
|
+
```javascript
|
|
37
|
+
// 设置账户类型为"normal"
|
|
38
|
+
mixPublicLib.SetAccountType("normal");
|
|
39
|
+
|
|
40
|
+
// 设置账户类型为空
|
|
41
|
+
mixPublicLib.SetAccountType("");
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### TypeScript
|
|
45
|
+
```typescript
|
|
46
|
+
// 设置账户类型为"normal"
|
|
47
|
+
mixPublicLib.SetAccountType("normal");
|
|
48
|
+
|
|
49
|
+
// 设置账户类型为空字符串
|
|
50
|
+
mixPublicLib.SetAccountType("");
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## 使用说明
|
|
54
|
+
- 该方法主要用于在登录或账户切换时设置账户类型标识
|
|
55
|
+
- 账户类型信息会被加密后存储在Cookie中
|
|
56
|
+
- 如果不传入参数或传入空字符串，则会清除账户类型标识
|
|
57
|
+
|
|
58
|
+
## 注意事项
|
|
59
|
+
- 该方法在Web、APP环境下均可使用
|
|
60
|
+
- 存储的Cookie会在浏览器关闭后失效（会话Cookie）
|
|
61
|
+
- 账户类型信息会自动进行加密处理以保证安全性
|
|
62
|
+
|
|
63
|
+
## 相关 API
|
|
64
|
+
- [GetAccountType](./114-GetAccountType.md)
|
|
65
|
+
- [PutCookieInfo](../Cookie操作/017-PutCookieInfo.md)
|
|
66
|
+
- [GetCookieInfo](../Cookie操作/018-GetCookieInfo.md)
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: GetAccountType
|
|
3
|
+
date: 2026-03-25
|
|
4
|
+
permalink: /api/get-account-type/
|
|
5
|
+
categories:
|
|
6
|
+
- API
|
|
7
|
+
- 应用管理
|
|
8
|
+
tags:
|
|
9
|
+
- 账户类型
|
|
10
|
+
- Cookie
|
|
11
|
+
author: mix-public
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# GetAccountType
|
|
15
|
+
|
|
16
|
+
获取当前账户类型。
|
|
17
|
+
|
|
18
|
+
## 调用类型
|
|
19
|
+
同步类
|
|
20
|
+
|
|
21
|
+
## 方法说明
|
|
22
|
+
从Cookie中获取名为 `app_login_for_auditAccount` 的账户类型信息，用于获取当前用户的账户类型标识。
|
|
23
|
+
|
|
24
|
+
## 参数表格
|
|
25
|
+
|
|
26
|
+
| 参数名 | 类型 | 必填 | 说明 | 默认值 |
|
|
27
|
+
|--------|------|------|------|--------|
|
|
28
|
+
| 无 | - | - | - | - |
|
|
29
|
+
|
|
30
|
+
## 返回值说明
|
|
31
|
+
string - 当前账户类型字符串，如果未设置则返回空字符串
|
|
32
|
+
|
|
33
|
+
## 代码示例
|
|
34
|
+
|
|
35
|
+
### JavaScript
|
|
36
|
+
```javascript
|
|
37
|
+
// 获取当前账户类型
|
|
38
|
+
const accountType = mixPublicLib.GetAccountType();
|
|
39
|
+
console.log("当前账户类型:", accountType);
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### TypeScript
|
|
43
|
+
```typescript
|
|
44
|
+
// 获取当前账户类型
|
|
45
|
+
const accountType: string = mixPublicLib.GetAccountType();
|
|
46
|
+
console.log("当前账户类型:", accountType);
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## 使用说明
|
|
50
|
+
- 该方法主要用于在页面加载或需要验证账户类型时获取当前账户标识
|
|
51
|
+
- 如果之前没有调用过 SetAccountType 或账户类型已被清除，则返回空字符串
|
|
52
|
+
- 返回的账户类型信息会自动进行解密处理
|
|
53
|
+
|
|
54
|
+
## 注意事项
|
|
55
|
+
- 该方法在Web、APP环境下均可使用
|
|
56
|
+
- 如果Cookie中存储的数据无法解密或格式错误，会返回空字符串
|
|
57
|
+
- 该方法是同步方法，直接返回结果无需异步处理
|
|
58
|
+
|
|
59
|
+
## 相关 API
|
|
60
|
+
- [SetAccountType](./113-SetAccountType.md)
|
|
61
|
+
- [PutCookieInfo](../Cookie操作/017-PutCookieInfo.md)
|
|
62
|
+
- [GetCookieInfo](../Cookie操作/018-GetCookieInfo.md)
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: LookProtocol
|
|
3
|
+
date: 2026-03-25
|
|
4
|
+
permalink: /api/look-protocol/
|
|
5
|
+
categories:
|
|
6
|
+
- API
|
|
7
|
+
- 应用管理
|
|
8
|
+
tags:
|
|
9
|
+
- 协议
|
|
10
|
+
- Cookie
|
|
11
|
+
- 隐私协议
|
|
12
|
+
author: mix-public
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# LookProtocol
|
|
16
|
+
|
|
17
|
+
标记用户已查看隐私协议。
|
|
18
|
+
|
|
19
|
+
## 调用类型
|
|
20
|
+
同步类
|
|
21
|
+
|
|
22
|
+
## 方法说明
|
|
23
|
+
设置名为 `IsLookProtocal` 的Cookie值为"1"，用于标记用户已经查看过隐私协议。
|
|
24
|
+
|
|
25
|
+
## 参数表格
|
|
26
|
+
|
|
27
|
+
| 参数名 | 类型 | 必填 | 说明 | 默认值 |
|
|
28
|
+
|--------|------|------|------|--------|
|
|
29
|
+
| 无 | - | - | - | - |
|
|
30
|
+
|
|
31
|
+
## 返回值说明
|
|
32
|
+
无返回值
|
|
33
|
+
|
|
34
|
+
## 代码示例
|
|
35
|
+
|
|
36
|
+
### JavaScript
|
|
37
|
+
```javascript
|
|
38
|
+
// 标记用户已查看隐私协议
|
|
39
|
+
mixPublicLib.LookProtocol();
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### TypeScript
|
|
43
|
+
```typescript
|
|
44
|
+
// 标记用户已查看隐私协议
|
|
45
|
+
mixPublicLib.LookProtocol();
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## 使用说明
|
|
49
|
+
- 该方法通常在用户点击"同意"或关闭隐私协议弹窗时调用
|
|
50
|
+
- 设置后可用于判断用户是否需要再次显示隐私协议
|
|
51
|
+
- 该标记会持久化存储在Cookie中
|
|
52
|
+
|
|
53
|
+
## 注意事项
|
|
54
|
+
- 该方法在Web、APP环境下均可使用
|
|
55
|
+
- 存储的值为字符串"1"，表示已查看协议
|
|
56
|
+
- 通常与 ClosePop 方法配合使用，在用户确认阅读协议后调用
|
|
57
|
+
|
|
58
|
+
## 相关 API
|
|
59
|
+
- [GetIsLookProtocol](./116-GetIsLookProtocol.md)
|
|
60
|
+
- [ClosePop](../页面跳转/072-ClosePop.md)
|
|
61
|
+
- [PutCookieInfo](../Cookie操作/017-PutCookieInfo.md)
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: GetIsLookProtocol
|
|
3
|
+
date: 2026-03-25
|
|
4
|
+
permalink: /api/get-is-look-protocol/
|
|
5
|
+
categories:
|
|
6
|
+
- API
|
|
7
|
+
- 应用管理
|
|
8
|
+
tags:
|
|
9
|
+
- 协议
|
|
10
|
+
- Cookie
|
|
11
|
+
- 隐私协议
|
|
12
|
+
author: mix-public
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# GetIsLookProtocol
|
|
16
|
+
|
|
17
|
+
获取用户是否已查看隐私协议的状态。
|
|
18
|
+
|
|
19
|
+
## 调用类型
|
|
20
|
+
同步类
|
|
21
|
+
|
|
22
|
+
## 方法说明
|
|
23
|
+
从Cookie中获取名为 `IsLookProtocal` 的值，用于判断用户是否已经查看过隐私协议。
|
|
24
|
+
|
|
25
|
+
## 参数表格
|
|
26
|
+
|
|
27
|
+
| 参数名 | 类型 | 必填 | 说明 | 默认值 |
|
|
28
|
+
|--------|------|------|------|--------|
|
|
29
|
+
| 无 | - | - | - | - |
|
|
30
|
+
|
|
31
|
+
## 返回值说明
|
|
32
|
+
string | boolean - 如果用户已查看协议返回"1"，否则返回空字符串或false
|
|
33
|
+
|
|
34
|
+
## 代码示例
|
|
35
|
+
|
|
36
|
+
### JavaScript
|
|
37
|
+
```javascript
|
|
38
|
+
// 获取用户是否已查看隐私协议
|
|
39
|
+
const isLooked = mixPublicLib.GetIsLookProtocol();
|
|
40
|
+
if (isLooked === "1") {
|
|
41
|
+
console.log("用户已查看隐私协议");
|
|
42
|
+
} else {
|
|
43
|
+
console.log("用户未查看隐私协议，需要显示协议弹窗");
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### TypeScript
|
|
48
|
+
```typescript
|
|
49
|
+
// 获取用户是否已查看隐私协议
|
|
50
|
+
const isLooked: string | boolean = mixPublicLib.GetIsLookProtocol();
|
|
51
|
+
if (isLooked === "1") {
|
|
52
|
+
console.log("用户已查看隐私协议");
|
|
53
|
+
} else {
|
|
54
|
+
console.log("用户未查看隐私协议，需要显示协议弹窗");
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## 使用说明
|
|
59
|
+
- 该方法通常在页面初始化时调用，用于决定是否需要显示隐私协议弹窗
|
|
60
|
+
- 如果返回值为"1"，表示用户已经查看过协议
|
|
61
|
+
- 如果返回空字符串或false，表示用户尚未查看协议
|
|
62
|
+
|
|
63
|
+
## 注意事项
|
|
64
|
+
- 该方法在Web、APP环境下均可使用
|
|
65
|
+
- 返回值类型可能是字符串或布尔值，需要进行类型检查
|
|
66
|
+
- 通常在应用启动时调用此方法来决定是否显示隐私协议
|
|
67
|
+
|
|
68
|
+
## 相关 API
|
|
69
|
+
- [LookProtocol](./115-LookProtocol.md)
|
|
70
|
+
- [ClosePop](../页面跳转/072-ClosePop.md)
|
|
71
|
+
- [GetCookieInfo](../Cookie操作/018-GetCookieInfo.md)
|
|
@@ -39,8 +39,8 @@ Drawer(option: {
|
|
|
39
39
|
|--------|------|------|------|--------|
|
|
40
40
|
| Url | string | 是 | 跳转URL | "" |
|
|
41
41
|
| ClickClose | number | 否 | 点击空白区域是否关闭（1:关闭 0：不关闭） | 0 |
|
|
42
|
-
| Width | string | number | 否 | 抽屉宽度（取值范围：0-1） |
|
|
43
|
-
| Height | string | number | 否 | 抽屉高度（取值范围：0-1） |
|
|
42
|
+
| Width | string | number | 否 | 抽屉宽度（取值范围：0-1） | 0.8 |
|
|
43
|
+
| Height | string | number | 否 | 抽屉高度（取值范围：0-1） | 0.8 |
|
|
44
44
|
| AnimationDirection | number | 否 | 抽屉展示方向（1：左，2：上，3：右，4：下） | 1 |
|
|
45
45
|
| Duration | string | 否 | 展开关闭时间（ms） | "500" |
|
|
46
46
|
| MaskColor | string | 否 | 背景遮罩颜色（透明度在前的十六进制透明色） | "#33ffff00" |
|
package/main/mixappfunc.ts
CHANGED
|
@@ -288,7 +288,7 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
|
|
|
288
288
|
* Explanation: 以抽屉效果打开新页面
|
|
289
289
|
* USE: PublicLib.Drawer({ Url:'index', ClickClose: 1, Width:'0.8', Height:'0.8', AnimationDirection: 1, Duration:'600', MaskColor:'#33FFD700' })
|
|
290
290
|
* */
|
|
291
|
-
Drawer: function (op: DrawerType = { Url: "", ClickClose: 0, Width:
|
|
291
|
+
Drawer: function (op: DrawerType = { Url: "", ClickClose: 0, Width: 0.8, Height: 0.8, AnimationDirection: 1, Duration: '500', MaskColor: '#33ffff00' }): void {
|
|
292
292
|
if (!op.Url) throw new Error("PARAM URL IS Necessary");
|
|
293
293
|
const Url = op.Url || "";
|
|
294
294
|
const ClickClose = op.ClickClose || 0;
|
|
@@ -352,14 +352,14 @@ export const mixPublicLib = (op: mixPublicLibParamsType): any => {
|
|
|
352
352
|
* }
|
|
353
353
|
* return: 无
|
|
354
354
|
* Explanation: 以弹窗显示打开新页面
|
|
355
|
-
* USE: PublicLib.PopupShow({ Url:'index', ClickClose: 1, Width:
|
|
355
|
+
* USE: PublicLib.PopupShow({ Url:'index', ClickClose: 1, Width:0.8, Height:0.5, MaskColor:'#33FFD700' })
|
|
356
356
|
* */
|
|
357
|
-
PopupShow: function (op: PopupShowType = { Url: "", ClickClose: 0, Width:
|
|
357
|
+
PopupShow: function (op: PopupShowType = { Url: "", ClickClose: 0, Width: 0.8, Height: 0.8, MaskColor: '#33ffff00' }): void {
|
|
358
358
|
if (!op.Url) throw new Error("PARAM URL IS Necessary");
|
|
359
359
|
const Url = op.Url || "";
|
|
360
360
|
const ClickClose = op.ClickClose || 0;
|
|
361
|
-
const Height = op.Height ||
|
|
362
|
-
const Width = op.Width ||
|
|
361
|
+
const Height = op.Height || 0.5;
|
|
362
|
+
const Width = op.Width || 0.8;
|
|
363
363
|
const MaskColor = op.MaskColor || "#33FFFFFF";
|
|
364
364
|
callMethod({
|
|
365
365
|
environment: this.environment,
|