本模块提供穿戴设备侧三方应用订阅手表和手机连接状态的能力。
起始版本:6.1.1(24)
static onConnectionStateChange(callback: MonitorEventCallback): void
监听设备状态变化,使用callback异步回调。
模型约束: 此接口仅可在FA模型下使用。
系统能力: SystemCapability.Health.WearEngine.Lite
设备行为差异: 该接口在wearable、litewearable中可正常调用,在其他设备类型中无效果。
起始版本: 6.1.1(24)
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | MonitorEventCallback | 是 | 回调函数,返回设备状态的变化信息。 |
示例:
let eventCallback = {
// 事件变化回调(设备连接状态变化时触发)
eventChange: (data) => {
console.info(`Succeeded in subscribing connection status. event: ${data.event}, data: ${data.data.data}`);
},
success: (code, data) => {
console.info(`Succeeded in subscribing connection status. Code:${code.code}, data:${data.data}`);
},
fail: (error, errorMessage) => {
console.error(`Failed to subscribe connection status. Code:${error.code}, data:${errorMessage.data}`);
}
};
WearEngineLite.onConnectionStateChange(eventCallback); static offConnectionStateChange(callback?: MonitorEventCallback): void
取消监听设备状态变化,使用callback异步回调。
模型约束: 此接口仅可在FA模型下使用。
系统能力: SystemCapability.Health.WearEngine.Lite
设备行为差异: 该接口在wearable、litewearable中可正常调用,在其他设备类型中无效果。
起始版本: 6.1.1(24)
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | MonitorEventCallback | 否 | 回调函数,返回MonitorEventCallback类信息。若不填写则成功取消监听事件。 |
示例:
let eventCallback = {
success: (code, data) => {
console.info(`Succeeded in unsubscribing connection status. code:${code.code}, data:${data.data}`);
},
fail: (error, errorMessage) => {
console.error(`Failed to unsubscribe connection status. code:${error.code}, data:${errorMessage.data}`);
}
};
WearEngineLite.offConnectionStateChange(eventCallback); static onFileReceive(remoteAppInfo: AppInfo, callback: FileReceiverCallback): void
订阅对端设备向本端设备发送文件和查看文件接收进度的事件,使用callback异步回调
模型约束: 此接口仅可在FA模型下使用。
系统能力: SystemCapability.Health.WearEngine.Lite
起始版本: 26.0.0
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| remoteAppInfo | AppInfo | 是 | 对端设备的应用信息。 |
| callback | FileReceiverCallback | 是 | 回调函数,返回FileReceiverCallback类信息。 |
示例:
// 设置设备侧应用的应用信息:包名与指纹
let remoteAppInfo = {
bundleName: '',
fingerprint: ''
};
// 设置需要接收的文件存储路径
globalThis.__fileDir__ = 'xxxx/xxxx';
// 设置需要接收的文件信息和传输进度
let FileReceiverCallback =
{
onReceive: (fileName, filePath, progress)=>{
console.info(`Succeeded in onFileReceiving, fileName: ${fileName}, filePath: ${filePath}, progress: ${progress}`);
},
success: (code, data) => {
console.info(`Succeeded in onFileReceiving, Code: ${code}, data: ${data}`);
},
fail: (code, data) => {
console.error(`Failed to onFileReceive, Code: ${code}, data: ${data}`);
}
};
try {
WearEngineLite.onFileReceive(remoteAppInfo, FileReceiverCallback);
} catch (error) {
console.error(`Failed to onFileReceive. Code: ${error.code}, message: ${error.data}.`);
}; static offFileReceive(remoteAppInfo: AppInfo, callback?: FileReceiverCallback): void
取消订阅对端设备向本端设备发送文件和查看文件接收进度的事件,使用callback异步回调。
模型约束: 此接口仅可在FA模型下使用。
系统能力: SystemCapability.Health.WearEngine.Lite
起始版本: 26.0.0
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| remoteAppInfo | AppInfo | 是 | 对端设备的应用信息。 |
| callback | FileReceiverCallback | 否 | 回调函数,返回FileReceiverCallback类信息。若不填写则成功取消订阅事件。 |
示例:
// 设置设备侧应用的应用信息:包名与指纹
let remoteAppInfo = {
bundleName: '',
fingerprint: ''
};
// 设置需要接收的文件信息回调
let fileReceiverCallback =
{
onReceive: (fileName, filePath, progress)=>{
console.info(`Succeeded in offFileReceiving, fileName: ${fileName}, filePath: ${filePath}, progress: ${progress}`);
},
success: (code, data) => {
console.info(`Succeeded in offFileReceiving, Code: ${code}, data: ${data}`);
},
fail: (code, data) => {
console.error(`Failed to offFileReceive, Code: ${code}, data: ${data}`);
}
};
try {
WearEngineLite.offFileReceive(remoteAppInfo, fileReceiverCallback);
} catch (error) {
console.error(`Failed to offFileReceive. Code: ${error.code}, message: ${error.data}.`);
}; 作为onConnectionStateChange接口的入参,当订阅监听的事件触发时,将变化后的设备状态信息传递给回调函数;作为offConnectionStateChange接口的入参,用于取消监听设备连接状态的变化。
eventChange(data: MonitorEventData): void
监听设备状态变化的事件。
模型约束: 此接口仅可在FA模型下使用。
系统能力: SystemCapability.Health.WearEngine.Lite
设备行为差异: 该接口在wearable、litewearable中可正常调用,在其他设备类型中无效果。
起始版本: 6.1.1(24)
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| data | MonitorEventData | 是 | 变化后的设备状态信息。 |
示例:
let eventCallback = {
// 事件变化回调(设备连接状态变化时触发)
eventChange: (data) => {
console.info(`Succeeded in subscribing connection status, event: ${data.event}, data: ${data.data.data}`);
}
};
WearEngineLite.onConnectionStateChange(eventCallback); success(code: number, data?: string): void
表示订阅成功或者是取消订阅成功。
模型约束: 此接口仅可在FA模型下使用。
系统能力: SystemCapability.Health.WearEngine.Lite
设备行为差异: 该接口在wearable、litewearable中可正常调用,在其他设备类型中无效果。
起始版本: 6.1.1(24)
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| code | number | 是 | 返回0。 |
| data | string | 否 | 默认值undefined。 |
示例:
let eventCallback = {
success: (code, data) => {
console.info(`Succeeded in subscribing connection status, Code:${code.code}, data:${data.data}`);
}
};
WearEngineLite.onConnectionStateChange(eventCallback); fail(code: number, data?: string): void
表示订阅失败或者是取消订阅失败。
模型约束: 此接口仅可在FA模型下使用。
系统能力: SystemCapability.Health.WearEngine.Lite
设备行为差异: 该接口在wearable、litewearable中可正常调用,在其他设备类型中无效果。
起始版本: 6.1.1(24)
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| code | number | 是 | Wearable返回-1,Lite Wearable返回401,表示订阅失败或取消订阅失败。 可能原因是必填参数为空(如eventChange为空)。 |
| data | string | 否 | 默认值undefined。 |
示例:
let eventCallback = {
fail: (error, errorMessage) => {
console.error(`Failed to subscribe connection status. Code:${error.code}, data:${errorMessage.data}`);
}
};
WearEngineLite.onConnectionStateChange(eventCallback); 设备的状态信息。
模型约束: 此接口仅可在FA模型下使用。
系统能力: SystemCapability.Health.WearEngine.Lite
起始版本: 6.1.1(24)
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| code | number | 否 | 否 | 返回0。 |
| data | string | 否 | 是 | 设备的连接状态,2表示连接成功,3表示连接断开。 |
作为eventChange的参数,当订阅监听的事件触发时,将设备状态的变化信息传递给回调函数。
模型约束: 此接口仅可在FA模型下使用。
系统能力: SystemCapability.Health.WearEngine.Lite
起始版本: 6.1.1(24)
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| event | string | 否 | 否 | 回调函数上报的监听事件。 |
| data | MonitorData | 否 | 否 | 变化后的设备状态信息。 |
作为onFileReceive接口的入参,当接收文件进度发生变化时,将变化后的文件传输进度传递给回调函数;作为offFileReceive接口的入参,用于取消订阅对端应用向本端应用发送文件的事件。
onReceive(fileName: string, filePath: string, progress: number): void
用于接收对端设备发送的文件和查看接收进度。
模型约束: 此接口仅可在FA模型下使用。
系统能力: SystemCapability.Health.WearEngine.Lite
起始版本: 26.0.0
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| fileName | string | 是 | 接收文件的名称。 |
| filePath | string | 是 | 接收文件的存储路径。 |
| progress | number | 是 | 接收文件的进度,返回值范围:[0,100]。 |
示例:
// 设置设备侧应用的应用信息:包名与指纹
let remoteAppInfo = {
bundleName: '',
fingerprint: ''
};
// 设置需要接收的文件信息回调
let fileReceiverCallback =
{
onReceive: (fileName, filePath, progress)=>{
console.info(`Succeeded in onFileReceiving, fileName: ${fileName}, filePath: ${filePath}, progress: ${progress}`);
},
success: (code, data) => {
console.info(`Succeeded in onFileReceiving, Code: ${code}, data: ${data}`);
},
fail: (code, data) => {
console.error(`Failed to onFileReceive, Code: ${code}, data: ${data}`);
}
};
try {
WearEngineLite.onFileReceive(remoteAppInfo, fileReceiverCallback);
} catch (error) {
console.error(`Failed to onFileReceive. Code: ${error.code}, message: ${error.data}.`);
}; success(code: number, data?: string): void
表示文件接收事件订阅成功或者是取消订阅成功。
模型约束: 此接口仅可在FA模型下使用。
系统能力: SystemCapability.Health.WearEngine.Lite
起始版本: 26.0.0
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| code | number | 是 | 返回0,表示订阅成功或取消订阅成功。 |
| data | string | 否 | 默认值undefined。 |
示例:
// 设置设备侧应用的应用信息:包名与指纹
let remoteAppInfo = {
bundleName: '',
fingerprint: ''
};
// 设置需要接收的文件信息回调
let fileReceiverCallback =
{
onReceive: (fileName, filePath, progress)=>{
console.info(`Succeeded in onFileReceiving, fileName: ${fileName}, filePath: ${filePath}, progress: ${progress}`);
},
success: (code, data) => {
console.info(`Succeeded in onFileReceiving, Code: ${code}, data: ${data}`);
},
fail: (code, data) => {
console.error(`Failed to onFileReceive, Code: ${code}, data: ${data}`);
}
};
try {
WearEngineLite.onFileReceive(remoteAppInfo, fileReceiverCallback);
} catch (error) {
console.error(`Failed to onFileReceive. Code: ${error.code}, message: ${error.data}.`);
}; fail(code: number, data?: string): void
表示文件接收事件订阅失败或者是取消订阅失败。
模型约束: 此接口仅可在FA模型下使用。
系统能力: SystemCapability.Health.WearEngine.Lite
起始版本: 26.0.0
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| code | number | 是 | Wearable返回-1,Lite Wearable返回401,表示订阅失败或取消订阅失败。 可能原因是必填参数为空(如onReceive为空)或参数值范围错误(如包名长度不符合规范)。 |
| data | string | 否 | 默认值undefined。 |
示例:
// 设置设备侧应用的应用信息:包名与指纹
let remoteAppInfo = {
bundleName: '',
fingerprint: ''
};
// 设置需要接收的文件信息回调
let fileReceiverCallback =
{
onReceive: (fileName, filePath, progress)=>{
console.info(`Succeeded in onFileReceiving, fileName: ${fileName}, filePath: ${filePath}, progress: ${progress}`);
},
success: (code, data) => {
console.info(`Succeeded in onFileReceiving, Code: ${code}, data: ${data}`);
},
fail: (code, data) => {
console.error(`Failed to onFileReceive, Code: ${code}, data: ${data}`);
}
};
try {
WearEngineLite.onFileReceive(remoteAppInfo, fileReceiverCallback);
} catch (error) {
console.error(`Failed to onFileReceive. Code: ${error.code}, message: ${error.data}.`);
}; 设备侧应用信息类。
模型约束: 此接口仅可在FA模型下使用。
系统能力: SystemCapability.Health.WearEngine.Lite
起始版本: 26.0.0
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| bundleName | string | 否 | 否 | 应用名称。 |
| fingerprint | string | 否 | 否 | 应用指纹,用于标识应用的唯一身份。 应用指纹获取请参考如何获取应用指纹。 |