appcelerator.ble

A Boolean value that indicates whether the advertising event type is connectable.

The local name of a peripheral.

The manufacturer data of a peripheral.

An array of UUIDs found in the overflow area of the advertisement data.

A dictionary that contains service-specific advertisement data.

An array of service UUIDs.

An array of solicited service UUIDs.

The transmit power of a peripheral.

The attribute wasn’t found within the specified attribute handle range.

The ATT read blob request can’t read or write the attribute.

The ATT command or request failed.

Reading or writing the attribute’s value failed for lack of authentication.

Reading or writing the attribute’s value failed for lack of authorization.

Reading or writing the attribute’s value failed for lack of encryption.

The encryption key size used for encrypting this link is insufficient.

Resources are insufficient to complete the ATT request.

The length of the attribute’s value is invalid for the intended operation.

The attribute handle is invalid on this peripheral.

The specified offset value was past the end of the attribute’s value.

The attribute Protocol Data Unit (PDU) is invalid.

The prepare queue is full, as a result of there being too many write requests in the queue.

The permissions prohibit reading the attribute’s value.

The attribute server doesn’t support the request received from the client.

The ATT command or request successfully completed.

The ATT request encountered an unlikely error and wasn’t completed.

The attribute type isn’t a supported grouping attribute as defined by a higher-layer specification.

The permissions prohibit writing the attribute’s value.

A state that indicates the user has authorized Bluetooth at any time.

A state that indicates the user explicitly denied Bluetooth access for this app.

A state that indicates the user has yet to authorize Bluetooth for this app.

A state that indicates this app isn’t authorized to use Bluetooth.

current state of the device with reference to a region is far

current state of the device with reference to a region is immediate

current state of the device with reference to a region is near

current state of the device with reference to a region is unknown

The UUID for the Aggregate Format descriptor, as a string.

The UUID for the Extended Properties descriptor, as a string. The corresponding value for this descriptor is an NSNumber object.

The UUID for the Presentation Format descriptor, as a string. The corresponding value for this descriptor is an NSData object.

The UUID for the User Description descriptor, as a string. The corresponding value for this descriptor is an NSString object.

The UUID for the Client Configuration descriptor, as a string. In iOS, the corresponding value for this descriptor is an NSNumber object. In android, it is a 32 bit uuid.

The PSM of an L2CAP channel associated with the GATT service containing this characteristic.This PSM is a little-endian UInt16. Servers can publish this characteristic with the UUID ABDD3056-28FA-441D-A470-55A75A52553A.

The UUID for the Server Configuration descriptor, as a string. The corresponding value for this descriptor is an NSNumber object.

A permission that indicates only trusted devices can read the attribute’s value.

A permission that indicates a peripheral can read the attribute’s value.

A permission that indicates only trusted devices can write the attribute’s value.

A permission that indicates a peripheral can write the attribute’s value.

A property that indicates the perhipheral allows signed writes of the characteristic’s value, without a response to indicate the write succeeded.

A property that indicates the characteristic can broadcast its value using a characteristic configuration descriptor.

A property that indicates the characteristic defines additional properties in the extended properties descriptor.A property that indicates the characteristic defines additional properties in the extended properties descriptor.

A property that indicates the peripheral permits notifications of the characteristic’s value, with a response from the central to indicate receipt of the notification.

A property that indicates only trusted devices can enable indications of the characteristic’s value.

A property that indicates the peripheral permits notifications of the characteristic’s value, without a response from the central to indicate receipt of the notification.

A property that indicates that only trusted devices can enable notifications of the characteristic’s value.

A property that indicates a peripheral can read the characteristic’s value.

A property that indicates a peripheral can write the characteristic’s value, with a response to indicate that the write succeeded.

A property that indicates a peripheral can write the characteristic's value, without a response to indicate that the write succeeded.

Write a characteristic value, without any response from the peripheral to indicate whether the write was successful.

Write a characteristic value, with a response from the peripheral to indicate whether the write was successful.

An option to bridge classic Bluetooth technology profiles, if already connected over Bluetooth Low Energy.

A Boolean value that specifies whether the system should display an alert when connecting a peripheral in the background.

A Boolean value that specifies whether the system should display an alert when disconnecting a peripheral in the background.

A Boolean value that specifies whether the system should display an alert for any notification sent by a peripheral.

An option to require Apple Notification Center Service (ANCS) when connecting a device.

An option that indicates a delay before the system makes a connection.

Peer connected event type. This is 'event' type value for CENTREL_MANAGER_EVENT_PERIPHERAL_CONNECTION_EVENT_DID_OCCUR event.

Peer disconnect event type. This is 'event' type value for CENTREL_MANAGER_EVENT_PERIPHERAL_CONNECTION_EVENT_DID_OCCUR event.

Connection parameter recommended by the Bluetooth SIG.

For a high priority, low latency connection.

For a low power, reduced data rate connection.

A read permission for descriptor.

An encrypted read permission for descriptor.

A write permission for descriptor.

An encrypted write permission for descriptor.

Value used to disable notifications or indications for a client configuration descriptor. You may pass this constant to the unsubscribeFromCharacteristic method.

Value used to enable indication for a client configuration descriptor. You may pass this constant to the subscribeToCharacteristic method.

Value used to enable notification for a client configuration descriptor. You may pass this constant to the subscribeToCharacteristic method.

User has granted authorization to use their location only while they are using your app.

Write a characteristic value, with a response from the peripheral to indicate whether the write was successful.

User has explicitly denied authorization for this application, or location services are disabled in Settings.

User has not yet made a choice with regards to this application

This application is not authorized to use location services. Due to active restrictions on location services, the user cannot change this status, and may not have personally denied authorization

A state that indicates Bluetooth is currently powered off.

A state that indicates Bluetooth is currently powered on and available to use.

A state that indicates the connection with the system service was momentarily lost.

One of the possible values returned by the state property. This value indicates that the local Bluetooth adapter is turning off.

One of the possible values returned by the state property. This value indicates that the local Bluetooth adapter is turning on.

A state that indicates the application isn’t authorized to use the Bluetooth low energy role.

The Peripheral and Central manager’s state is unknown

A state that indicates this device doesn’t support the Bluetooth low energy central or client role.

A latency setting that prioritizes extending battery life over rapid communication.

A latency setting indicating that prioritizes rapid communication over battery life.

A latency setting that balances communication frequency and battery life.

The peripheral is connected to the central manager.

The peripheral is in the process of connecting to the central manager.

The peripheral isn’t connected to the central manager.

The peripheral is disconnecting from the central manager.

The current state of the device with reference to a region is inside

The current state of the device with reference to a region is outside

The current state of the device with reference to a region is unknown

create a constraint that describes the identity caracteristics of a beacon.

create Beacon Region.

create descriptor.

create mutable characteristic.

create a region manager to scan beacons.

Disables the local Bluetooth adapter.

Enables the local Bluetooth adapter.

Initializes the module's central manager. This function must be called in an app that acts as a central before any other function can be used.

Initializes the module's peripheral manager object. This function must be called in an app that acts as a peripheral before any other function can be used.

Determines whether Bluetooth Low Energy Advertising feature is supported on the local Bluetooth device.

Determines if bluetooth permissions have been granted.

Determines if Bluetooth is currently enabled and ready for use.

Determines whether Bluetooth Low Energy feature is supported on the local Bluetooth device.

Displays a dialog requesting bluetooth permissions from the user.

Indicates the one sigma horizontal accuracy in meters.

The value identifying a group of beacons.

The value identifying a specific beacon within a group.

The relative distance to the beacon.

The received signal strength of the beacon, measured in decibels.

The time when this beacon was observed.

The unique ID of the beacons being targeted.

The value identifying a group of beacons.

The value identifying a specific beacon within a group.

The unique ID of the beacons being targeted.

This is a value that you specify and can use to identify this region inside your application.

The value identifying a group of beacons.

The value identifying a specific beacon within a group.

The relative distance to the beacon. A Boolean indicating whether beacon notifications are sent when the device’s display is on. When set to true, the region manager sends beacon notifications when the user turns on the display and the device is already inside the region. These notifications are sent even if your app is not running. In that situation, the system launches your app into the background so that it can handle the notifications. In both situations, the app will receive a BLE.determinedStateForRegion:event event.

The unique ID of the beacons being targeted.

The address (UUID) of device acting as a central.

The maximum amount of data, in bytes, that can be received by the central in a single notification or indication.

A Boolean value that indicates whether the central is currently scanning.

All discovered peripherals

State of the module's internal central manager. For android, it is the current state of the local Bluetooth adapter. Its value is one of the MANAGER_STATE_* constants.

Cancels an active or pending connection to peripheral. Note that this is non-blocking, and any Peripheral commands that are still pending to peripheral may or may not complete.

Initiates a connection to peripheral. Connection attempts never time out and, depending on the outcome, will result in a call to either didConnectPeripheral or didFailToConnectPeripheral event. Pending attempts are cancelled automatically upon deallocation of peripheral, and explicitly via Modules.BLE.CentralManager.cancelPeripheralConnection}.

Creates a Modules.BLE.Peripheral class object with the given address.

Determines whether the ACCESS_FINE_LOCATION permission is granted or not.

Calls connectionEventDidOccur event when a connection event occurs matching any of the given options. Passing nil in the option parameter clears any prior registered matching options.

Request for the ACCESS_FINE_LOCATION.

Returns a list of the peripherals connected to the system whose services match a given set of criteria.

Returns a list of known peripherals by their identifiers.

Starts scanning for peripherals.

Stops scanning for peripherals.

This method is called upon the connection or disconnection of a peripheral that matches any of the options provided in registerForConnectionEventsWithOptions

This event is called when a connection initiated by connectPeripheral has succeeded.

This event is called when a peripheral disconnected.

A event called when centrel manager discover peripheral

This event is called when a connection initiated by connectPeripheral has failed.

This event is called when the authorization status changes for a peripheral connected with connectPeripheral with option Modules.BLE.CONNECT_PERIPHERAL_OPTIONS_KEY_REQUIRES_ANCS

A event called when centrel manager state updated

A event called when centrel manager will restore state

A list of the Descriptor* objects that have so far been discovered in this characteristic. It is writeable if this JavaScript object represents a mutable characteristic.

Indicates whether this characteristic is mutable.

Whether the characteristic is currently notifying or not.

The properties of the characteristic as a bitfield.

The service this characteristic belongs to.

The Bluetooth-specific UUID of the attribute.

The value of the characteristic.

tests whether two characteristics are same or not.

A back-pointer to the characteristic this descriptor belongs to.

The Bluetooth UUID of the descriptor.

The value of the descriptor.

The central that originated the request.

The descriptor whose value will be read or written.

The offset given for the value

If the remote device requires a response.

The data being read or written.

update the data of value field

The peer connected to the channel

The PSM of the channel.

closes the l2cap channel

Get the size of the read buffer in bytes.

Sets the size of the read buffer in bytes.

write data to channel

Fired whenever new data recived on channel.

Fired whenever the end of the stream has been reached.

Fired whenever there is some error in reading or writing.

The permissions of the characteristic value. It is only present if this JavaScript object represents a mutable characteristic.

For notifying characteristics, the set of currently subscribed centrals.

The UUID associated with the peer.

Once a peripheral has been connected at least once by the system, it is assigned a address (UUID). This address can be stored and later provided to the retrievePeripherals method.

A Boolean value that indicates if the remote device has authorization to receive data over ANCS protocol.

A Boolean value that indicates whether the remote device can send a write without a response.

Whether or not the peripheral is currently connected.

The name of the peripheral.

A list of a peripheral’s discovered services.

The current connection state of the peripheral. Possible values defined by PERIPHERAL_STATE_* constants.

Discovers the specified characteristic(s) of a service. The result of this operation is returned via the didDiscoverCharacteristics event. In android, all the characteristics have already been discovered, as part of the discoverServices operation. So, this method is kept in android to keep parity with the iOS platform.

Discovers the descriptor(s) of a characteristic.The result of this operation is returned via the didDiscoverDescriptorsForCharacteristics event. In android, all the descriptors have already been discovered, as part of the discoverServices operation. So, this method is kept in android to keep parity with the iOS platform.

Discovers the specified included service(s) of a service.The result of this operation is returned via the didDiscoverIncludedServices event. In android, all the included services have already been discovered, as part of the discoverServices operation. So, this method is kept in android to keep parity with the iOS platform.

Discovers available service(s) on the peripheral. The result of this operation is returned via the didDiscoverServices event.

The maximum amount of data, in bytes, you can send to a characteristic in a single write type.

Attempts to open an L2CAP channel to the peripheral using the supplied Protocol/Service Multiplexer (PSM).

Retrieves the current RSSI value for the peripheral while connected to the central manager.

Reads the value of a characteristic.The result of this operation is returned via the didUpdateValueForCharacteristic event.

Reads the value of a descriptor. The result of this operation is returned via the didUpdateValueForDescriptor event.

Request the specific connection priority. This method will send connection parameter update request to the remote device.

Enables notifications/indications for a characteristic. If the characteristic allows both, notifications will be used.

Disables notifications/indications for a characteristic.

Writes a value to a characteristic.

Writes the value of a descriptor. The result of this operation is returned via the didWriteValueForDescriptor event.

This event returns the result of a call to the discoverCharacteristics method. If the characteristic(s) were read successfully, they can be retrieved via the service property's characteristics property.

This event returns the result of a call to the discoverDescriptorsForCharacteristic method.

This event returns the result of a call to the discoverIncludedServices method.

Discovers the specified services of the peripheral.

This event is fired when the services of the peripheral change.

This method delivers the result of a previous call to openL2CAPChannel.

This event returns the result of a call to the readRSSI method.

This event is fired when the name of the peripheral changes.

This event returns the result of a call to the subscribeToCharacteristic or unsubscribeFromCharacteristic method.

This event is fired after a call to the readValueForCharacteristic method, or upon receipt of a notification/indication.

This event returns the result of a call to the readValueForDescriptor method.

This event returns the result of a call to the writeValueForCharacteristic method.

This event returns the result of a call to the writeValueForDescriptor method.

Tells the delegate that a peripheral is again ready to send characteristic updates.

Whether or not the the module's internal peripheral manager is currently advertising data.

State of the module's internal peripheral manager. Its value is one of the MANAGER_STATE_* constants.

string the restoration identifier for a peripheral manager object. this is the same string you assigned to the restoreIdentifier parameter of the initPeripheralManager function.

Publishes a service and any of its associated characteristics and characteristic descriptors to the local GATT database.

This method closes the peripheral.

Attempts to open an L2CAP channel to the peripheral using the supplied Protocol/Service Multiplexer (PSM).

Removes all published services from the local GATT database.

Removes a specified published service from the local GATT database.

Used to respond to request(s) received via the didReceiveDescriptorReadRequest or didReceiveDescriptorWriteRequest event.

Used to respond to request(s) received via the didReceiveReadRequest or didReceiveWriteRequests event.

Sets the desired connection latency for an existing connection on the module's internal peripheral manager.

Instructs the module's internal peripheral manager to start advertising.

Instructs the module's internal peripheral manager to start advertising for beacon region.

Instructs the module's internal peripheral manager to stop advertising.

The service PSM to be removed from the system.

Instructs the module's internal peripheral manager to send an updated characteristic value to one or more centrals, via a notification or indication.

This event returns the result of a addService call. If service could not be added, the cause will be detailed in the errorCode, errorDomain, and errorDescription properties.

Tells the delegate that the peripheral manager opened an L2CAP channel.

Tells the delegate that the peripheral manager created a listener for incoming L2CAP channel connections.

This event is fired when the module's internal peripheral manager receives a read request on descriptor.

This event is fired when the module's internal peripheral manager receives a write request on descriptor.

This event is fired when the module's internal peripheral manager receives a read request.

This event is fired when the module's internal peripheral manager receives a write request for one or more characteristics.

This event returns the result of a startAdvertising call. If advertisement could not be started, the cause will be detailed in the errorCode, errorDomain, and errorDescription properties.

This event is fired when a central configures a characteristic to notify or indicate. It should be used as a cue to start sending updates as the characteristic value changes.

Tells the delegate that the peripheral manager removed a published service from the local system.

This event is fired when a central removes notifications/indications from a characteristic.

Fired whenever the state of the module's internal peripheral manager changes.

This event is fired when the module's internal peripheral manager receives a write request for one or more characteristics.This event is fired after a failed call to updateValue, when the module's internal peripheral manager is again ready to send characteristic value updates.

Tells the delegate that the peripheral manager opened an L2CAP channel.

Determines whether the device supports monitoring for the specified type of region.

Determines whether the device supports ranging.

Returns the current authorization status of the calling application.

Determines whether the user has location services enabled.

The maximum region size, in terms of a distance from a central point, that the framework can support.

Retrieve a set of objects for the regions that are currently being monitored.

Retrieve a set of beacon constraints for which this location manager is actively providing ranging.

Retrieve a set of objects representing the regions for which this location manager is actively providing ranging.

When locationManagerAuthorizationStatus == LOCATION_MANAGER_AUTHORIZATION_STATUS_NOT_DETERMINED, calling this method will start the process of requesting "LOCATION_MANAGER_AUTHORIZATION_STATUS_AUTHORIZED_ALWAYS" authorization from the user.

Asynchronously retrieve the cached state of the specified region. The state is returned to the "didDetermineState" event

When locationManagerAuthorizationStatus == LOCATION_MANAGER_AUTHORIZATION_STATUS_NOT_DETERMINED, calling this method will trigger a prompt to request "LOCATION_MANAGER_AUTHORIZATION_STATUS_AUTHORIZED_WHEN_IN_USE" authorization from the user.

Start calculating ranges for beacons in the specified region.

Start calculating ranges for beacons in the specified region.

Start monitoring the specified region.

Stop calculating ranges for the specified region.

Stop an earlier beacon ranging request. See startRangingBeaconsSatisfyingIdentityConstraint:.

Stop monitoring the specified region.

Invoked when the authorization status changes for this application.

Invoked when there's a state transition for a monitored region or in response to a request for state via a call to "requestRegionState"

Invoked when the user enters a monitored region.

Invoked when the user exits a monitored region

Invoked when an any error has occurred.

Invoked when an error has occurred ranging beacons in a region.

Invoked when a new set of beacons are available in the specified Beacon Identity Constraint

Invoked when a new set of beacons are available in the specified region

Invoked when a monitoring for a region started successfully.

Invoked when an error has occurred monitoring beacons in a region.

Invoked when an error has occurred ranging beacons in a region.

The central that originated the request.

The characteristic whose value will be read or written.

The zero-based index of the first byte for the read or write.

If the remote device requires a response.

The data being read or written.

update the data of value field

A list of characteristics discovered in this service.

A list of included services discovered in this service.

A Boolean value that indicates whether the type of service is primary or secondary.

The peripheral to which this service belongs.

The Bluetooth-specific UUID of the attribute.