openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2024-10-08 07:36:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

!2292 SR000H5EJ6

Browse Source 
Merge pull request !2292 from 熊欢/master
This commit is contained in:
openharmony_ci 2022-08-01 11:14:12 +00:00 committed by Gitee
commit 7e545f0d8f
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
1 changed files with 108 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

116
api/@ohos.distributedHardware.deviceManager.d.ts vendored
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2020 Huawei Device Co., Ltd.
* Copyright (c) 2020-2022 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
@ -16,8 +16,8 @@
import { AsyncCallback, Callback } from './basic';
/**
* Providers interfaces to creat a {@link deviceManager} instances.
*
* Providers interfaces to create a {@link deviceManager} instances.
*
* @since 7
* @syscap SystemCapability.DistributedHardware.DeviceManager
*
@ -46,10 +46,16 @@ declare namespace deviceManager {
/**
* NetworkId of the device.
*
*
* @since 8
*/
networkId: string;
/**
* @since 9
* The distance of dicovered device, in centimeters(cm).
*/
range: number;
}
/**
@ -163,6 +169,33 @@ declare namespace deviceManager {
capability: SubscribeCap;
}
/**
* Service publish info for device discover
* @since 9
* @systemapi this method can be used only by system applications.
*/
interface PublishInfo {
/**
* Service publish ID, the value is in scope [0, 65535], should be unique for each publish process
*/
publishId: number;
/**
* Discovery mode for service subscription.
*/
mode: DiscoverMode;
/**
* Service subscription frequency.
*/
freq: ExchangeFreq;
/**
* Whether the device should be ranged by discoverers.
*/
ranging : boolean;
}
/**
* device discover mode
*
@ -170,12 +203,16 @@ declare namespace deviceManager {
*/
enum DiscoverMode {
/**
* Passive
* when using this key at client side, it means discovering for available nearby devices by
* calling @startDeviceDiscovery function, while using this key at server side indicating that
* a device publication or advertisement by calling @publishDeviceDiscovery.
*/
DISCOVER_MODE_PASSIVE = 0x55,
/**
* Proactive
* when using this key at server side, it means discovering for available nearby devices by
* calling @startDeviceDiscovery function, while using this key at client side indicating that
* a device publication or advertisement by calling @publishDeviceDiscovery.
*/
DISCOVER_MODE_ACTIVE = 0xAA
}
@ -283,7 +320,7 @@ declare namespace deviceManager {
* the token used for this authentication.
*/
token: number;
/**
* Authentication extra infos.
*/
@ -308,7 +345,7 @@ declare namespace deviceManager {
interface DeviceManager {
/**
* Releases the {@code DeviceManager} instance after the methods for device management are no longer used.
*
*
* @systemapi this method can be used only by system applications.
*/
release(): void;
@ -371,11 +408,22 @@ declare namespace deviceManager {
/**
* Start to discover device.
*
* @since 8
* @param subscribeInfo subscribe info to discovery device
* @systemapi this method can be used only by system applications.
*/
startDeviceDiscovery(subscribeInfo: SubscribeInfo): void;
/**
* Start to discover device.
*
* @since 9
* @param subscribeInfo subscribe info to discovery device
* @param filterOptions filterOptions to filter discovery device
* @systemapi this method can be used only by system applications.
*/
startDeviceDiscovery(subscribeInfo: SubscribeInfo, filterOptions?: string): void;
/**
* Stop to discover device.
*
@ -384,6 +432,22 @@ declare namespace deviceManager {
*/
stopDeviceDiscovery(subscribeId: number): void;
/**
* Publish discover device.
* @since 9
* @param publishInfo publish info to Publish discovery device
* @systemapi this method can be used only by system applications.
*/
publishDeviceDiscovery(publishInfo: PublishInfo): void;
/**
* UnPublish discover device.
* @since 9
* @param publishId Service publish ID, identify a publish operation, should be a unique id in package range
* @systemapi this method can be used only by system applications.
*/
unPublishDeviceDiscovery(publishId: number): void;
/**
* Authenticate the specified device.
*
@ -463,6 +527,42 @@ declare namespace deviceManager {
*/
off(type: 'discoverFail', callback?: Callback<{ subscribeId: number, reason: number }>): void;
/**
* Register a device publish result callback so that the application can be notified when the device publish success
*
* @since 9
* @param callback Indicates the device publish result callback to register.
* @systemapi this method can be used only by system applications.
*/
on(type: 'publishSuccess', callback: Callback<{ publishId: number }>): void;
/**
* UnRegister a device publish result callback so that the application can be notified when the device publish was failed
*
* @since 9
* @param callback Indicates the device publish result callback to register.
* @systemapi this method can be used only by system applications.
*/
off(type: 'publishSuccess', callback?: Callback<{ publishId: number }>): void;
/**
* Register a device publish result callback so that the application can be notified when the device publish was failed
*
* @since 9
* @param callback Indicates the device publish result callback to register.
* @systemapi this method can be used only by system applications.
*/
on(type: 'publishFail', callback: Callback<{ publishId: number, reason: number }>): void;
/**
* UnRegister a device publish result callback so that the application can be notified when the device publish was failed
*
* @since 9
* @param callback Indicates the device publish result callback to register.
* @systemapi this method can be used only by system applications.
*/
off(type: 'publishFail', callback?: Callback<{ publishId: number, reason: number }>): void;
/**
* Register a serviceError callback so that the application can be notified when devicemanager service died
*