Skip to content

Commit

Permalink
Merge pull request #85 from fasihul-axway/Module/Add-Creatables
Browse files Browse the repository at this point in the history
fix(doc): added createable=false
  • Loading branch information
Fasihul Haque committed Feb 1, 2021
2 parents 6fd640a + 70403c4 commit 604b39c
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 0 deletions.
1 change: 1 addition & 0 deletions apidoc/Central.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ name: Modules.BLE.Central
summary: represent a remote device connected to a local app, which is acting as a peripheral.
description: |
The CBCentral class represents remote central devices (or centrals) that have connected to an app implementing the peripheral role on a local device. Remote centrals use universally unique identifiers (UUIDs), to identify themselves.
createable: false
extends: Titanium.Proxy
platforms: [iphone, ipad]
since: "1.0.0"
Expand Down
1 change: 1 addition & 0 deletions apidoc/L2CAPchannel.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: Modules.BLE.L2CAPChannel
summary: L2Cap allow us to open a side channel, with it we can directly read and write without any framing limitation, packet size limitations. It’s a direct way to talk between our devices and accessories.
description: L2Cap Channel on the lowest level is the stream of data between two devices. It’s actually the protocol that has been used underneath for all types of communication between two devices. So L2Cap has been used from the first day of Bluetooth communications. but now with the L2CAP class, we use is directly talk over these channels.
createable: false
extends: Titanium.Proxy
platforms: [iphone, ipad]
since: "1.0.0"
Expand Down
1 change: 1 addition & 0 deletions apidoc/Peer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ summary: An object that represents a remote device.
description: |
The Peer class is defines common behavior for objects representing remote devices.
You typically don’t create instances of either Peer or its concrete subclasses. Instead, the system creates them for you during the process of peer discovery
createable: false
extends: Titanium.Proxy
platforms: [iphone, ipad]
since: "1.0.0"
Expand Down
1 change: 1 addition & 0 deletions apidoc/Peripheral.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description: |
The CBPeripheral class represents remote peripheral devices that your app discovers with a central manager (an instance of CentralManager).
In iOS, Peripherals use universally unique identifiers (UUIDs), to identify themselves. For Android, Peripherals use address to be uniqely identified.
Peripherals may contain one or more services or provide useful information about their connected signal strength.
createable: false
extends: Titanium.Proxy
platforms: [android, iphone, ipad]
since: "1.0.0"
Expand Down
1 change: 1 addition & 0 deletions apidoc/Reuqest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ name: Modules.BLE.Request
summary: A request that uses the Attribute Protocol (ATT).
description: |
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.
createable: false
extends: Titanium.Proxy
platforms: [iphone, ipad]
since: "1.0.0"
Expand Down

0 comments on commit 604b39c

Please sign in to comment.