GatewayAPI Class |
GatewayAPI is the api responsible for performing operations on gateway, like chargng phone, stop charging phone, and requesting battery status.
Inheritance HierarchyNamespace: Nexpaq.APIs
Assembly: NexpaqCore (in NexpaqCore.dll) Version: 1.0.6767.24310
SyntaxC#
public class GatewayAPI : ProductAPI
The GatewayAPI type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GatewayAPI |
Initializes a new instance of the GatewayAPI class.
|
Methods| Name | Description | |
|---|---|---|
 | BSLInfoReceivedHandler |
Handles when product BSL info received
(Inherited from ProductAPI.) |
| ChangeMode |
Changes the mode of product.
(Inherited from ProductAPI.) |
| ChargePhone |
Executes a command to start charging phone.
|
| EraseFirmware |
Erases the firmware in specified product.
(Inherited from ProductAPI.) |
| GetByUUID |
Gets the gateway by UUID.
|
| GetProductByUUID |
Gets the product by UUID.
(Overrides ProductAPIGetProductByUUID(UUID).) |
| GetTypeID |
Gets the product type identifier from known products or cloud.
(Inherited from ProductAPI.) |
| InstallFirmware |
Installs the firmware by version.
(Inherited from ProductAPI.) |
| InstallLatestFirmware |
Installs the latest firmware.
(Inherited from ProductAPI.) |
| InstallSpecificFirmware |
Installs specific firmware to module, type must be compatible.
It is impossible to install MAX firmware to MSP and vice versa.
(Inherited from ProductAPI.) |
| RequestBasicData |
Requests the basic data from product.
(Inherited from ProductAPI.) |
| RequestBatteryStatus |
Request the battery ststus.
|
| RequestFirmwareVersion |
Requests the firmware version of product.
(Inherited from ProductAPI.) |
| SetManifest |
Sets the manifest to product.
(Inherited from ProductAPI.) |
| StopChargingPhone |
Executes a command to stop charging phone.
|
| TriggerError | (Inherited from ErrorClass.) |
Events| Name | Description | |
|---|---|---|
 | BasicInfoReceived |
Occurs when basic data for the gateway received.
|
| BatteryStateReceived |
Occurs when battery state received.
|
| BootloaderUpdateAvailable |
Occurs when bootloader update available.
|
| BSLInfoReceived |
occurs when bsl information are received.
(Inherited from ProductAPI.) |
| Connected |
Occurs when gateway connected.
|
| Disconnected |
Occurs when gateway disconnected.
|
| Error | (Inherited from ErrorClass.) |
| FirmwareFlashed |
Occurs when firmware was flashed to product.
(Inherited from ProductAPI.) |
| FirmwareUpdateAvailable |
Occurs when firmware update available.
|
| Initialized |
Occurs when gateway initialized.
|
| ManifestSet |
Occurs when manifest set to the gateway.
|
| SwitchedToAppMode |
Occurs when basic data for the gateway received.
|
| TypeRecognised |
Occurs when gateway type recognised.
|
| UUIDRecieved |
Occurs when gateway UUID recieved.
|
Fields| Name | Description | |
|---|---|---|
 | API |
Main Api.
(Inherited from ProductAPI.) |
| Type |
Product type.
(Inherited from ProductAPI.) |
See Also