Titanium SDK # Modules.BLE.Request
A request that uses the Attribute Protocol (ATT).
1.1.0
1.0.0# Overview
The class represents Attribute Protocol (ATT) read and write requests from remote central devices (represented by Central objects). Remote centrals use these ATT requests to read and write characteristic values on local peripherals (represented by PeripheralManager objects). Local peripherals, on the other hand, use the properties of Request objects to respond to the read and write requests appropriately, using the respondToRequest() method of the PeripheralManager class.
# Properties
# apiName READONLY
3.2.0 3.2.0The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button
returns Ti.UI.Button.
# bubbleParent
3.0.0 3.0.0Indicates if the proxy will bubble an event to its parent.
Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.
Default: true
# central READONLY
1.1.0 1.0.0The central that originated the request.
# characteristic READONLY
1.1.0 1.0.0The characteristic whose value will be read or written.
# lifecycleContainer
3.6.0The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.
# offset READONLY
1.1.0 1.0.0The zero-based index of the first byte for the read or write.
# responseNeeded READONLY
1.1.0If the remote device requires a response.
If this property is true then user need to call respondToRequest method.
# Methods
# addEventListener
1.1.0 1.0.0Adds the specified callback as an event listener for the named event.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. |
Returns
- Type
- void
# applyProperties
3.0.0 3.0.0Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.
Parameters
| Name | Type | Description |
|---|---|---|
props | Dictionary | A dictionary of properties to apply. |
Returns
- Type
- void
# fireEvent
1.1.0 1.0.0Fires a synthesized event to any registered listeners.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
event | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. |
Returns
- Type
- void
# removeEventListener
1.1.0 1.0.0Removes the specified callback as an event listener for the named event.
Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.
When adding a listener, you must save a reference to the callback function in order to remove the listener later:
var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);
To remove the listener, pass in a reference to the callback function:
window.removeEventListener('click', listener);
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to |
Returns
- Type
- void
# updateValue
1.1.0 1.0.0update the data of value field
Parameters
| Name | Type | Description |
|---|---|---|
value | Titanium.Buffer | Titanium.Buffer object to update data on value |
Returns
- Type
- void