@ray-js/api 1.6.0-beta.9 → 1.6.1

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.
Files changed (84) hide show
  1. package/@types/BaseKit.d.ts +837 -37
  2. package/@types/BizKit.d.ts +1831 -85
  3. package/@types/DeviceKit.d.ts +581 -58
  4. package/@types/HomeKit.d.ts +0 -74
  5. package/@types/MiniKit.d.ts +411 -8
  6. package/@types/api-cloud.d.ts +145 -0
  7. package/@types/api-extend.d.ts +42 -10
  8. package/@types/api.d.ts +4 -0
  9. package/@types/energy.d.ts +250 -0
  10. package/@types/gateway.d.ts +146 -0
  11. package/@types/health.d.ts +309 -0
  12. package/lib/{BaseKit-3.11.0.d.ts → BaseKit-3.14.3.d.ts} +29 -1
  13. package/lib/{BaseKit-3.11.0.js → BaseKit-3.14.3.js} +32 -1
  14. package/lib/BizKit-4.10.4.d.ts +84 -0
  15. package/lib/{BizKit-3.2.7.js → BizKit-4.10.4.js} +46 -5
  16. package/lib/{DeviceKit-3.3.1.d.ts → DeviceKit-4.9.0.d.ts} +22 -1
  17. package/lib/{DeviceKit-3.3.1.js → DeviceKit-4.9.0.js} +66 -0
  18. package/lib/HomeKit-3.1.4.d.ts +0 -1
  19. package/lib/MapKit-3.4.13.d.ts +0 -1
  20. package/lib/{MiniKit-3.1.0.d.ts → MiniKit-3.12.1.d.ts} +11 -1
  21. package/lib/{MiniKit-3.1.0.js → MiniKit-3.12.1.js} +12 -1
  22. package/lib/OutdoorKit-1.0.4.d.ts +0 -1
  23. package/lib/P2PKit-2.0.3.d.ts +0 -1
  24. package/lib/PlayNetKit-1.1.3.d.ts +24 -24
  25. package/lib/all-kits.d.ts +5 -5
  26. package/lib/all-kits.js +5 -5
  27. package/lib/cloud/device.d.ts +3 -3
  28. package/lib/cloud/energy.d.ts +15 -0
  29. package/lib/cloud/energy.js +55 -0
  30. package/lib/cloud/gateway.d.ts +11 -0
  31. package/lib/cloud/gateway.js +39 -0
  32. package/lib/cloud/health.d.ts +19 -0
  33. package/lib/cloud/health.js +71 -0
  34. package/lib/cloud/index.d.ts +4 -0
  35. package/lib/cloud/index.js +7 -1
  36. package/lib/cloud/interface.d.ts +40 -1
  37. package/lib/cloud/laser-clean/index.d.ts +3 -0
  38. package/lib/cloud/laser-clean/index.js +3 -0
  39. package/lib/cloud/laser-clean/map.d.ts +3 -0
  40. package/lib/cloud/laser-clean/map.js +4 -0
  41. package/lib/cloud/laser-clean/record.d.ts +3 -0
  42. package/lib/cloud/laser-clean/record.js +4 -0
  43. package/lib/cloud/laser-clean/voice.d.ts +2 -0
  44. package/lib/cloud/laser-clean/voice.js +3 -0
  45. package/lib/cloud/recipe/basket.js +1 -0
  46. package/lib/cloud/recipe/custom.js +1 -0
  47. package/lib/cloud/recipe/menu.js +1 -0
  48. package/lib/cloud/recipe/query.js +1 -0
  49. package/lib/cloud/recipe/score.js +1 -0
  50. package/lib/cloud/recipe/star.js +1 -0
  51. package/lib/getBoundingClientRect/index.thing.js +1 -0
  52. package/lib/getBoundingClientRect/index.wechat.js +1 -0
  53. package/lib/getCdnUrl/index.thing.js +22 -18
  54. package/lib/hideTabBar/index.d.ts +4 -5
  55. package/lib/index.d.ts +0 -1
  56. package/lib/navigateBack/index.d.ts +0 -1
  57. package/lib/navigateTo/index.d.ts +0 -1
  58. package/lib/panel/devInfo/index.js +7 -1
  59. package/lib/panel/i18n/index.js +4 -0
  60. package/lib/panel/i18n/index.wechat.js +4 -0
  61. package/lib/panel/publishDps.js +2 -0
  62. package/lib/reLaunch/index.d.ts +0 -1
  63. package/lib/redirectTo/index.d.ts +0 -1
  64. package/lib/redirectTo/index.js +1 -0
  65. package/lib/requestCloud/index.d.ts +0 -1
  66. package/lib/setNavigationBarColor/index.d.ts +0 -1
  67. package/lib/setNavigationBarTitle/index.d.ts +0 -1
  68. package/lib/showTabBar/index.d.ts +4 -5
  69. package/lib/switchTab/index.d.ts +0 -1
  70. package/lib/utils.wechat.js +1 -0
  71. package/lib/viewAPI.d.ts +1 -1
  72. package/lib/viewAPI.js +2 -1
  73. package/package.json +8 -8
  74. package/lib/BizKit-3.2.7.d.ts +0 -46
  75. package/lib/cloud/doorlock/README.md +0 -62
  76. package/lib/cloud/doorlock/auth.md +0 -323
  77. package/lib/cloud/doorlock/device.md +0 -265
  78. package/lib/cloud/doorlock/log.md +0 -153
  79. package/lib/cloud/doorlock/member-opmode.md +0 -279
  80. package/lib/cloud/doorlock/member.md +0 -276
  81. package/lib/cloud/doorlock/offline-pwd.md +0 -155
  82. package/lib/cloud/doorlock/temp-pwd.md +0 -362
  83. package/lib/cloud/doorlock/unlock-method.md +0 -121
  84. package/lib/cloud/doorlock/unlock.md +0 -222
@@ -1,3 +1,2 @@
1
- /// <reference path="../../@types/api.d.ts" />
2
1
  declare const navigateTo: typeof ty.navigateTo;
3
2
  export default navigateTo;
@@ -1,4 +1,6 @@
1
1
  import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
2
+ import "core-js/modules/esnext.iterator.constructor.js";
3
+ import "core-js/modules/esnext.iterator.for-each.js";
2
4
  import { getDeviceInfo, getLaunchOptionsSync, getGroupInfo, registerDeviceListListener, registerGroupChange, exitMiniProgram, subscribeDeviceRemoved, onDeviceRemoved } from '../../all-kits';
3
5
  import { useEffect } from 'react';
4
6
  import getApp from '../../getApp';
@@ -166,11 +168,15 @@ export async function initPanelEnvironment() {
166
168
  initPanel(getLaunchOptionsSync());
167
169
  }, 3000);
168
170
  // 基础库版本需要大于 2.6.0
171
+
172
+ // @ts-ignore
173
+ const __AppOnReady = App.onReady;
169
174
  // @ts-ignore
170
175
  App.onReady = event => {
176
+ typeof __AppOnReady === 'function' && __AppOnReady(event);
171
177
  init = true;
172
178
  clearTimeout(timeout);
173
- initPanel(event);
179
+ initPanel(getLaunchOptionsSync());
174
180
  };
175
181
 
176
182
  // 使用 Promise 确保业务可以通过 initPanelEnvironment 的正常调用明确设备信息初始化完成
@@ -1,4 +1,8 @@
1
+ import "core-js/modules/es.regexp.constructor.js";
2
+ import "core-js/modules/es.regexp.dot-all.js";
3
+ import "core-js/modules/es.regexp.exec.js";
1
4
  import "core-js/modules/es.string.replace.js";
5
+ import "core-js/modules/esnext.iterator.map.js";
2
6
  import { requestCloud, getSystemInfoSync, THING } from '../..';
3
7
  import { getBitValue } from '../utils';
4
8
 
@@ -1,4 +1,8 @@
1
+ import "core-js/modules/es.regexp.constructor.js";
2
+ import "core-js/modules/es.regexp.dot-all.js";
3
+ import "core-js/modules/es.regexp.exec.js";
1
4
  import "core-js/modules/es.string.replace.js";
5
+ import "core-js/modules/esnext.iterator.map.js";
2
6
  import { requestCloud, getSystemInfoSync, THING } from '../..';
3
7
  import { getBitValue } from '../utils';
4
8
 
@@ -1,4 +1,6 @@
1
1
  import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
2
+ import "core-js/modules/esnext.iterator.constructor.js";
3
+ import "core-js/modules/esnext.iterator.for-each.js";
2
4
  import { publishDpsBase } from '../..';
3
5
  import { getDevInfo } from './devInfo';
4
6
  const DEFAULT_OPTIONS = {
@@ -1,3 +1,2 @@
1
- /// <reference path="../../@types/api.d.ts" />
2
1
  declare const reLaunch: typeof ty.reLaunch;
3
2
  export default reLaunch;
@@ -1,3 +1,2 @@
1
- /// <reference path="../../@types/api.d.ts" />
2
1
  declare const redirectTo: typeof ty.redirectTo;
3
2
  export default redirectTo;
@@ -1,3 +1,4 @@
1
+ import "core-js/modules/es.regexp.exec.js";
1
2
  import "core-js/modules/es.string.replace.js";
2
3
  /// <reference path="../../@types/api.d.ts" />
3
4
 
@@ -1,3 +1,2 @@
1
- /// <reference path="../../@types/api.d.ts" />
2
1
  declare const requestCloud: typeof ty.requestCloud;
3
2
  export default requestCloud;
@@ -1,3 +1,2 @@
1
- /// <reference path="../../@types/api.d.ts" />
2
1
  declare const _default: typeof ty.setNavigationBarColor;
3
2
  export default _default;
@@ -1,3 +1,2 @@
1
- /// <reference path="../../@types/api.d.ts" />
2
1
  declare const _default: typeof ty.setNavigationBarTitle;
3
2
  export default _default;
@@ -1,9 +1,8 @@
1
- /// <reference path="../../@types/api.d.ts" />
2
1
  declare const _default: (arg?: {
3
- animation?: boolean | undefined;
2
+ animation?: boolean;
4
3
  } & {
5
- success?: ((S?: any) => void) | undefined;
6
- fail?: ((F?: any) => void) | undefined;
7
- complete?: ((C?: any) => void) | undefined;
4
+ success?: (S?: any) => void;
5
+ fail?: (F?: any) => void;
6
+ complete?: (C?: any) => void;
8
7
  } & import("../core").PromisifyArgs<any, any>) => Promise<any>;
9
8
  export default _default;
@@ -1,3 +1,2 @@
1
- /// <reference path="../../@types/api.d.ts" />
2
1
  declare const _default: typeof ty.switchTab;
3
2
  export default _default;
@@ -1,3 +1,4 @@
1
+ import "core-js/modules/es.regexp.exec.js";
1
2
  // @ts-ignore
2
3
  import * as tyWx from '@ray-js/wechat';
3
4
  import { stringifyUrl as _stringifyUrl, parseUrl as _parseUrl } from 'query-string';
package/lib/viewAPI.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- /// <reference path="../@types/api.d.ts" />
2
1
  export declare const env: ty.env;
3
2
  export declare const createAnimation: typeof ty.createAnimation;
4
3
  export declare const pageScrollTo: typeof ty.pageScrollTo;
@@ -13,3 +12,4 @@ export declare const createMapContext: typeof ty.createMapContext;
13
12
  export declare const createIpcPlayerContext: typeof ty.createIpcPlayerContext;
14
13
  export declare const createCameraContext: typeof ty.createCameraContext;
15
14
  export declare const createWebviewContext: typeof ty.createWebviewContext;
15
+ export declare const connectSocket: typeof ty.connectSocket;
package/lib/viewAPI.js CHANGED
@@ -14,4 +14,5 @@ export const createNativeVideoContext = factory('createNativeVideoContext');
14
14
  export const createMapContext = factory('createMapContext');
15
15
  export const createIpcPlayerContext = factory('createIpcPlayerContext');
16
16
  export const createCameraContext = factory('createCameraContext');
17
- export const createWebviewContext = factory('createWebviewContext');
17
+ export const createWebviewContext = factory('createWebviewContext');
18
+ export const connectSocket = factory('connectSocket');
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ray-js/api",
3
- "version": "1.6.0-beta.9",
3
+ "version": "1.6.1",
4
4
  "description": "Ray universal api",
5
5
  "keywords": [
6
6
  "ray"
@@ -29,22 +29,22 @@
29
29
  "watch": "ray start --type=component"
30
30
  },
31
31
  "dependencies": {
32
- "@ray-js/framework": "^1.6.0-beta.9",
33
- "@ray-js/router": "^1.6.0-beta.9",
34
- "@ray-js/wechat": "^0.2.9",
32
+ "@ray-js/framework": "1.6.1",
33
+ "@ray-js/router": "1.6.1",
34
+ "@ray-js/wechat": "^0.2.19",
35
35
  "base64-browser": "^1.0.1",
36
36
  "query-string": "^7.1.3"
37
37
  },
38
38
  "devDependencies": {
39
- "@ray-js/cli": "^1.6.0-beta.9",
39
+ "@ray-js/cli": "1.6.1",
40
40
  "art-template": "^4.13.2",
41
41
  "fs-extra": "^10.1.0",
42
- "miniprogram-api-typings": "^3.12.2",
42
+ "miniprogram-api-typings": "^3.12.3",
43
43
  "react": "^17.0.2"
44
44
  },
45
45
  "publishConfig": {
46
46
  "access": "public",
47
- "registry": "https://registry.npmjs.org"
47
+ "registry": "https://registry.npmjs.com"
48
48
  },
49
- "gitHead": "a63a269523887feb9d8dbdd42f6e3669e3aa3fc5"
49
+ "gitHead": "cb6ffc5dc0ace4c698bf12ab2102420550964a7d"
50
50
  }
@@ -1,46 +0,0 @@
1
- /// <reference path="../@types/BizKit.d.ts" />
2
- export declare const apiRequestByAtop: typeof ty.apiRequestByAtop;
3
- export declare const event: typeof ty.event;
4
- export declare const beginEvent: typeof ty.beginEvent;
5
- export declare const trackEvent: typeof ty.trackEvent;
6
- export declare const endEvent: typeof ty.endEvent;
7
- export declare const getAppInfo: typeof ty.getAppInfo;
8
- export declare const getCurrentWifiSSID: typeof ty.getCurrentWifiSSID;
9
- export declare const openCountrySelectPage: typeof ty.openCountrySelectPage;
10
- export declare const getIconfontInfo: typeof ty.getIconfontInfo;
11
- export declare const uploadImage: typeof ty.uploadImage;
12
- export declare const getLangKey: typeof ty.getLangKey;
13
- export declare const getLangContent: typeof ty.getLangContent;
14
- export declare const openRNPanel: typeof ty.openRNPanel;
15
- export declare const openPanel: typeof ty.openPanel;
16
- export declare const preloadPanel: typeof ty.preloadPanel;
17
- export declare const openInnerH5: typeof ty.openInnerH5;
18
- export declare const openAppSystemSettingPage: typeof ty.openAppSystemSettingPage;
19
- export declare const openSystemSettingPage: typeof ty.openSystemSettingPage;
20
- export declare const emitChannel: typeof ty.emitChannel;
21
- export declare const router: typeof ty.router;
22
- export declare const canIUseRouter: typeof ty.canIUseRouter;
23
- export declare const goDeviceDetail: typeof ty.goDeviceDetail;
24
- export declare const goDeviceAlarm: typeof ty.goDeviceAlarm;
25
- export declare const share: typeof ty.share;
26
- export declare const getShareChannelList: typeof ty.getShareChannelList;
27
- export declare const getUserInfo: typeof ty.getUserInfo;
28
- export declare const resizeImage: typeof ty.resizeImage;
29
- export declare const rotateImage: typeof ty.rotateImage;
30
- export declare const saveToAlbum: typeof ty.saveToAlbum;
31
- export declare const onCountrySelectResult: typeof ty.onCountrySelectResult;
32
- export declare const offCountrySelectResult: typeof ty.offCountrySelectResult;
33
- export declare const onUploadProgressUpdate: typeof ty.onUploadProgressUpdate;
34
- export declare const offUploadProgressUpdate: typeof ty.offUploadProgressUpdate;
35
- export declare const onReceiveMessage: typeof ty.onReceiveMessage;
36
- export declare const offReceiveMessage: typeof ty.offReceiveMessage;
37
- export declare const onRouterEvent: typeof ty.onRouterEvent;
38
- export declare const offRouterEvent: typeof ty.offRouterEvent;
39
- export declare const onRouterResult: typeof ty.onRouterResult;
40
- export declare const offRouterResult: typeof ty.offRouterResult;
41
- export declare const registerChannel: typeof ty.registerChannel;
42
- export declare const getTempDirectory: typeof ty.getTempDirectory;
43
- export declare const handleShortcut: typeof ty.handleShortcut;
44
- export declare const isAssociatedShortcut: typeof ty.isAssociatedShortcut;
45
- export declare const isSupportedShortcut: typeof ty.isSupportedShortcut;
46
- export declare const backToHomeAndOpenPanel: typeof ty.backToHomeAndOpenPanel;
@@ -1,62 +0,0 @@
1
- ## 门锁 API
2
-
3
- > https://wiki.tuya-inc.com:7799/page/1782299639387521068#90E8B7
4
-
5
- ````
6
- ```javascript
7
- let apis = [
8
- 'tuya.m.zigbee.lock.remotepwd.execute',
9
- 'tuya.m.device.lock.remote.unlock',
10
- 'tuya.m.device.lock.remote.unlock.available',
11
- 'tuya.m.device.lock.history.latest',
12
- 'tuya.m.device.lock.history.list',
13
- 'tuya.m.device.lock.log.latest',
14
- 'tuya.m.device.lock.log.list',
15
- 'tuya.m.device.lock.log.upload',
16
- 'tuya.m.lock.album.media.list',
17
- 'tuya.m.device.member.get',
18
- 'tuya.m.device.member.detail.list',
19
- 'tuya.m.device.member.remove',
20
- 'tuya.m.device.member.removed',
21
- 'tuya.m.device.lock.sync.batch',
22
- 'tuya.m.device.user.time.schedule.update',
23
- 'tuya.m.device.user.unlock.offline',
24
- 'tuya.m.device.member.opmode.pwd.validate',
25
- 'tuya.m.device.member.opmode.add',
26
- 'tuya.m.device.member.opmode.remove',
27
- 'tuya.m.device.user.verifycode.send',
28
- 'tuya.m.device.member.opmode.update',
29
- 'tuya.m.device.member.opmode.detail',
30
- 'tuya.m.device.dp.sn.get',
31
- 'tuya.m.device.lock.dynapwd.get',
32
- 'tuya.m.device.lock.temppwd.validate',
33
- 'tuya.m.device.lock.temppwd.validate_2.0',
34
- 'tuya.m.device.lock.temppwd.create',
35
- 'tuya.m.device.lock.temppwd.update',
36
- 'tuya.m.device.lock.temppwd.name',
37
- 'tuya.m.device.lock.temppwd.remove',
38
- 'tuya.m.device.lock.share.available',
39
- 'tuya.m.device.lock.offlinepwd.get',
40
- 'tuya.m.device.lock.offlinepwd.revoke',
41
- 'tuya.m.device.lock.offlinepwd.name.update',
42
- 'tuya.m.device.lock.offlinepwd.revocable',
43
- 'tuya.m.device.lock.auth.list',
44
- 'tuya.m.device.lock.auth.list.invalid',
45
- 'tuya.m.device.lock.auth.list.clear',
46
- 'tuya.m.device.lock.key.virtual.add',
47
- 'tuya.m.device.lock.key.virtual.update',
48
- 'tuya.m.device.lock.key.virtual.phase',
49
- 'tuya.m.device.lock.key.virtual.name',
50
- 'tuya.m.device.lock.key.virtual.remove',
51
- 'tuya.m.device.unlock.waitassign',
52
- 'tuya.m.device.unlock.assignlist',
53
- 'tuya.m.device.user.unlock.allocate',
54
- 'tuya.m.device.props.save',
55
- 'tuya.m.device.props.fetch',
56
- 'tuya.m.device.member.list',
57
- 'tuya.m.device.opmode.sync.rise',
58
- 'tuya.m.i18n.date.template.get',
59
- 'tuya.m.device.active.date',
60
- 'tuya.m.device.track.details'
61
- ]
62
- ````
@@ -1,323 +0,0 @@
1
- ## getLockAuthList
2
-
3
- 获取授权记录列表。
4
-
5
- ### 引入
6
-
7
- > @ray-js/ray^1.5.0 以上版本可使用
8
-
9
- ```js
10
- import { getLockAuthList } from '@ray-js/ray'
11
- ```
12
-
13
- ### 参数
14
-
15
- **AuthListParams**
16
-
17
- | 属性 | 类型 | 必填 | 说明 |
18
- | --------- | --------------- | ---- | ------------ |
19
- | devId | `string` | 是 | 设备 ID |
20
- | authTypes | `Array<string>` | 是 | 授权类型数组 |
21
-
22
- ### 返回
23
-
24
- **AuthListResult**
25
-
26
- | 属性 | 类型 | 说明 |
27
- | ---------- | ---------------------------- | ------------------------ |
28
- | hasNext | `boolean` | 是否还有下一页 |
29
- | totalCount | `number` | 总记录数 |
30
- | datas | `Array<AuthListResultEntry>` | 授权记录列表结果条目数组 |
31
-
32
- ### 函数定义示例
33
-
34
- ```typescript
35
- /**
36
- * 获取授权记录列表
37
- */
38
- export function getLockAuthList(params: AuthListParams): Promise<AuthListResult>
39
- ```
40
-
41
- ## getInvalidAuthList
42
-
43
- 获取已失效的授权记录列表。
44
-
45
- ### 引入
46
-
47
- > @ray-js/ray^1.5.0 以上版本可使用
48
-
49
- ```js
50
- import { getInvalidAuthList } from '@ray-js/ray'
51
- ```
52
-
53
- ### 参数
54
-
55
- **InvalidAuthListParams**
56
-
57
- | 属性 | 类型 | 必填 | 说明 |
58
- | ------ | -------- | ---- | ---------- |
59
- | devId | `string` | 是 | 设备 ID |
60
- | offSet | `number` | 是 | 起始记录数 |
61
- | limit | `number` | 是 | 每页个数 |
62
-
63
- ### 返回
64
-
65
- **InvalidAuthListResult**
66
-
67
- `Array<InvalidAuthListResultEntry>`,包含已失效的授权记录列表结果条目。
68
-
69
- ### 函数定义示例
70
-
71
- ```typescript
72
- /**
73
- * 获取已失效的授权记录列表
74
- */
75
- export function getInvalidAuthList(params: InvalidAuthListParams): Promise<InvalidAuthListResult>
76
- ```
77
-
78
- ## clearInvalidAuthList
79
-
80
- 清空已失效的授权记录列表。
81
-
82
- ### 引入
83
-
84
- > @ray-js/ray^1.5.0 以上版本可使用
85
-
86
- ```js
87
- import { clearInvalidAuthList } from '@ray-js/ray'
88
- ```
89
-
90
- ### 参数
91
-
92
- **ClearInvalidAuthListParams**
93
-
94
- | 属性 | 类型 | 必填 | 说明 |
95
- | ----- | -------- | ---- | ------- |
96
- | devId | `string` | 是 | 设备 ID |
97
-
98
- ### 返回
99
-
100
- **ClearInvalidAuthListResult**
101
-
102
- `boolean`,表示是否成功清空列表。
103
-
104
- ### 函数定义示例
105
-
106
- ```typescript
107
- /**
108
- * 清空已失效的授权记录列表
109
- */
110
- export function clearInvalidAuthList(
111
- params: ClearInvalidAuthListParams
112
- ): Promise<ClearInvalidAuthListResult>
113
- ```
114
-
115
- ## addBluetoothAuth
116
-
117
- 添加蓝牙授权记录。
118
-
119
- ### 引入
120
-
121
- > @ray-js/ray^1.5.0 以上版本可使用
122
-
123
- ```js
124
- import { addBluetoothAuth } from '@ray-js/ray'
125
- ```
126
-
127
- ### 参数
128
-
129
- **AddBluetoothAuthParams**
130
-
131
- | 属性 | 类型 | 必填 | 说明 |
132
- | ------------- | ---------- | ---- | ---------------- |
133
- | devId | `string` | 是 | 设备 ID |
134
- | timeSetType | `number` | 是 | 时效类型 |
135
- | effectiveTime | `number` | 是 | 生效时间 |
136
- | invalidTime | `number` | 是 | 失效时间 |
137
- | availTime | `number` | 否 | 可用次数 |
138
- | name | `string` | 是 | 名称 |
139
- | schedule | `Schedule` | 否 | 周期设置 |
140
- | countryCode | `string` | 是 | 国家码 |
141
- | account | `string` | 是 | 账号 |
142
- | offlineUnlock | `boolean` | 是 | 是否支持离线解锁 |
143
-
144
- ### 返回
145
-
146
- **AddBluetoothAuthResult**
147
-
148
- | 属性 | 类型 | 说明 |
149
- | --------------- | --------- | ---------------------- |
150
- | unlockBindingId | `string` | 临时蓝牙开锁对应的序号 |
151
- | name | `string` | 名称 |
152
- | userExist | `boolean` | 用户是否已注册涂鸦智能 |
153
-
154
- ### 函数定义示例
155
-
156
- ```typescript
157
- /**
158
- * 添加蓝牙授权记录
159
- */
160
- export function addBluetoothAuth(params: AddBluetoothAuthParams): Promise<AddBluetoothAuthResult>
161
- ```
162
-
163
- ## updateBluetoothKey
164
-
165
- 修改蓝牙钥匙信息。
166
-
167
- ### 引入
168
-
169
- > @ray-js/ray^1.5.0 以上版本可使用
170
-
171
- ```js
172
- import { updateBluetoothKey } from '@ray-js/ray'
173
- ```
174
-
175
- ### 参数
176
-
177
- **UpdateBluetoothKeyParams**
178
-
179
- | 属性 | 类型 | 必填 | 说明 |
180
- | --------------- | ---------------- | ---- | ---------------------- |
181
- | devId | `string` | 是 | 设备 ID |
182
- | unlockBindingId | `string` | 是 | 临时蓝牙开锁对应的序号 |
183
- | offlineUnlock | `boolean` | 是 | 是否支持离线解锁 |
184
- | timeSetType | `number` | 是 | 时效类型 |
185
- | effectiveTime | `number` | 是 | 生效时间 |
186
- | invalidTime | `number` | 是 | 失效时间 |
187
- | availTime | `number` | 否 | 可用次数 |
188
- | name | `string` | 否 | 名称 |
189
- | phase | `number` | 否 | 状态 |
190
- | schedule | `UpdateSchedule` | 否 | 周期设置 |
191
-
192
- ### 返回
193
-
194
- **UpdateBluetoothKeyResult**
195
-
196
- `boolean`,表示修改是否成功。
197
-
198
- ### 函数定义示例
199
-
200
- ```typescript
201
- /**
202
- * 修改蓝牙钥匙信息
203
- */
204
- export function updateBluetoothKey(
205
- params: UpdateBluetoothKeyParams
206
- ): Promise<UpdateBluetoothKeyResult>
207
- ```
208
-
209
- ## freezeUnfreezeBluetoothKey
210
-
211
- 冻结或解冻蓝牙钥匙。
212
-
213
- ### 引入
214
-
215
- > @ray-js/ray^1.5.0 以上版本可使用
216
-
217
- ```js
218
- import { freezeUnfreezeBluetoothKey } from '@ray-js/ray'
219
- ```
220
-
221
- ### 参数
222
-
223
- **FreezeUnfreezeBluetoothKeyParams**
224
-
225
- | 属性 | 类型 | 必填 | 说明 |
226
- | --------------- | -------- | ---- | ---------------------- |
227
- | devId | `string` | 是 | 设备 ID |
228
- | unlockBindingId | `string` | 是 | 临时蓝牙开锁对应的序号 |
229
- | phase | `number` | 否 | 状态:2. 正常 4. 冻结 |
230
-
231
- ### 返回
232
-
233
- **FreezeUnfreezeBluetoothKeyResult**
234
-
235
- `boolean`,表示冻结或解冻是否成功。
236
-
237
- ### 函数定义示例
238
-
239
- ```typescript
240
- /**
241
- * 冻结或解冻蓝牙钥匙
242
- */
243
- export function freezeUnfreezeBluetoothKey(
244
- params: FreezeUnfreezeBluetoothKeyParams
245
- ): Promise<FreezeUnfreezeBluetoothKeyResult>
246
- ```
247
-
248
- ## changeBluetoothKeyName
249
-
250
- 修改蓝牙钥匙名称。
251
-
252
- ### 引入
253
-
254
- > @ray-js/ray^1.5.0 以上版本可使用
255
-
256
- ```js
257
- import { changeBluetoothKeyName } from '@ray-js/ray'
258
- ```
259
-
260
- ### 参数
261
-
262
- **ChangeBluetoothKeyNameParams**
263
-
264
- | 属性 | 类型 | 必填 | 说明 |
265
- | --------------- | -------- | ---- | ---------------------- |
266
- | devId | `string` | 是 | 设备 ID |
267
- | unlockBindingId | `string` | 是 | 临时蓝牙开锁对应的序号 |
268
- | name | `string` | 是 | 新名称 |
269
-
270
- ### 返回
271
-
272
- **ChangeBluetoothKeyNameResult**
273
-
274
- `boolean`,表示修改名称是否成功。
275
-
276
- ### 函数定义示例
277
-
278
- ```typescript
279
- /**
280
- * 修改蓝牙钥匙名称
281
- */
282
- export function changeBluetoothKeyName(
283
- params: ChangeBluetoothKeyNameParams
284
- ): Promise<ChangeBluetoothKeyNameResult>
285
- ```
286
-
287
- ## removeBluetoothKeyAuthorization
288
-
289
- 删除蓝牙钥匙授权。
290
-
291
- ### 引入
292
-
293
- > @ray-js/ray^1.5.0 以上版本可使用
294
-
295
- ```js
296
- import { removeBluetoothKeyAuthorization } from '@ray-js/ray'
297
- ```
298
-
299
- ### 参数
300
-
301
- **RemoveBluetoothKeyParams**
302
-
303
- | 属性 | 类型 | 必填 | 说明 |
304
- | --------------- | -------- | ---- | ---------------------- |
305
- | devId | `string` | 是 | 设备 ID |
306
- | unlockBindingId | `string` | 是 | 临时蓝牙开锁对应的序号 |
307
-
308
- ### 返回
309
-
310
- **RemoveBluetoothKeyResult**
311
-
312
- `boolean`,表示删除授权是否成功。
313
-
314
- ### 函数定义示例
315
-
316
- ```typescript
317
- /**
318
- * 删除蓝牙钥匙授权
319
- */
320
- export function removeBluetoothKeyAuthorization(
321
- params: RemoveBluetoothKeyParams
322
- ): Promise<RemoveBluetoothKeyResult>
323
- ```