Interface IDcsSdkApi

All Known Implementing Classes:
SDKHandler

public interface IDcsSdkApi
Interface which will be implemented by SDK which will control various operations of the scanner
  • Method Details

    • dcssdkSetDelegate

      DCSSDKDefs.DCSSDK_RESULT dcssdkSetDelegate(IDcsSdkApiDelegate delegate)
      Registers a particular object which conforms to IDcsSdkApiDelegate interface as a receiver of SDK notifications. Registration of a particular object which conforms to IDcsSdkApiDelegate interface is required to receive notifications from the SDK.
      Parameters:
      delegate - Delegate which will be implemented by the app
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkClose

      Method to close the communication with SDK
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkGetVersion

      String dcssdkGetVersion()
      Method to return the version of the SDK.
      Returns:
      SDK Version
    • dcssdkSetOperationalMode

      DCSSDKDefs.DCSSDK_RESULT dcssdkSetOperationalMode(DCSSDKDefs.DCSSDK_MODE operationalMode)
      Method to set the operational mode(If multiple modes are suppoted)
      Parameters:
      operationalMode - Operational mode to be set(one of DCSSDKDefs.DCSSDK_MODE)
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkSubsribeForEvents

      DCSSDKDefs.DCSSDK_RESULT dcssdkSubsribeForEvents(int sdkEventsMask)
      Method to enable providing of notifications of requested types.
      Parameters:
      sdkEventsMask - Mask which decides the subscription status
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkUnsubsribeForEvents

      DCSSDKDefs.DCSSDK_RESULT dcssdkUnsubsribeForEvents(int sdkEventsMask)
      Method to disable providing of notification of requested types.
      Parameters:
      sdkEventsMask - Unsubscription option flags.
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkGetAvailableScannersList

      DCSSDKDefs.DCSSDK_RESULT dcssdkGetAvailableScannersList(List<DCSScannerInfo> availableScannersList)
      Method to fetch the list of available(paired via bluetooth) scanners
      Parameters:
      availableScannersList - List of scanners which should be updated
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkGetAvailableScannersList

      List<DCSScannerInfo> dcssdkGetAvailableScannersList()
      Method to fetch the list of available(paired via bluetooth) scanners
      Returns:
      List of available scanners)
    • dcssdkStartScanForAvailableDevices

      DCSSDKDefs.DCSSDK_RESULT dcssdkStartScanForAvailableDevices()
      Method to scan all the currently available Bluetooth Devices.
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkStopScanningDevices

      DCSSDKDefs.DCSSDK_RESULT dcssdkStopScanningDevices()
      Method to stop current Bluetooth Devices scanning.
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkGetActiveScannersList

      DCSSDKDefs.DCSSDK_RESULT dcssdkGetActiveScannersList(List<DCSScannerInfo> activeScannersList)
      Method to fetch the list of active(connected via bluetooth) scanners
      Parameters:
      activeScannersList - List of scanners which should be updated
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkGetActiveScannersList

      List<DCSScannerInfo> dcssdkGetActiveScannersList()
      Method to fetch the list of active(connected via bluetooth) scanners
      Returns:
      List of active scanners)
    • dcssdkEstablishCommunicationSession

      DCSSDKDefs.DCSSDK_RESULT dcssdkEstablishCommunicationSession(int scannerID)
      Method requests to establish communication session with a particular available scanner.
      Parameters:
      scannerID - Unique identifier of a particular scanner assigned by SDK
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkTerminateCommunicationSession

      DCSSDKDefs.DCSSDK_RESULT dcssdkTerminateCommunicationSession(int scannerID)
      Method requests to terminate communication session with a particular active scanner.
      Parameters:
      scannerID - Unique identifier of a particular scanner assigned by SDK.
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkEnableAvailableScannersDetection

      DCSSDKDefs.DCSSDK_RESULT dcssdkEnableAvailableScannersDetection(boolean enable)
      Method requests to enable/disable "Available scanners detection" option.
      Parameters:
      enable - (true/false) based on whether the option should be enabled or disabled
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkEnableBluetoothScannersDiscovery

      DCSSDKDefs.DCSSDK_RESULT dcssdkEnableBluetoothScannersDiscovery(boolean enable)
      Method requests to enable/disable "Bluetooth scanners discovery" option.
      Parameters:
      enable - (true/false) based on whether the option should be enabled or disabled
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkSetSTCEnabledState

      DCSSDKDefs.DCSSDK_RESULT dcssdkSetSTCEnabledState(boolean enable)
      Method set Scanner Control App STC(Scan to connect) enabled state.
      Parameters:
      enable - (true/false) based on whether the option should be enabled or disabled
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkEnableAutomaticSessionReestablishment

      DCSSDKDefs.DCSSDK_RESULT dcssdkEnableAutomaticSessionReestablishment(boolean enable, int fromScannerID)
      Method requests to enable/disable "Automatic communication session reestablishment" option for a particular scanner.
      Parameters:
      enable - true/false for enabling/disabling
      fromScannerID - identifier of a particular scanner assigned by SDK.
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkExecuteCommandOpCodeInXMLForScanner

      @Deprecated DCSSDKDefs.DCSSDK_RESULT dcssdkExecuteCommandOpCodeInXMLForScanner(DCSSDKDefs.DCSSDK_COMMAND_OPCODE opCode, String inXML, StringBuilder outXML, int scannerID)
      Deprecated.
      Method provides synchronous execution of a particular method via an opcode.
      Parameters:
      opCode - Opcode for the command
      inXML - Relevant argument list for the opcode, structured into an XML string.
      outXML - Results of method execution, structured into an XML string.
      scannerID - Unique identifier of a particular scanner assigned by SDK.
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkExecuteCommandOpCodeInXMLForScanner

      DCSSDKDefs.DCSSDK_RESULT dcssdkExecuteCommandOpCodeInXMLForScanner(DCSSDKDefs.DCSSDK_COMMAND_OPCODE opCode, String inXML, StringBuilder outXML)
      Method provides synchronous execution of a particular method via an opcode.
      Parameters:
      opCode - Opcode for the command
      inXML - Relevant argument list for the opcode, structured into an XML string.
      outXML - Results of method execution, structured into an XML string.
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkExecuteCommandOpCodeInXMLForScanner

      String dcssdkExecuteCommandOpCodeInXMLForScanner(DCSSDKDefs.DCSSDK_COMMAND_OPCODE opCode, String inXML)
      Method provides synchronous execution of a particular method via an opcode.
      Parameters:
      opCode - Opcode for the command
      inXML - Relevant argument list for the opcode, structured into an XML string.
      Returns:
      outXma for execute command with given opcode and inXml.
    • dcssdkExecuteSSICommandOpCodeInXMLForScanner

      DCSSDKDefs.DCSSDK_RESULT dcssdkExecuteSSICommandOpCodeInXMLForScanner(DCSSDKDefs.DCSSDK_COMMAND_OPCODE opCode, String inXML, StringBuilder outXML, int scannerID)
      Method provides synchronous execution SSI command of a particular method via an opcode.
      Parameters:
      opCode - Opcode for the command
      inXML - Relevant argument list for the opcode, structured into an XML string.
      outXML - Results of method execution, structured into an XML string.
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkGetPairingBarcode

      BarCodeView dcssdkGetPairingBarcode(DCSSDKDefs.DCSSDK_BT_PROTOCOL bluetoothProtocol, DCSSDKDefs.DCSSDK_BT_SCANNER_CONFIG config)
      Method provides pairing barcode for Bluetooth scanners
      Parameters:
      bluetoothProtocol - Protocol to be switched
      config - Configuration to be used
      Returns:
      BarCodeView
    • dcssdkGetPairingBarcode

      BarCodeView dcssdkGetPairingBarcode(DCSSDKDefs.DCSSDK_BT_PROTOCOL bluetoothProtocol, DCSSDKDefs.DCSSDK_BT_SCANNER_CONFIG config, String bluetoothMAC)
      Method provides pairing barcode for Bluetooth scanners
      Parameters:
      bluetoothProtocol - Protocol to be switched
      config - Configuration to be used
      bluetoothMAC - Bluetooth MAC address to be used
      Returns:
      BarCodeView
    • dcssdkGetUSBSNAPIWithImagingBarcode

      BarCodeView dcssdkGetUSBSNAPIWithImagingBarcode()
      Method provides connection barcode for USB scanners
      Returns:
      BarCodeView
    • dcssdkStartScanForTopologyChanges

      DCSSDKDefs.DCSSDK_RESULT dcssdkStartScanForTopologyChanges()
      Scan for topology changes
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkSetBTAddress

      DCSSDKDefs.DCSSDK_RESULT dcssdkSetBTAddress(String bluetoothMAC)
      Method to set the Bluetooth address of the device. This address will be used when SDK cannot determine Bluetooth MAC address automatically.
      Parameters:
      bluetoothMAC - Bluetooth MAC address to be used
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkClearBTAddress

      DCSSDKDefs.DCSSDK_RESULT dcssdkClearBTAddress()
      Method to clear the Bluetooth address stored in SDK.
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkSetIDCConfig

      DCSSDKDefs.DCSSDK_RESULT dcssdkSetIDCConfig(IDCConfig idcConfig)
      Method to set the IDC configuration information for SDK. This configuration information is used to send either Binary Data event or seperate Image and Barcode events for IDC data.
      Parameters:
      idcConfig - IDCConfig Object which has IDC configuration information
      Returns:
      Success/Failure of the operation(One of DCSSDKDefs.DCSSDK_RESULT)
    • dcssdkGetIDCConfig

      IDCConfig dcssdkGetIDCConfig()
      Method to get the IDCConfig information stored in SDK.
      Returns:
      IDCConfig object(IDCConfig)