objc2_core_bluetooth/generated/CBCentralManagerConstants.rs
1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use core::ptr::NonNull;
4use objc2_foundation::*;
5
6use crate::*;
7
8extern "C" {
9 /// An NSNumber (Boolean) indicating that the system should, if Bluetooth is powered off when
10 /// <code>
11 /// CBCentralManager
12 /// </code>
13 /// is instantiated, display
14 /// a warning dialog to the user.
15 ///
16 ///
17 /// See: initWithDelegate:queue:options:
18 ///
19 /// See also [Apple's documentation](https://developer.apple.com/documentation/corebluetooth/cbcentralmanageroptionshowpoweralertkey?language=objc)
20 pub static CBCentralManagerOptionShowPowerAlertKey: &'static NSString;
21}
22
23extern "C" {
24 /// An NSString containing a unique identifier (UID) for the
25 /// <code>
26 /// CBCentralManager
27 /// </code>
28 /// that is being instantiated. This UID is used
29 /// by the system to identify a specific
30 /// <code>
31 /// CBCentralManager
32 /// </code>
33 /// instance for restoration and, therefore, must remain the same for
34 /// subsequent application executions in order for the manager to be restored.
35 ///
36 ///
37 /// See: initWithDelegate:queue:options:
38 ///
39 /// See also: centralManager:willRestoreState:
40 ///
41 /// See also [Apple's documentation](https://developer.apple.com/documentation/corebluetooth/cbcentralmanageroptionrestoreidentifierkey?language=objc)
42 pub static CBCentralManagerOptionRestoreIdentifierKey: &'static NSString;
43}
44
45extern "C" {
46 /// A Boolean representing the CBCentralManager init purpose is for DeviceAccess for media only. This will limit the functionality of this
47 /// manager and only allow media device access without prompting the user for Bluetooth generic TCC.
48 ///
49 ///
50 /// See: initWithDelegate:queue:options:
51 ///
52 /// See also [Apple's documentation](https://developer.apple.com/documentation/corebluetooth/cbcentralmanageroptiondeviceaccessformedia?language=objc)
53 pub static CBCentralManagerOptionDeviceAccessForMedia: &'static NSString;
54}
55
56extern "C" {
57 /// An NSNumber (Boolean) indicating that the scan should run without duplicate filtering. By default, multiple discoveries of the
58 /// same peripheral are coalesced into a single discovery event. Specifying this option will cause a discovery event to be generated
59 /// every time the peripheral is seen, which may be many times per second. This can be useful in specific situations, such as making
60 /// a connection based on a peripheral's RSSI, but may have an adverse affect on battery-life and application performance.
61 ///
62 ///
63 /// See: scanForPeripheralsWithServices:options:
64 ///
65 /// See also [Apple's documentation](https://developer.apple.com/documentation/corebluetooth/cbcentralmanagerscanoptionallowduplicateskey?language=objc)
66 pub static CBCentralManagerScanOptionAllowDuplicatesKey: &'static NSString;
67}
68
69extern "C" {
70 /// An NSArray of
71 /// <code>
72 /// CBUUID
73 /// </code>
74 /// objects respresenting service UUIDs. Causes the scan to also look for peripherals soliciting
75 /// any of the services contained in the list.
76 ///
77 ///
78 /// See: scanForPeripheralsWithServices:options:
79 ///
80 /// See also [Apple's documentation](https://developer.apple.com/documentation/corebluetooth/cbcentralmanagerscanoptionsolicitedserviceuuidskey?language=objc)
81 pub static CBCentralManagerScanOptionSolicitedServiceUUIDsKey: &'static NSString;
82}
83
84extern "C" {
85 /// An NSNumber (Boolean) indicating that the system should display a connection alert for a given peripheral, if the application is suspended
86 /// when a successful connection is made.
87 /// This is useful for applications that have not specified the
88 /// <code>
89 /// bluetooth-central
90 /// </code>
91 /// background mode and cannot display their
92 /// own alert. If more than one application has requested notification for a given peripheral, the one that was most recently in the foreground
93 /// will receive the alert.
94 ///
95 ///
96 /// See: connectPeripheral:
97 ///
98 /// See also [Apple's documentation](https://developer.apple.com/documentation/corebluetooth/cbconnectperipheraloptionnotifyonconnectionkey?language=objc)
99 pub static CBConnectPeripheralOptionNotifyOnConnectionKey: &'static NSString;
100}
101
102extern "C" {
103 /// An NSNumber (Boolean) indicating that the system should display a disconnection alert for a given peripheral, if the application
104 /// is suspended at the time of the disconnection.
105 /// This is useful for applications that have not specified the
106 /// <code>
107 /// bluetooth-central
108 /// </code>
109 /// background mode and cannot display their
110 /// own alert. If more than one application has requested notification for a given peripheral, the one that was most recently in the foreground
111 /// will receive the alert.
112 ///
113 ///
114 /// See: connectPeripheral:
115 ///
116 /// See also [Apple's documentation](https://developer.apple.com/documentation/corebluetooth/cbconnectperipheraloptionnotifyondisconnectionkey?language=objc)
117 pub static CBConnectPeripheralOptionNotifyOnDisconnectionKey: &'static NSString;
118}
119
120extern "C" {
121 /// An NSNumber (Boolean) indicating that the system should display an alert for all notifications received from a given peripheral, if
122 /// the application is suspended at the time.
123 /// This is useful for applications that have not specified the
124 /// <code>
125 /// bluetooth-central
126 /// </code>
127 /// background mode and cannot display their
128 /// own alert. If more than one application has requested notification for a given peripheral, the one that was most recently in the foreground
129 /// will receive the alert.
130 ///
131 ///
132 /// See: connectPeripheral:
133 ///
134 /// See also [Apple's documentation](https://developer.apple.com/documentation/corebluetooth/cbconnectperipheraloptionnotifyonnotificationkey?language=objc)
135 pub static CBConnectPeripheralOptionNotifyOnNotificationKey: &'static NSString;
136}
137
138extern "C" {
139 /// An NSNumber indicating the number of seconds for the system to wait before starting a connection.
140 ///
141 ///
142 /// See: connectPeripheral:
143 ///
144 /// See also [Apple's documentation](https://developer.apple.com/documentation/corebluetooth/cbconnectperipheraloptionstartdelaykey?language=objc)
145 pub static CBConnectPeripheralOptionStartDelayKey: &'static NSString;
146}
147
148extern "C" {
149 /// An NSNumber (Boolean) indicating that the system will bring up classic transport profiles when low energy transport for peripheral is connected.
150 ///
151 ///
152 /// See: connectPeripheral:
153 ///
154 /// See also [Apple's documentation](https://developer.apple.com/documentation/corebluetooth/cbconnectperipheraloptionenabletransportbridgingkey?language=objc)
155 pub static CBConnectPeripheralOptionEnableTransportBridgingKey: &'static NSString;
156}
157
158extern "C" {
159 /// An NSNumber (Boolean) indicating that the ANCS (Apple Notification Center Service) is required for the peripheral is connected.
160 ///
161 ///
162 /// See: connectPeripheral:
163 ///
164 /// See also [Apple's documentation](https://developer.apple.com/documentation/corebluetooth/cbconnectperipheraloptionrequiresancs?language=objc)
165 pub static CBConnectPeripheralOptionRequiresANCS: &'static NSString;
166}
167
168extern "C" {
169 /// An NSArray of
170 /// <code>
171 /// CBPeripheral
172 /// </code>
173 /// objects containing all peripherals that were connected or pending connection at the time the
174 /// application was terminated by the system. When possible, all known information for each peripheral will be restored, including any discovered
175 /// services, characteristics and descriptors, as well as characteristic notification states.
176 ///
177 ///
178 /// See: centralManager:willRestoreState:
179 ///
180 /// See also: connectPeripheral:options:
181 ///
182 /// See also [Apple's documentation](https://developer.apple.com/documentation/corebluetooth/cbcentralmanagerrestoredstateperipheralskey?language=objc)
183 pub static CBCentralManagerRestoredStatePeripheralsKey: &'static NSString;
184}
185
186extern "C" {
187 /// An NSArray of
188 /// <code>
189 /// CBUUID
190 /// </code>
191 /// objects containing the service(s) being scanned for at the time the application was terminated by the system.
192 ///
193 ///
194 /// See: centralManager:willRestoreState:
195 ///
196 /// See also: scanForPeripheralsWithServices:options:
197 ///
198 /// See also [Apple's documentation](https://developer.apple.com/documentation/corebluetooth/cbcentralmanagerrestoredstatescanserviceskey?language=objc)
199 pub static CBCentralManagerRestoredStateScanServicesKey: &'static NSString;
200}
201
202extern "C" {
203 /// An NSDictionary containing the scan options at the time the application was terminated by the system.
204 ///
205 ///
206 /// See: centralManager:willRestoreState:
207 ///
208 /// See also: scanForPeripheralsWithServices:options:
209 ///
210 /// See also [Apple's documentation](https://developer.apple.com/documentation/corebluetooth/cbcentralmanagerrestoredstatescanoptionskey?language=objc)
211 pub static CBCentralManagerRestoredStateScanOptionsKey: &'static NSString;
212}
213
214/// [Apple's documentation](https://developer.apple.com/documentation/corebluetooth/cbconnectioneventmatchingoption?language=objc)
215// NS_TYPED_ENUM
216pub type CBConnectionEventMatchingOption = NSString;
217
218extern "C" {
219 /// An NSArray of
220 /// <code>
221 /// CBUUID
222 /// </code>
223 /// objects respresenting service UUIDs. A connected peer with any matching service UUIDs will result
224 /// in a call to {
225 ///
226 /// ```text
227 /// centralManager:connectionEventDidOccur:}.
228 /// A maximum of 4 services can be registered.
229 ///
230 /// @see centralManager:connectionEventDidOccur:forPeripheral:
231 /// @seealso registerForConnectionEventsWithOptions:
232 ///
233 ///
234 ///
235 /// ```
236 ///
237 /// See also [Apple's documentation](https://developer.apple.com/documentation/corebluetooth/cbconnectioneventmatchingoptionserviceuuids?language=objc)
238 pub static CBConnectionEventMatchingOptionServiceUUIDs:
239 &'static CBConnectionEventMatchingOption;
240}
241
242extern "C" {
243 /// An NSArray of
244 /// <code>
245 /// NSUUID
246 /// </code>
247 /// objects respresenting
248 /// <i>
249 /// peripheral
250 /// </i>
251 /// identifiers. A connected peer with any matching identifier(s) will result
252 /// in a call to {
253 ///
254 /// ```text
255 /// centralManager:connectionEventDidOccur:}.
256 ///
257 /// @see centralManager:connectionEventDidOccur:forPeripheral:
258 /// @seealso registerForConnectionEventsWithOptions:
259 ///
260 ///
261 ///
262 /// ```
263 ///
264 /// See also [Apple's documentation](https://developer.apple.com/documentation/corebluetooth/cbconnectioneventmatchingoptionperipheraluuids?language=objc)
265 pub static CBConnectionEventMatchingOptionPeripheralUUIDs:
266 &'static CBConnectionEventMatchingOption;
267}
268
269extern "C" {
270 /// An NSNumber (Boolean) indicating that the AutoReconnect is enabled for the peripheral is connected. After peripheral device is connected, this will allow
271 /// the system to initiate connect to the peer device automatically when link is dropped. Caller will get notified about the disconnection with potential delay via
272 /// {
273 ///
274 /// ```text
275 /// centralManager:didDisconnectPeripheral:timestamp:isReconnecting:error:}
276 ///
277 /// @see connectPeripheral:
278 ///
279 ///
280 ///
281 /// ```
282 ///
283 /// See also [Apple's documentation](https://developer.apple.com/documentation/corebluetooth/cbconnectperipheraloptionenableautoreconnect?language=objc)
284 pub static CBConnectPeripheralOptionEnableAutoReconnect: &'static NSString;
285}