Skip to content

iOS Docs

Jump to bottom
Hans Knöchel edited this page Dec 12, 2018 · 19 revisions

API's

CentralManager

Createable

  • createCentralManager(args)
    • showPowerAlert (Boolean)
    • restoreIdentifier(String)

Methods

  • isScanning()
  • startScan()
  • startScanWithServices(services)
    • services ([String]): Required - Array of Service-UUID
  • stopScan()
  • connectPeripheral(peripheral, options)
    • peripheral (Peripheral): Required
    • options (Object): Optional
      • notifyOnConnection (Boolean)
      • notifyOnDisconnection (Boolean)
      • notifyOnNotification (Boolean)
  • cancelPeripheralConnection(peripheral)
    • peripheral (Peripheral): Required
  • retrievePeripheralsWithIdentifiers(identifiers)
    • identifiers ([String]): Optional
  • retrieveConnectedPeripheralsWithServices(serviceUUIDs)
    • serviceUUIDs ([String]): Optional

Properties

  • state (MANAGER_STATE_*)

Events

  • didUpdateState
  • willRestoreState
  • didDiscoverPeripheral
  • didConnectPeripheral
  • didFailToConnectPeripheral

PeripheralManager

Createable

  • createPeripheralManager(args)
    • showPowerAlert (Boolean)
    • restoreIdentifier(String)

Methods

  • isAdvertising
  • `startAdvertising(args) (Object)
    • localName (String): Optional
    • serviceUUIDs ([String]): String
  • stopAdvertising
  • setDesiredConnectionLatencyForCentral(latency, central)
    • latency (Number): Required
    • central (Central): Required
  • addService(service)
    • service (Service): Required
  • removeService(service)
    • service (Service): Required
  • removeAllServices
  • updateValueForCharacteristicOnSubscribedCentrals(value, characteristic, subscribedCentrals)
    • value (Ti.Blob): Required
    • characteristic (Characteristic): Required
    • subscribedCentrals ([String]): Required - Array of Central-UUID's

Properties

  • state (MANAGER_STATE_*)

Events

  • didUpdateState
  • willRestoreState
  • didStartAdvertising
  • didAddService
  • didSubscribeToCharacteristic
  • didUnsubscribeFromCharacteristic
  • didReceiveReadRequest
  • didReceiveWriteRequests
  • readyToUpdateSubscribers

Central

Properties

  • maximumUpdateValueLength (Number)
  • identifier (String)

Characteristic

Createable

  • createCharacteristic(args)
    • uuid (String)
    • properties(CHARACTERISTIC_PROPERTY_*)
    • value(Ti.Blob)
    • permissions(ATTRIBUTE_PERMISSIONS_*)

Properties

  • service (Service)
  • properties (CHARACTERISTIC_PROPERTY_*)
  • isNotifying (Boolean)
  • descriptors ([Descriptor])
  • value (Ti.Blob)
  • uuid (String)

Descriptor

Properties

  • characteristic (Characteristic)
  • value (Mixed)

Peripheral

Methods

  • readRSSI()
  • discoverServices(uuids)
    • uuids ([String])
  • discoverIncludedServicesForService(includedServices, service)
    • includedServices ([Service])
    • service (Service)
  • discoverCharacteristicsForService(args)
    • characteristics ([Characteristic])
    • service (Service)
  • readValueForCharacteristic(characteristic)
    • characteristic (Characteristic)
  • maximumWriteValueLengthForType(type)
    • type (CHARACTERISTIC_WRITE_*)
  • writeValueForCharacteristicWithType(value, characteristic, type)
    • value (Ti.Blob)
    • characteristic (Characteristic)
    • type (CHARACTERISTIC_WRITE_*)
  • setNotifyValueForCharacteristic(enabled, characteristic)
    • enabled (Boolean)
    • characteristic (Characteristic)
  • discoverDescriptorsForCharacteristic
    • characteristic (Characteristic)
  • readValueForDescriptor(descriptor)
    • descriptor (Descriptor)
  • writeValueForDescriptor(value, descriptor)
    • value (Ti.Blob)
    • descriptor (Descriptor)

Properties

  • name
  • rssi
  • state
  • services

Events

  • didDiscoverServices
  • didDiscoverCharacteristicsForService
  • didUpdateValueForCharacteristic
  • didWriteValueForCharacteristic

Service

Properties

  • isPrimary (Boolean)
  • peripheral (Peripheral)
  • includedServices ([String])
  • characteristics ([Characteristic])
  • uuid (String)

Constants

  • MANAGER_STATE_UNKNOWN (int)
  • MANAGER_STATE_UNSUPPORTED (int)
  • MANAGER_STATE_UNAUTHORIZED (int)
  • MANAGER_STATE_POWERED_OFF (int)
  • MANAGER_STATE_POWERED_ON (int)
  • MANAGER_STATE_RESETTING (int)
  • PERIPHERAL_STATE_DISCONNECTED (int)
  • PERIPHERAL_STATE_CONNECTING (int)
  • PERIPHERAL_STATE_CONNECTED (int)
  • PERIPHERAL_STATE_DISCONNECTING (int)
  • PERIPHERAL_MANAGER_CONNECTION_LATENCY_LOW (int)
  • PERIPHERAL_MANAGER_CONNECTION_LATENCY_MEDIUM (int)
  • PERIPHERAL_MANAGER_CONNECTION_LATENCY_HIGH (int)
  • ATT_ERROR_SUCCESS (int)
  • ATT_ERROR_INVALID_HANDLE (int)
  • ATT_ERROR_READ_NOT_PERMITTED (int)
  • ATT_ERROR_NOT_PERMITTED (int)
  • ATT_ERROR_INVALID_PDU (int)
  • ATT_ERROR_INSUFFICIENT_AUTHENTICATION (int)
  • ATT_ERROR_NOT_SUPPORTED (int)
  • ATT_ERROR_INVALID_OFFSET (int)
  • ATT_ERROR_INSUFFICIENT_AUTHORIZATION (int)
  • ATT_ERROR_PREPARE_QUEUE_FULL (int)
  • ATT_ERROR_ATTRIBUTE_NOT_FOUND (int)
  • ATT_ERROR_ATTRIBUTE_NOT_LONG (int)
  • ATT_ERROR_INSUFFICIENT_ENCRYPTION_KEY_SITE (int)
  • ATT_ERROR_INVALID_ATTRIBUTE_VALUE_LENGTH (int)
  • ATT_ERROR_UNLIKELY_ERROR (int)
  • ATT_ERROR_INSUFFICIENT_ENCRYPTION (int)
  • ATT_ERROR_UNSUPPORTED_GROUP_TYPE (int)
  • ATT_ERROR_INSUFFICIENT_RESOURCES (int)
  • CHARACTERISTIC_PROPERTY_BROADCAST (int)
  • CHARACTERISTIC_PROPERTY_READ (int)
  • CHARACTERISTIC_PROPERTY_WRITE_WITH_RESPONSE (int)
  • CHARACTERISTIC_PROPERTY_WRITE_WITHOUT_RESPONSE (int)
  • CHARACTERISTIC_PROPERTY_WRITE (int)
  • CHARACTERISTIC_PROPERTY_NOTIFY (int)
  • CHARACTERISTIC_PROPERTY_INDICATE (int)
  • CHARACTERISTIC_PROPERTY_AUTHENTICATED_SIGNED_WRITES (int)
  • CHARACTERISTIC_PROPERTY_EXTENDED_PROPERTIES (int)
  • CHARACTERISTIC_PROPERTY_NOTIFY_ENCRYPTION_REQUIRED (int)
  • CHARACTERISTIC_PROPERTY_INDICATE_ENCRYPTION_REQUIRED (int)
  • CHARACTERISTIC_WRITE_WITH_RESPONSE (int)
  • CHARACTERISTIC_WRITE_WITHOUT_RESPONSE (int)
  • ATTRIBUTE_PERMISSIONS_READABLE (int)
  • ATTRIBUTE_PERMISSIONS_WRITEABLE (int)
  • ATTRIBUTE_PERMISSIONS_READ_ENCRYPTION_REQUIRED (int)
  • ATTRIBUTE_PERMISSIONS_WRITE_ENCRYPTION_REQUIRED (int)
Clone this wiki locally