![]() |
IDBlueCoreApi is the subset of functionality common to both HF and UHF.
- (void) addResponseHandler: | (id<IResponseHandler>) | handler |
Adds the given IResponseHandler to listen for responses from an IDBLUE device.
handler | The IResponseHandler to receive response notifications |
- (void) addSessionHandler: | (id<ISessionHandler>) | handler |
Adds the given ISessionHandler to receive notifications of session events (open / close, lost / restored, etc).
handler | The ISessionHandler to receive session events |
- (BOOL) addSupportedCommand: | (CommandIdentifier) | commandIdentifier | |
withClassInfo: | (Class) | classInfo | |
- (BOOL) addSupportedProperty: | (PropertyIdentifier) | property | |
withClassInfo: | (Class) | classInfo | |
- (SendStatus *) beep: | (BeepType) | bt |
beep -
Sends a BEEP command to IDBLUE
bt | The BeepType for the beep to be emitted. |
For example:
IDBlueCoreApi* api; -(void) beep: (BeepType) bt { SendStatus status = nil; status = [api beep: bt]; if ([status successful]) { } else { } }
-(void) beepResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) beepFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) beep: | (BeepType) | bt | |
withHandler: | (id<IResponseHandler>) | handler | |
beep -
Sends a BEEP command to IDBLUE
bt | The BeepType for the beep to be emitted. |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) beep: (BeepType) bt { SendStatus status = nil; status = [api beep: bt withHandler: self)]; if ([status successful]) { } else { } }
-(void) beepResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) beepFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) beginCommands |
beginCommands -
Sends a BEGIN-COMMANDS command to IDBLUE
For example:
IDBlueCoreApi* api; -(void) beginCommands { SendStatus status = nil; status = [api beginCommands]; if ([status successful]) { } else { } }
-(void) beginCommandsResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) beginCommandsFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) beginCommands: | (id<IResponseHandler>) | handler |
beginCommands -
Sends a BEGIN-COMMANDS command to IDBLUE
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) beginCommands { SendStatus status = nil; status = [api beginCommands: self]; if ([status successful]) { } else { } }
-(void) beginCommandsResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) beginCommandsFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) clearEntries |
clearEntries -
Sends a CLEAR-ENTRIES command to IDBLUE
For example:
IDBlueCoreApi* api; -(void) clearEntries { SendStatus status = nil; status = [api clearEntries]; if ([status successful]) { } else { } }
-(void) clearEntriesResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) clearEntriesFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) clearEntries: | (id<IResponseHandler>) | handler |
clearEntries -
Sends a CLEAR-ENTRIES command to IDBLUE
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) clearEntries { SendStatus status = nil; status = [api clearEntries: self]; if ([status successful]) { } else { } }
-(void) clearEntriesResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) clearEntriesFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (BOOL) closeSession |
Close the current IDBlueSession
- (BOOL) disable |
Disable the current IDBlueCoreApi
- (BOOL) enable |
Enable the current IDBlueCoreApi
- (BOOL) enabled |
Get whether the current IDBlueCoreApi is enabled
- (SendStatus *) endCommands: | (BOOL) | success |
endCommands -
Sends a END-COMMANDS command to IDBLUE
success | Whether to indicate success or failure |
For example:
IDBlueCoreApi* api; -(void) endCommands: (BOOL) success { SendStatus status = nil; status = [api endCommands: success withHandler: self]; if ([status successful]) { } else { } }
-(void) endCommandsResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) endCommandsFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response {
- (SendStatus *) endCommands: | (BOOL) | success | |
withHandler: | (id<IResponseHandler>) | handler | |
endCommands -
Sends a END-COMMANDS command to IDBLUE
success | Whether to indicate success or failure |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) endCommands: (BOOL) success { SendStatus status = nil; status = [api endCommands: success withHandler: self]; if ([status successful]) { } else { } }
-(void) endCommandsResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) endCommandsFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response {
- (SendStatus *) factoryReset |
factoryReset -
Sends a FACTORY-RESET command to IDBLUE
For example:
IDBlueCoreApi* api; -(void) factoryReset { SendStatus status = nil; status = [api factoryReset]; if ([status successful]) { } else { } }
getActionButtonEnabled -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Action Button Enabled property
For example:
IDBlueCoreApi* api; -(void) getActionButtonEnabled { SendStatus status = nil; status = [api getActionButtonEnabled]; if ([status successful]) { } else { } }
-(void) getActionButtonEnabledResponse: (IDBlueCommand*) command withResponse: (ActionButtonEnabledProperty*) response { BOOL actionButtonEnabled = [response actionButtonEnabled]; }
-(void) getActionButtonEnabledFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getActionButtonEnabled: | (id<IResponseHandler>) | handler |
getActionButtonEnabled -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Action Button Enabled property
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getActionButtonEnabled { SendStatus status = nil; status = [api getActionButtonEnabled: self]; if ([status successful]) { } else { } }
-(void) getActionButtonEnabledResponse: (IDBlueCommand*) command withResponse: (ActionButtonEnabledProperty*) response { BOOL actionButtonEnabled = [response actionButtonEnabled]; }
-(void) getActionButtonEnabledFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getBluetoothName |
getBluetoothName -
Sends a GET-BLUETOOTH-NAME command to IDBLUE
For example:
IDBlueCoreApi* api; -(void) getBluetoothName { SendStatus status = nil; status = [api getBluetoothName]; if ([status successful]) { } else { } }
-(void) getBluetoothNameResponse: (IDBlueCommand*) command withResponse: (GetBluetoothNameResponse*) response { NSString* btName = [response bluetoothName]; }
-(void) getBluetoothNameFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getBluetoothName: | (id<IResponseHandler>) | handler |
getBluetoothName -
Sends a GET-BLUETOOTH-NAME command to IDBLUE
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getBluetoothName { SendStatus status = nil; status = [api getBluetoothName: self]; if ([status successful]) { } else { } }
-(void) getBluetoothNameResponse: (IDBlueCommand*) command withResponse: (GetBluetoothNameResponse*) response { NSString* btName = [response bluetoothName]; }
-(void) getBluetoothNameFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
getBluetoothTimeout -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Bluetooth Timeout property
For example:
IDBlueCoreApi* api; -(void) getBluetoothTimeout { SendStatus status = nil; status = [api getBluetoothTimeout]; if ([status successful]) { } else { } }
-(void) getBluetoothTimeoutResponse: (IDBlueCommand*) command withResponse: (BluetoothTimeoutProperty*) response { byte timeout = [response timeout]; }
-(void) getBluetoothTimeoutFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getBluetoothTimeout: | (id<IResponseHandler>) | handler |
getBluetoothTimeout -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Bluetooth Timeout property
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getBluetoothTimeout { SendStatus status = nil; status = [api getBluetoothTimeout: self]; if ([status successful]) { } else { } }
-(void) getBluetoothTimeoutResponse: (IDBlueCommand*) command withResponse: (BluetoothTimeoutProperty*) response { byte timeout = [response timeout]; }
-(void) getBluetoothTimeoutFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
getBootloaderVersion -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Bootloader Version property
For example:
IDBlueCoreApi* api; -(void) getBootloaderVersion { SendStatus status = nil; status = [api getBootloaderVersion]; if ([status successful]) { } else { } }
-(void) getBootloaderVersionResponse: (IDBlueCommand*) command withResponse: (BootloaderVersionProperty*) response { NSString* version = [response bootloaderVersion]; }
-(void) getBootloaderVersionFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getBootloaderVersion: | (id<IResponseHandler>) | handler |
getBootloaderVersion -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Bootloader Version property
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getBootloaderVersion { SendStatus status = nil; status = [api getBootloaderVersion: self]; if ([status successful]) { } else { } }
-(void) getBootloaderVersionResponse: (IDBlueCommand*) command withResponse: (BootloaderVersionProperty*) response { NSString* version = [response bootloaderVersion]; }
-(void) getBootloaderVersionFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getBuzzerEnabled |
getBuzzerEnabled -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Buzzer Enabled property
For example:
IDBlueCoreApi* api; -(void) getBuzzerEnabled { SendStatus status = nil; status = [api getBuzzerEnabled]; if ([status successful]) { } else { } }
-(void) getBuzzerEnabledResponse: (IDBlueCommand*) command withResponse: (BuzzerEnabledProperty*) response { BOOL enabled = [response buzzerEnabled]; }
-(void) getBuzzerEnabledFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getBuzzerEnabled: | (id<IResponseHandler>) | handler |
getBuzzerEnabled -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Buzzer Enabled property
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getBuzzerEnabled { SendStatus status = nil; status = [api getBuzzerEnabled: self]; if ([status successful]) { } else { } }
-(void) getBuzzerEnabledResponse: (IDBlueCommand*) command withResponse: (BuzzerEnabledProperty*) response { BOOL enabled = [response buzzerEnabled]; }
-(void) getBuzzerEnabledFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getConnectedMode |
getConnectedMode -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Connected Mode property
For example:
IDBlueCoreApi* api; -(void) getConnectedMode { SendStatus status = nil; status = [api getConnectedMode]; if ([status successful]) { } else { } }
-(void) getConnectedModeResponse: (IDBlueCommand*) command withResponse: (ConnectedModeProperty*) response { ConnectedMode mode = [response connectedMode]; }
-(void) getConnectedModeFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getConnectedMode: | (id<IResponseHandler>) | handler |
getConnectedMode -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Connected Mode property
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getConnectedMode { SendStatus status = nil; status = [api getConnectedMode: self]; if ([status successful]) { } else { } }
-(void) getConnectedModeResponse: (IDBlueCommand*) command withResponse: (ConnectedModeProperty*) response { ConnectedMode mode = [response connectedMode]; }
-(void) getConnectedModeFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getConnectToHost |
getConnectToHost -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Connect to Host property
For example:
IDBlueCoreApi* api; -(void) getConnectToHost { SendStatus status = nil; status = [api getConnectToHost]; if ([status successful]) { } else { } }
-(void) getConnectToHostResponse: (IDBlueCommand*) command withResponse: (ConnectToHostProperty*) response { BOOL connectToHost = [response connectToHost]; }
-(void) getConnectToHostFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getConnectToHost: | (id<IResponseHandler>) | handler |
getConnectToHost -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Connect to Host property
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getConnectToHost { SendStatus status = nil; status = [api getConnectToHost: self]; if ([status successful]) { } else { } }
-(void) getConnectToHostResponse: (IDBlueCommand*) command withResponse: (ConnectToHostProperty*) response { BOOL connectToHost = [response connectToHost]; }
-(void) getConnectToHostFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
getContinuousScanEnabled -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Continuous Scan Eanbled property
For example:
IDBlueCoreApi* api; -(void) getContinuousScanEnabled { SendStatus status = nil; status = [api getContinuousScanEnabled]; if ([status successful]) { } else { } }
-(void) getContinuousScanEnabledResponse: (IDBlueCommand*) command withResponse: (ContinuousScanEnabledProperty*) response { BOOL enabled = [response continuousScanEnabled]; }
-(void) getContinuousScanEnabledFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getContinuousScanEnabled: | (id<IResponseHandler>) | handler |
getContinuousScanEnabled -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Continuous Scan Eanbled property
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getContinuousScanEnabled { SendStatus status = nil; status = [api getContinuousScanEnabled: self]; if ([status successful]) { } else { } }
-(void) getContinuousScanEnabledResponse: (IDBlueCommand*) command withResponse: (ContinuousScanEnabledProperty*) response { BOOL enabled = [response continuousScanEnabled]; }
-(void) getContinuousScanEnabledFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
getContinuousScanTimeout -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Continuous Scan Timeout property
For example:
IDBlueCoreApi* api; -(void) getContinuousScanTimeout { SendStatus status = nil; status = [api getContinuousScanTimeout]; if ([status successful]) { } else { } }
-(void) getContinuousScanTimeoutResponse: (IDBlueCommand*) command withResponse: (ContinuousScanTimeoutProperty*) response { byte timeout = [response timeout]; }
-(void) getContinuousScanTimeoutFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getContinuousScanTimeout: | (id<IResponseHandler>) | handler |
getContinuousScanTimeout -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Continuous Scan Timeout property
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getContinuousScanTimeout { SendStatus status = nil; status = [api getContinuousScanTimeout: self]; if ([status successful]) { } else { } }
-(void) getContinuousScanTimeoutResponse: (IDBlueCommand*) command withResponse: (ContinuousScanTimeoutProperty*) response { byte timeout = [response timeout]; }
-(void) getContinuousScanTimeoutFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getDeviceTimeout |
getDeviceTimeout -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Device Timeout property
For example:
IDBlueCoreApi* api; -(void) getDeviceTimeout { SendStatus status = nil; status = [api getDeviceTimeout]; if ([status successful]) { } else { } }
-(void) getDeviceTimeoutResponse: (IDBlueCommand*) command withResponse: (DeviceTimeoutProperty*) response { byte timeout = [response timeout]; }
-(void) getDeviceTimeoutFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getDeviceTimeout: | (id<IResponseHandler>) | handler |
getDeviceTimeout -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Device Timeout property
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getDeviceTimeout { SendStatus status = nil; status = [api getDeviceTimeout: self]; if ([status successful]) { } else { } }
-(void) getDeviceTimeoutResponse: (IDBlueCommand*) command withResponse: (DeviceTimeoutProperty*) response { byte timeout = [response timeout]; }
-(void) getDeviceTimeoutFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
getDisconnectedMode -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Disconnected Mode property
For example:
IDBlueCoreApi* api; -(void) getDisconnectedMode { SendStatus status = nil; status = [api getDisconnectedMode]; if ([status successful]) { } else { } }
-(void) getDisconnectedModeResponse: (IDBlueCommand*) command withResponse: (DisconnectedModeProperty*) response { DisconnectedMode mode = [response disconnectedMode]; }
-(void) getDisconnectedModeFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getDisconnectedMode: | (id<IResponseHandler>) | handler |
getDisconnectedMode -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Disconnected Mode property
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getDisconnectedMode { SendStatus status = nil; status = [api getDisconnectedMode: self]; if ([status successful]) { } else { } }
-(void) getDisconnectedModeResponse: (IDBlueCommand*) command withResponse: (DisconnectedModeProperty*) response { DisconnectedMode mode = [response disconnectedMode]; }
-(void) getDisconnectedModeFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
getDuplicateElimination -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Duplicate Elimination property
For example:
IDBlueCoreApi* api; -(void) getDupElim { SendStatus status = nil; status = [api getDuplicateElimination]; if ([status successful]) { } else { } }
-(void) getDuplicateEliminationResponse: (IDBlueCommand*) command withResponse: (DuplicateEliminationProperty*) response { ushort dupElim = [response duplicateElimination]; }
-(void) getDuplicateEliminationFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getDuplicateElimination: | (id<IResponseHandler>) | handler |
getDuplicateElimination -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Duplicate Elimination property
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getDupElim { SendStatus status = nil; status = [api getDuplicateElimination: self]; if ([status successful]) { } else { } }
-(void) getDuplicateEliminationResponse: (IDBlueCommand*) command withResponse: (DuplicateEliminationProperty*) response { ushort dupElim = [response duplicateElimination]; }
-(void) getDuplicateEliminationFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
getEnforceTimestamp -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Enforce Timestamp property
For example:
IDBlueCoreApi* api; -(void) getEnforceTimestamp { SendStatus status = nil; status = [api getEnforceTimestamp]; if ([status successful]) { } else { } }
-(void) getEnforceTimestampResponse: (IDBlueCommand*) command withResponse: (EnforceTimestampProperty*) response { BOOL enforce = [response enforceTimestamp]; }
-(void) getEnforceTimestampFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getEnforceTimestamp: | (id<IResponseHandler>) | handler |
getEnforceTimestamp -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Enforce Timestamp property
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getEnforceTimestamp { SendStatus status = nil; status = [api getEnforceTimestamp: self]; if ([status successful]) { } else { } }
-(void) getEnforceTimestampResponse: (IDBlueCommand*) command withResponse: (EnforceTimestampProperty*) response { BOOL enforce = [response enforceTimestamp]; }
-(void) getEnforceTimestampFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getEntry: | (int) | index |
getEntry -
Sends a GET-ENTRY command to IDBLUE
index | An index between 0 and n-1 (n being the number of entries) |
For example:
IDBlueCoreApi* api; -(void) getEntry: (int) index { SendStatus status = nil; status = [api getEntry: index]; if ([status successful]) { } else { } }
-(void) getEntryResponse: (IDBlueCommand*) command withResponse: (GetEntryResponse*) response { RfidTag* tag = [response rfidTag]; IDBlueTimestamp* ts = [response scanTime]; byte data = [response blockData]; }
-(void) getEntryFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getEntry: | (int) | index | |
withHandler: | (id<IResponseHandler>) | handler | |
getEntry -
Sends a GET-ENTRY command to IDBLUE
index | An index between 0 and n-1 (n being the number of entries) |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getEntry: (int) index { SendStatus status = nil; status = [api getEntry: index withHandler: self]; if ([status successful]) { } else { } }
-(void) getEntryResponse: (IDBlueCommand*) command withResponse: (GetEntryResponse*) response { RfidTag* tag = [response rfidTag]; IDBlueTimestamp* ts = [response scanTime]; byte data = [response blockData]; }
-(void) getEntryFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getEntryCount |
getEntryCount -
Sends a GET-ENTRY-COUNT command to IDBLUE
For example:
IDBlueCoreApi* api; -(void) getEntryCount { SendStatus status = nil; status = [api getEntryCount]; if ([status successful]) { } else { } }
-(void) getEntryCountResponse: (IDBlueCommand*) command withResponse: (GetEntryCountResponse*) response { int entryCount = [response entryCount]; }
-(void) getEntryCountFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getEntryCount: | (id<IResponseHandler>) | handler |
getEntryCount -
Sends a GET-ENTRY-COUNT command to IDBLUE
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getEntryCount { SendStatus status = nil; status = [api getEntryCount: self]; if ([status successful]) { } else { } }
-(void) getEntryCountResponse: (IDBlueCommand*) command withResponse: (GetEntryCountResponse*) response { int entryCount = [response entryCount]; }
-(void) getEntryCountFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getHoldToScan |
getHoldToScan -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Hold to Scan property
For example:
IDBlueCoreApi* api; -(void) getHoldToScanEnabled { SendStatus status = nil; status = [api getHoldToScan]; if ([status successful]) { } else { } }
-(void) getHoldToScanResponse: (IDBlueCommand*) command withResponse: (HoldToScanEnabledProperty*) response { BOOL enabled = [response holdToScanEnabled]; }
-(void) getHoldToScanFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getHoldToScan: | (id<IResponseHandler>) | handler |
getHoldToScan -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Hold to Scan property
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getHoldToScanEnabled { SendStatus status = nil; status = [api getHoldToScan: self]; if ([status successful]) { } else { } }
-(void) getHoldToScanResponse: (IDBlueCommand*) command withResponse: (HoldToScanEnabledProperty*) response { BOOL enabled = [response holdToScanEnabled]; }
-(void) getHoldToScanFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getProperty: | (PropertyIdentifier) | property | |
withHandler: | (id<IResponseHandler>) | handler | |
- (SendStatus *) getRfidProtocol |
getRfidProtocol -
Sends a CI_GET_PROPERTY command to IDBLUE to get the RFID Protocol property
For example:
IDBlueCoreApi* api; -(void) getRfidProtocol { SendStatus status = nil; status = [api getRfidProtocol]; if ([status successful]) { } else { } }
-(void) getRfidProtocolResponse: (IDBlueCommand*) command withResponse: (RfidProtocolProperty*) response { RfidProtocol protocol = [response rfidProtocol]; }
-(void) getRfidProtocolFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getRfidProtocol: | (id<IResponseHandler>) | handler |
getRfidProtocol -
Sends a CI_GET_PROPERTY command to IDBLUE to get the RFID Protocol property
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getRfidProtocol { SendStatus status = nil; status = [api getRfidProtocol: self]; if ([status successful]) { } else { } }
-(void) getRfidProtocolResponse: (IDBlueCommand*) command withResponse: (RfidProtocolProperty*) response { RfidProtocol protocol = [response rfidProtocol]; }
-(void) getRfidProtocolFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getRfidTimeout |
getRfidTimeout -
Sends a CI_GET_PROPERTY command to IDBLUE to get the RFID timeout property
For example:
IDBlueCoreApi* api; -(void) getRfidTimeout { SendStatus status = nil; status = [api getRfidTimeout]; if ([status successful]) { } else { } }
-(void) getRfidTimeoutResponse: (IDBlueCommand*) command withResponse: (RfidTimeoutProperty*) response { byte timeout = [response rfidTimeout]; }
-(void) getRfidTimeoutFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getRfidTimeout: | (id<IResponseHandler>) | handler |
getRfidTimeout -
Sends a CI_GET_PROPERTY command to IDBLUE to get the RFID timeout property
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getRfidTimeout { SendStatus status = nil; status = [api getRfidTimeout: self]; if ([status successful]) { } else { } }
-(void) getRfidTimeoutResponse: (IDBlueCommand*) command withResponse: (RfidTimeoutProperty*) response { byte timeout = [response rfidTimeout]; }
-(void) getRfidTimeoutFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getStatus |
getStatus -
Sends a GET-STATUS command to IDBLUE
For example:
IDBlueCoreApi* api; -(void) getStatus { SendStatus status = nil; status = [api getStatus]; if ([status successful]) { } else { } }
-(void) getStatusResponse: (IDBlueCommand*) command withResponse: (GetStatusResponse*) response { byte batteryLevel = [response batteryLevel]; NSString* hardwareVersion = [response hardwareVersion]; NSString* firmwareVersion = [response firmwareVersion]; }
-(void) getStatusFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getStatus: | (id<IResponseHandler>) | handler |
getStatus -
Sends a GET-STATUS command to IDBLUE
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getStatus { SendStatus status = nil; status = [api getStatus: self]; if ([status successful]) { } else { } }
-(void) getStatusResponse: (IDBlueCommand*) command withResponse: (GetStatusResponse*) response { byte batteryLevel = [response batteryLevel]; NSString* hardwareVersion = [response hardwareVersion]; NSString* firmwareVersion = [response firmwareVersion]; }
-(void) getStatusFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getTimestamp |
getTimestamp -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Timestamp property
For example:
IDBlueCoreApi* api; -(void) getTimestamp { SendStatus status = nil; status = [api getTimestamp]; if ([status successful]) { } else { } }
-(void) getTimestampResponse: (IDBlueCommand*) command withResponse: (TimestampProperty*) response; IDBlueTimestamp* ts = [response idblueTimestamp]; }
-(void) getTimestampFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getTimestamp: | (id<IResponseHandler>) | handler |
getTimestamp -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Timestamp property
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getTimestamp { SendStatus status = nil; status = [api getTimestamp: self]; if ([status successful]) { } else { } }
-(void) getTimestampResponse: (IDBlueCommand*) command withResponse: (TimestampProperty*) response; IDBlueTimestamp* ts = [response idblueTimestamp]; }
-(void) getTimestampFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getVersionInfo |
getVersionInfo -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Version Info property
For example:
IDBlueCoreApi* api; -(void) getVersionInfo { SendStatus status = nil; status = [api getVersionInfo]; if ([status successful]) { } else { } }
-(void) getVersionInfoResponse: (IDBlueCommand*) command withResponse: (VersionInfoProperty*) response { NSString* version = [response firmwareVersion]; }
-(void) getVersionInfoFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) getVersionInfo: | (id<IResponseHandler>) | handler |
getVersionInfo -
Sends a CI_GET_PROPERTY command to IDBLUE to get the Version Info property
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getVersionInfo { SendStatus status = nil; status = [api getVersionInfo: self]; if ([status successful]) { } else { } }
-(void) getVersionInfoResponse: (IDBlueCommand*) command withResponse: (VersionInfoProperty*) response { NSString* version = [response firmwareVersion]; }
-(void) getVersionInfoFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (BOOL) hasResponseHandler: | (id<IResponseHandler>) | handler |
Determines if the given IResponseHandler is contained in the list of handlers that are notified of responses received from an IDBLUE device.
- (id) initWithSession: | (IDBlueSession*) | session |
Initialize the IDBlueCoreApi with the given IDBlueSession
session | The IDBlueSession to use to communicate with an IDBLUE device |
- (BOOL) isSessionOpen |
Get whether the current IDBlueSession is open.
- (SendStatus *) loadProperties |
loadProperties -
Sends a LOAD-PROPERTIES command to IDBLUE
For example:
IDBlueCoreApi* api; -(void) loadProperties { SendStatus status = nil; status = [api loadProperties]; if ([status successful]) { } else { } }
-(void) loadPropertiesResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) loadPropertiesFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) loadProperties: | (id<IResponseHandler>) | handler |
loadProperties -
Sends a LOAD-PROPERTIES command to IDBLUE
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) loadProperties { SendStatus status = nil; status = [api loadProperties: self]; if ([status successful]) { } else { } }
-(void) loadPropertiesResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) loadPropertiesFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) noOp |
noOp -
Sends a NO-OP command to IDBLUE.
For example:
IDBlueCoreApi* api; -(void) noOp { SendStatus status = nil; status = [api noOp]; if ([status successful]) { } else { } }
-(void) noOpResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) noOpFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) noOp: | (id<IResponseHandler>) | handler |
noOp -
Sends a NO-OP command to IDBLUE
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) noOp { SendStatus status = nil; status = [api noOp: self]; if ([status successful]) { } else { } }
-(void) noOpResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) noOpFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (BOOL) openSession |
Open a session to the current IDBLUE device. You must use one of the platform specific setDevice methods before calling openSession.
- (SendStatus *) powerDown |
powerDown -
Sends a POWER-DOWN command to IDBLUE
For example:
IDBlueCoreApi* api; -(void) powerDown { SendStatus status = nil; status = [api powerDown]; if ([status successful]) { } else { } }
- (SendStatus *) readTagId |
readTagId -
Sends a GET-TAG-ID command to IDBLUE
For example:
IDBlueCoreApi* api; -(void) getStatus { SendStatus status = nil; status = [api readTagId]; if ([status successful]) { } else { } }
-(void) readTagIdResponse: (IDBlueCommand*) command withResponse: (ReadTagIdResponse*) response { RfidTag* tag = [response rfidTag]; IDBlueTimestamp* ts = [response scanTime]; }
-(void) readTagIdFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) readTagId: | (id<IResponseHandler>) | handler |
readTagId -
Sends a GET-TAG-ID command to IDBLUE
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) getStatus { SendStatus status = nil; status = [api readTagId: self]; if ([status successful]) { } else { } }
-(void) readTagIdResponse: (IDBlueCommand*) command withResponse: (ReadTagIdResponse*) response { RfidTag* tag = [response rfidTag]; IDBlueTimestamp* ts = [response scanTime]; }
-(void) readTagIdFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (void) removeResponseHandler: | (id<IResponseHandler>) | handler |
Remove the given IResponseHandler from receiving response notifications from IDBLUE devices.
handler | The IResponseHandler to remove |
- (void) removeSessionHandler: | (id<ISessionHandler>) | handler |
Removes the given ISessionHandler from receiving notifications of session events.
handler | The ISessionHandler to remove from receiving session events |
- (SendStatus *) saveProperties |
saveProperties -
Sends a SAVE-PROPERTIES command to IDBLUE
For example:
IDBlueCoreApi* api; -(void) saveProperties { SendStatus status = nil; status = [api saveProperties: self]; if ([status successful]) { } else { } }
-(void) savePropertiesResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) savePropertiesFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) saveProperties: | (id<IResponseHandler>) | handler |
saveProperties -
Sends a SAVE-PROPERTIES command to IDBLUE
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) saveProperties { SendStatus status = nil; status = [api saveProperties: self]; if ([status successful]) { } else { } }
-(void) savePropertiesResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) savePropertiesFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (NSString *) sdkVersion |
Get the version of the IDBLUE SDK
- (SendStatus *) sendCommand: | (IDBlueCommand*) | command | |
withHandler: | (id<IResponseHandler>) | handler | |
sendCommand -
Sends a command to the connected IDBLUE device. When a response is received, the command's callback method will be invoked.
command | the command to be sent to IDBLUE |
handler | An object implementing IResponseHandler |
The callback method defined by handler/selector will be called when a response is received from IDBLUE. The parameter will be an IDBlueCommand object containing an IDBlueResponse
- (IDBlueSession *) session |
Gets the current IDBlueSession
- (SendStatus *) setActionButtonEnabled: | (BOOL) | actionButtonEnabled |
setActionButtonEnabled -
Sends a CI_SET_PROPERTY command to IDBLUE to set the Action Button Enabled property.
actionButtonEnabled |
For example:
IDBlueCoreApi* api; -(void) setActionButtonEnabled: (BOOL) actionButtonEnabled { SendStatus status = nil; status = [api setActionButtonEnabled: actionButtonEnabled]; if ([status successful]) { } else { } }
-(void) setActionButtonEnabledResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setActionButtonEnabledFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setActionButtonEnabled: | (BOOL) | actionButtonEnabled | |
withHandler: | (id<IResponseHandler>) | handler | |
setActionButtonEnabled -
Sends a CI_SET_PROPERTY command to IDBLUE to set the Action Button Enabled property.
actionButtonEnabled | |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) setActionButtonEnabled: (BOOL) actionButtonEnabled { SendStatus status = nil; status = [api setActionButtonEnabled: actionButtonEnabled withHandler: self]; if ([status successful]) { } else { } }
-(void) setActionButtonEnabledResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setActionButtonEnabledFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus*) setBluetoothName: | (id) | btName |
setBluetoothName -
Sends a STORE-BLUETOOTH-NAME command to IDBLUE
btName |
For example:
IDBlueCoreApi* api; -(void) setBtName { SendStatus status = nil; status = [api setBluetoothName: "My IDBLUE Device"]; if ([status successful]) { } else { } }
-(void) setBluetoothNameResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setBluetoothNameFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setBluetoothName: | (NSString*) | btName | |
withHandler: | (id<IResponseHandler>) | handler | |
setBluetoothName -
Sends a STORE-BLUETOOTH-NAME command to IDBLUE
btName | |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) setBtName { SendStatus status = nil; status = [api setBluetoothName: "My IDBLUE Device" withHandler: self]; if ([status successful]) { } else { } }
-(void) setBluetoothNameResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setBluetoothNameFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setBluetoothPin: | (NSString*) | pin |
setBluetoothPin -
Sends a STORE-BLUETOOTH-PIN command to IDBLUE
pin |
For example:
IDBlueCoreApi* api; -(void) setBtPin { SendStatus status = nil; status = [api setBluetoothPin: "1234"]; if ([status successful]) { } else { } }
-(void) setBluetoothPinResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setBluetoothPinFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setBluetoothPin: | (NSString*) | pin | |
withHandler: | (id<IResponseHandler>) | handler | |
setBluetoothPin -
Sends a STORE-BLUETOOTH-PIN command to IDBLUE
pin | |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) setBtPin { SendStatus status = nil; status = [api setBluetoothPin: "1234" withHandler: self]; if ([status successful]) { } else { } }
-(void) setBluetoothPinResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setBluetoothPinFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setBluetoothTimeout: | (byte) | timeout |
setBluetoothTimeout -
Sends a CI_SET_PROPERTY command to IDBLUE to set the Bluetooth timeout property.
timeout |
For example:
IDBlueCoreApi* api; -(void) setBluetoothTimeout: (byte) timeout { SendStatus status = nil; status = [api setBluetoothTimeout: timeout]; if ([status successful]) { } else { } }
-(void) setBluetoothTimeoutResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setBluetoothTimeoutFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setBluetoothTimeout: | (byte) | timeout | |
withHandler: | (id<IResponseHandler>) | handler | |
setBluetoothTimeout -
Sends a CI_SET_PROPERTY command to IDBLUE to set the Bluetooth timeout property.
timeout | |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) setBluetoothTimeout: (byte) timeout { SendStatus status = nil; status = [api setBluetoothTimeout: timeout withHandler: self]; if ([status successful]) { } else { } }
-(void) setBluetoothTimeoutResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setBluetoothTimeoutFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setBuzzerEnabled: | (BOOL) | enabled |
setBuzzerEnabled -
Sends a CI_SET_PROPERTY command to IDBLUE to set the Buzzer Enabled property.
enabled |
For example:
IDBlueCoreApi* api; -(void) setBuzzerEnabled: (BOOL) enable { SendStatus status = nil; status = [api setBuzzerEnabled: enable]; if ([status successful]) { } else { } }
-(void) setBuzzerEnabledResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setBuzzerEnabledFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setBuzzerEnabled: | (BOOL) | enabled | |
withHandler: | (id<IResponseHandler>) | handler | |
setBuzzerEnabled -
Sends a CI_SET_PROPERTY command to IDBLUE to set the Buzzer Enabled property.
enabled | |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) setBuzzerEnabled: (BOOL) enable { SendStatus status = nil; status = [api setBuzzerEnabled: enable withHandler: self]; if ([status successful]) { } else { } }
-(void) setBuzzerEnabledResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setBuzzerEnabledFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setConnectedMode: | (ConnectedMode) | mode |
setConnectedMode -
Sets the connected mode operation of the IDBLUE device.
mode | The connected mode to bet set. |
For example:
IDBlueCoreApi* api; -(void) setConnectedMode: (ConnectedMode) mode { SendStatus status = nil; status = [api setConnectedMode: mode]; if ([status successful]) { } else { } }
-(void) setConnectedModeResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setConnectedModeFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setConnectedMode: | (ConnectedMode) | mode | |
withHandler: | (id<IResponseHandler>) | handler | |
setConnectedMode -
Sets the connected mode operation of the IDBLUE device.
mode | The connected mode to bet set. |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) setConnectedMode: (ConnectedMode) mode { SendStatus status = nil; status = [api setConnectedMode: mode withHandler: self]; if ([status successful]) { } else { } }
-(void) setConnectedModeResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setConnectedModeFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setConnectToHost: | (BOOL) | connectToHost |
setConnectToHost -
Sends a CI_SET_PROPERTY command to IDBLUE to set the Connect to Host property.
connectToHost |
For example:
IDBlueCoreApi* api; -(void) setConnectToHost: (BOOL) connectToHost { SendStatus status = nil; status = [api setConnectToHost: connectToHost withHandler: self]; if ([status successful]) { } else { } }
-(void) setConnectToHostResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setConnectToHostFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setConnectToHost: | (BOOL) | connectToHost | |
withHandler: | (id<IResponseHandler>) | handler | |
setConnectToHost -
Sends a CI_SET_PROPERTY command to IDBLUE to set the Connect to Host property.
connectToHost | |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) setConnectToHost: (BOOL) connectToHost { SendStatus status = nil; status = [api setConnectToHost: connectToHost withHandler: self]; if ([status successful]) { } else { } }
-(void) setConnectToHostResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setConnectToHostFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setContinuousScanEnabled: | (BOOL) | enabled |
setContinuousScanEnabled -
Sends a CI_SET_PROPERTY command to IDBLUE to set the Continuous Scan Enabled property.
enabled |
For example:
IDBlueCoreApi* api; -(void) setContinuousScanEnabled: (BOOL) enable { SendStatus status = nil; status = [api setContinuousScanEnabled: enable]; if ([status successful]) { } else { } }
-(void) setContinuousScanEnabledResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setContinuousScanEnabledFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setContinuousScanEnabled: | (BOOL) | enabled | |
withHandler: | (id<IResponseHandler>) | handler | |
setContinuousScanEnabled -
Sends a CI_SET_PROPERTY command to IDBLUE to set the Continuous Scan Enabled property.
enabled | |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) setContinuousScanEnabled: (BOOL) enable { SendStatus status = nil; status = [api setContinuousScanEnabled: enable withHandler: self]; if ([status successful]) { } else { } }
-(void) setContinuousScanEnabledResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setContinuousScanEnabledFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setContinuousScanTimeout: | (byte) | timeout |
setContinuousScanTimeout -
Sends a CI_SET_PROPERTY command to IDBLUE to set the continuous scan timeout property.
timeout |
For example:
IDBlueCoreApi* api; -(void) setContinuousScanTimeout: (byte) timeout { SendStatus status = nil; status = [api setContinuousScanTimeout: timeout]; if ([status successful]) { } else { } }
-(void) setContinuousScanTimeoutResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setContinuousScanTimeoutFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setContinuousScanTimeout: | (byte) | timeout | |
withHandler: | (id<IResponseHandler>) | handler | |
setContinuousScanTimeout -
Sends a CI_SET_PROPERTY command to IDBLUE to set the continuous scan timeout property.
timeout | |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) setContinuousScanTimeout: (byte) timeout { SendStatus status = nil; status = [api setContinuousScanTimeout: timeout withHandler: self]; if ([status successful]) { } else { } }
-(void) setContinuousScanTimeoutResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setContinuousScanTimeoutFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setDeviceTimeout: | (byte) | timeout |
setDeviceTimeout -
Sends a CI_SET_PROPERTY command to IDBLUE to set the device timeout property.
timeout |
For example:
IDBlueCoreApi* api; -(void) setDeviceTimeout: (byte) timeout { SendStatus status = nil; status = [api setDeviceTimeout: timeout]; if ([status successful]) { } else { } }
-(void) setDeviceTimeoutResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setDeviceTimeoutFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setDeviceTimeout: | (byte) | timeout | |
withHandler: | (id<IResponseHandler>) | handler | |
setDeviceTimeout -
Sends a CI_SET_PROPERTY command to IDBLUE to set the device timeout property.
timeout | |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) setDeviceTimeout: (byte) timeout { SendStatus status = nil; status = [api setDeviceTimeout: timeout withHandler: self]; if ([status successful]) { } else { } }
-(void) setDeviceTimeoutResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setDeviceTimeoutFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setDisconnectedMode: | (DisconnectedMode) | mode |
setDisconnectedMode -
Sets the disconnected mode operation of the IDBLUE device.
mode | The disconnected mode to be set |
For example:
IDBlueCoreApi* api; -(void) setDisconnectedMode: (DisconnectedMode) mode { SendStatus status = nil; status = [api setDisconnectedMode: mode]; if ([status successful]) { } else { } }
-(void) setDisconnectedModeResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setDisconnectedModeFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setDisconnectedMode: | (DisconnectedMode) | mode | |
withHandler: | (id<IResponseHandler>) | handler | |
setDisconnectedMode -
Sets the disconnected mode operation of the IDBLUE device.
mode | The disconnected mode to be set |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) setDisconnectedMode: (DisconnectedMode) mode { SendStatus status = nil; status = [api setDisconnectedMode: mode withHandler: self]; if ([status successful]) { } else { } }
-(void) setDisconnectedModeResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setDisconnectedModeFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setDuplicateElimination: | (ushort) | dupElim |
setDuplicateElimination -
Sends a CI_SET_PROPERTY command to IDBLUE to set the duplicate elimination property.
dupElim |
For example:
IDBlueCoreApi* api; -(void) setDuplicateElimination: (ushort) dupElim { SendStatus status = nil; status = [api setDuplicateElimination: dupElim]; if ([status successful]) { } else { } }
-(void) setDuplicateEliminationResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setDuplicateEliminationFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setDuplicateElimination: | (ushort) | dupElim | |
withHandler: | (id<IResponseHandler>) | handler | |
setDuplicateElimination -
Sends a CI_SET_PROPERTY command to IDBLUE to set the duplicate elimination property.
dupElim | |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) setDuplicateElimination: (ushort) dupElim { SendStatus status = nil; status = [api setDuplicateElimination: dupElim withHandler: self]; if ([status successful]) { } else { } }
-(void) setDuplicateEliminationResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setDuplicateEliminationFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setEnforceTimestamp: | (BOOL) | enforce |
setEnforceTimestamp -
Sets the enforce timestamp property of an IDBLUE device.
enforce | Whether to enforce a timestamp be required when storing tags to onboard memory of an IDBLUE device. |
For example:
IDBlueCoreApi* api; -(void) setEnforceTimestamp: (BOOL) enforce { SendStatus status = nil; status = [api setEnforceTimestamp: enforce]; if ([status successful]) { } else { } }
-(void) setEnforceTimestampResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setEnforceTimestampFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setEnforceTimestamp: | (BOOL) | enforce | |
withHandler: | (id<IResponseHandler>) | handler | |
setEnforceTimestamp -
Sets the enforce timestamp property of an IDBLUE device.
enforce | Whether to enforce a timestamp be required when storing tags to onboard memory of an IDBLUE device. |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) setEnforceTimestamp: (BOOL) enforce { SendStatus status = nil; status = [api setEnforceTimestamp: enforce withHandler: self]; if ([status successful]) { } else { } }
-(void) setEnforceTimestampResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setEnforceTimestampFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setHoldToScan: | (BOOL) | enabled |
setHoldToScan -
Sends a CI_SET_PROPERTY command to IDBLUE to set the Hold to Scan property.
enabled |
For example:
IDBlueCoreApi* api; -(void) setHoldToScanEnabled: (BOOL) enable { SendStatus status = nil; status = [api setHoldToScan: enable]; if ([status successful]) { } else { } }
-(void) setHoldToScanResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setHoldToScanFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setHoldToScan: | (BOOL) | enabled | |
withHandler: | (id<IResponseHandler>) | handler | |
setHoldToScan -
Sends a CI_SET_PROPERTY command to IDBLUE to set the Hold to Scan property.
enabled | |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) setHoldToScanEnabled: (BOOL) enable { SendStatus status = nil; status = [api setHoldToScan: enable withHandler: self]; if ([status successful]) { } else { } }
-(void) setHoldToScanResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setHoldToScanFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setProperty: | (id<IResponseHandler>) | handler | |
withProperty: | (PropertyIdentifier) | property | |
withArgs: | (void*) | args | |
- (SendStatus *) setRfidProtocol: | (RfidProtocol) | protocol |
setRfidProtocol -
Sets the RFID protocol property of an IDBLUE device.
protocol | The RfidProtocol to be set |
For example:
IDBlueCoreApi* api; -(void) setRfidProtocol: (RfidProtocol) protocol { SendStatus status = nil; status = [api setRfidProtocol: protocol]; if ([status successful]) { } else { } }
-(void) setRfidProtocolResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setRfidProtocolFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setRfidProtocol: | (RfidProtocol) | protocol | |
withHandler: | (id<IResponseHandler>) | handler | |
setRfidProtocol -
Sets the RFID protocol property of an IDBLUE device.
protocol | The RfidProtocol to be set |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) setRfidProtocol: (RfidProtocol) protocol { SendStatus status = nil; status = [api setRfidProtocol: protocol withHandler: self]; if ([status successful]) { } else { } }
-(void) setRfidProtocolResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setRfidProtocolFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setRfidTimeout: | (byte) | timeout |
setRfidTimeout -
Sends a CI_SET_PROPERTY command to IDBLUE to set the RFID timeout property.
timeout |
For example:
IDBlueCoreApi* api; -(void) setRfidTimeout: (byte) timeout { SendStatus status = nil; status = [api setRfidTimeout: timeout]; if ([status successful]) { } else { } }
-(void) setRfidTimeoutResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setRfidTimeoutFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setRfidTimeout: | (byte) | timeout | |
withHandler: | (id<IResponseHandler>) | handler | |
setRfidTimeout -
Sends a CI_SET_PROPERTY command to IDBLUE to set the RFID timeout property.
timeout | |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) setRfidTimeout: (byte) timeout { SendStatus status = nil; status = [api setRfidTimeout: timeout withHandler: self]; if ([status successful]) { } else { } }
-(void) setRfidTimeoutResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setRfidTimeoutFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setScanning: | (BOOL) | enable |
setScanning -
Sends a SET-SCANNING command to IDBLUE
For example:
IDBlueCoreApi* api; -(void) setScanning: (BOOL) enabled { SendStatus status = nil; status = [api setScanning: enabled]; if ([status successful]) { } else { } }
-(void) setScanningResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setScanningFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setScanning: | (BOOL) | enable | |
withHandler: | (id<IResponseHandler>) | handler | |
setScanning -
Sends a SET-SCANNING command to IDBLUE
enable | Whether set scanning is to be enabled or disabled. |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) setScanning: (BOOL) enabled { SendStatus status = nil; status = [api setScanning: enabled withHandler: self]; if ([status successful]) { } else { } }
-(void) setScanningResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setScanningFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setTimestamp: | (IDBlueTimestamp*) | timestamp |
setTimestamp -
Sends a CI_SET_PROPERTY command to IDBLUE to set the timestamp property
timestamp |
For example:
IDBlueCoreApi* api; -(void) setTimestamp { SendStatus status = nil; NSDate* now = [[NSDate alloc] init]]; IDBlueTimestamp* ts = [IDBlueTimestamp alloc] initFromNSDate: now];
status = [api setTimestamp: ts]; if ([status successful]) { } else { } [ts release]; [date release]; }
-(void) setTimestampResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setTimestampFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) setTimestamp: | (IDBlueTimestamp*) | timestamp | |
withHandler: | (id<IResponseHandler>) | handler | |
setTimestamp -
Sends a CI_SET_PROPERTY command to IDBLUE to set the timestamp property
timestamp | |
handler | An object implementing IResponseHandler that will receive response notifications. |
For example:
IDBlueCoreApi* api; -(void) setTimestamp { SendStatus status = nil; NSDate* now = [[NSDate alloc] init]]; IDBlueTimestamp* ts = [IDBlueTimestamp alloc] initFromNSDate: now];
status = [api setTimestamp: ts withHandler: self]; if ([status successful]) { } else { } [ts release]; [date release]; }
-(void) setTimestampResponse: (IDBlueCommand*) command withResponse: (IDBlueResponse*) response { } -(void) setTimestampFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }
- (SendStatus *) turnOffBluetooth |
turnOffBluetooth -
Sends a TURN-OFF-BLUETOOTH command to IDBLUE
For example:
IDBlueCoreApi* api; -(void) turnOffBluetooth { SendStatus status = nil; status = [api turnOffBluetooth]; if ([status successful]) { } else { } }