API List

The following tables list the main public integration APIs by HarmonyOS native module. Select “View usage” to open the corresponding description, guidance, and ArkTS example.

sdk

API	Description	Usage
`new GizServerInfo()`	Creates an OpenAPI region configuration	View usage
`new GizProductInfo()`	Creates a ProductKey and ProductSecret configuration	View usage
`new GizConfiguration()`	Creates the SDK initialization configuration	View usage
`getProductWithProductKey()`	Finds a product in the initialization configuration	View usage
`GizSDKManager.initialize()`	Initializes the core SDK	View usage
`GizSDKManager.initSDK()`	Compatibility name for `initialize()`	View usage
`GizSDKManager.setDebug()` / `isDebug()`	Sets or reads SDK debug logging state	View usage
`GizSDKManager.isInitialized()`	Checks whether the core SDK is initialized	View usage
`GizSDKManager.getConfiguration()`	Returns the current initialization configuration	View usage
`GizSDKManager.getUserManager()`	Returns the shared user manager	View usage
`GizSDKManager.getVersion()`	Returns the core HAR version	View usage
`GizSDKManager.cleanCache()`	Clears logs and data point configuration caches	View usage
`GizSDKManager.shutdown()` / `deregister()`	Releases core SDK resources	View usage
`subscribeUserState()`	Observes authentication status and user data	View usage
`loginByAnonymous()`	Logs in an anonymous user	View usage
`loginWithAccount()`	Logs in with username and password	View usage
`sendMobileLoginVerifyCode()` / `loginWithMobile()`	Logs in with a mobile verification code	View usage
`sendEmailLoginVerifyCode()` / `loginWithEmail()`	Logs in with an email verification code	View usage
`getAuthorizeData()` / `getUserTokenStream()`	Reads or observes authorization data	View usage
`refreshUserInfo()`	Refreshes the user profile from the cloud	View usage
`logout()`	Logs out and clears the user session	View usage
`registerWithAccount()`	Registers a username/password account	View usage
`registerWithMobile()` / `registerWithPhone()`	Registers with a mobile number and verification code	View usage
`registerWithEmail()`	Registers with email and a verification code	View usage
`forgotWithMobile()`	Resets a password by mobile number	View usage
`forgotWithEmail()`	Resets a password by email	View usage
`subscribeBoundDeviceList()` / `refreshBoundDeviceList()`	Observes or refreshes cloud-bound devices	View usage
`GizDeviceManager.getRegisteredDevices()`	Returns the unified device cache	View usage
`GizDeviceManager.getBoundDevices()`	Returns cloud-bound devices	View usage
`GizDeviceManager.getBluetoothDevices()`	Returns current BLE devices	View usage
`GizDeviceManager.getLanDevices()`	Returns current LAN devices	View usage
`GizDeviceManager.subscribeDeviceList()`	Observes the unified device list	View usage
`GizSDKManager.registerDevice()`	Registers a unified device by ProductKey and MAC	View usage
`GizDevice.register()`	Registers a device with the cloud	View usage
`GizDevice.bind()` / `GizUserManager.bindDevice()`	Binds a device to the current user	View usage
`bindDeviceWithPasscode()`	Binds with Device ID and Passcode	View usage
`GizDevice.updateDeviceInfo()`	Updates device alias and remark	View usage
`GizDevice.unBind()` / `unbindDevice()`	Unbinds a device	View usage
`getName()` / `getRemark()` / `toJsonObject()`	Reads basic device information and a snapshot	View usage
`GizDevice.sendDataPoints()`	Writes data points over an automatically selected transport	View usage
`capability.sendDataPoints()`	Writes data points over a specified transport	View usage
`capability.readDataPoints()`	Reads data points over a specified transport	View usage
`subscribeDataPointEvents()` / `subscribeDataPoints()`	Observes device reports or current values	View usage
`capability.subscribeStatus()`	Observes transport capability status	View usage
`GizState.getValue()` / `subscribe()`	Reads and observes SDK state	View usage
`setLogDirectory()` / `getLogPath()`	Sets the log directory or reads the log path	View usage
`GizSDKManager.feedback()`	Submits feedback with optional logs	View usage
`GizOpenApiError`	Exposes OpenAPI error status	View usage

sdk_bluetooth

API	Description	Usage
`GizBluetoothManager.initialize()`	Initializes the Bluetooth module	View usage
`subscribeBluetoothDeviceList()`	Observes the BLE discovery list	View usage
`startBleScan()`	Starts BLE scanning	View usage
`isScanning()`	Checks whether BLE scanning is active	View usage
`stopBleScan()`	Stops BLE scanning	View usage
`getAdvertisement()`	Returns a parsed BLE advertisement	View usage
`getSession()`	Returns a low-level BLE session	View usage
`bleCapability.connect()`	Establishes and authenticates a GATT connection	View usage
`bleCapability.disconnect()`	Disconnects a BLE device	View usage
`bleCapability.sendDataPoints()`	Writes data points over BLE	View usage
`bleCapability.readDataPoints()`	Reads data points over BLE	View usage
`bleCapability.getDeviceInfo()`	Reads device information over BLE	View usage
`bleCapability.queryResetFlag()`	Queries the reset flag over BLE	View usage
`bleCapability.provideWiFiCredentials()`	Runs the complete BLE Wi-Fi provisioning flow	View usage
`bleCapability.stopProvideWiFiCredentials()`	Cancels BLE provisioning	View usage
`GizBluetoothManager.configureNetwork()`	Low-level API that only sends Wi-Fi information	View usage
`bleCapability.checkUpdate()`	Checks for BLE firmware updates	View usage
`bleCapability.startUpgrade()`	Starts BLE OTA	View usage
`bleCapability.cancelUpgrade()`	Cancels BLE OTA	View usage
`getOtaManager()`	Returns the low-level `GizBleOTAManager`	View usage
`isReady()` / `getStatus()`	Reads Bluetooth module status	View usage
`getVersion()`	Returns the Bluetooth HAR version	View usage
`shutdown()`	Releases Bluetooth module resources	View usage

sdk_lan

API	Description	Usage
`GizLanManager.initialize()`	Initializes the LAN module	View usage
`subscribeLanDeviceList()`	Observes the LAN device list	View usage
`startDiscovery()`	Starts UDP LAN discovery	View usage
`refreshDiscovery()`	Refreshes LAN discovery immediately	View usage
`isDiscovering()`	Checks whether discovery is active	View usage
`stopDiscovery()`	Stops discovery and closes sockets	View usage
`getProfile()` / `getSession()`	Returns the LAN profile or low-level session	View usage
`lanCapability.connect()`	Connects to a LAN device	View usage
`lanCapability.disconnect()`	Disconnects a LAN device	View usage
`lanCapability.sendDataPoints()`	Writes data points over LAN	View usage
`lanCapability.readDataPoints()`	Reads data points over LAN	View usage
`lanCapability.getDeviceInfo()`	Reads device information over LAN	View usage
`lanCapability.queryResetFlag()`	Queries the reset flag over LAN	View usage
`lanCapability.provideWiFiCredentials()`	Runs LAN Wi-Fi provisioning	View usage
`lanCapability.stopProvideWiFiCredentials()`	Cancels LAN provisioning	View usage
`isReady()` / `getStatus()`	Reads LAN module status	View usage
`getVersion()`	Returns the LAN HAR version	View usage
`shutdown()`	Releases LAN module resources	View usage

sdk_mqtt

API	Description	Usage
`GizMqttManager.initialize()`	Initializes MQTT and observes user, device, and network state	View usage
`mqttCapability.subscribeStatus()`	Waits for a device cloud transport to become controllable	View usage
`mqttCapability.connect()` / `connectDevice()`	Explicitly enables MQTT subscriptions for one device	View usage
`mqttCapability.disconnect()` / `disconnectDevice()`	Explicitly disables MQTT subscriptions for one device	View usage
`mqttCapability.sendDataPoints()` / `sendDeviceDataPoints()`	Writes data points over MQTT	View usage
`mqttCapability.readDataPoints()` / `readDeviceDataPoints()`	Reads data points over MQTT	View usage
`subscribeDataPointEvents()`	Observes and identifies MQTT data point reports	View usage
`mqttCapability.getDeviceInfo()` / `GizMqttManager.getDeviceInfo()`	Reads device versions from the cloud profile	View usage
`mqttCapability.queryResetFlag()`	Queries the reset flag over MQTT	View usage
`subscribeBindingEvents()` / `subscribeBindEvent()`	Observes MQTT device binding changes	View usage
`refreshBoundDeviceList()`	Refreshes the bound-device data used by MQTT	View usage
`isReady()` / `getStatus()`	Reads MQTT module status and diagnostics	View usage
`getVersion()`	Returns the MQTT HAR version	View usage
`shutdown()`	Closes services and releases MQTT resources	View usage

Lifecycle and Cleanup