spotny-sdk 1.0.0

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64/KontaktSDK.framework/Headers/KTKDevicesManager.h

@@ -0,0 +1,182 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+
+#import "KTKNearbyDevice.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@protocol KTKDevicesManagerDelegate;
+
+#pragma mark - External Constants
+extern NSTimeInterval const KTKDeviceInvalidationAgeNever;
+
+#pragma mark - Type Definition
+/**
+ *  Nearby devices discovery mode.
+ */
+typedef NS_ENUM(NSUInteger, KTKDevicesManagerDiscoveryMode) {
+    /**
+     *  Discovery mode Auto deliveres devices notifications as the devices becoming valid or invalid.
+     *  There is no limit to these notifications so please make sure when working with hundreds of
+     *  nearby devices this may impact performance. It is better to use discovery with interval then.
+     */
+    KTKDevicesManagerDiscoveryModeAuto = 0,
+    
+    /**
+     *  Discovery mode Interval deliveres devices notifications with the specified time inverval.
+     *  When working with hundreds of nearby devices this is preferred mode.
+     *  When just few nearby devices have been discovered in a close time span it is better to use mode auto, as it is responding faster to changes.
+     */
+    KTKDevicesManagerDiscoveryModeInterval
+};
+
+#pragma mark - KTKDevicesManager (Interface)
+@interface KTKDevicesManager : NSObject
+
+#pragma mark - Other Properties
+///--------------------------------------------------------------------
+/// @name Other Properties
+///--------------------------------------------------------------------
+
+/**
+ *  The current state of the bluetooth central.
+ */
+@property (nonatomic, assign, readonly) CBManagerState centralState;
+
+/**
+ *  A Boolean indicating whether the devices manager is currently discovering.
+ */
+@property (nonatomic, assign, readonly, getter=isDiscovering) BOOL discovering;
+
+/**
+ *  A Boolean indicating whether the devices manager should detect devices locked status.
+ */
+@property (nonatomic, assign, readwrite, getter=isDetectingLocks) BOOL detectingLocks;
+
+/**
+ *  The delegate object that will receive events.
+ */
+@property (nonatomic, weak, readonly) id<KTKDevicesManagerDelegate> _Nullable delegate;
+
+@property (nonatomic, assign, readwrite, getter=isUploadingTelemetry) BOOL uploadingTelemetry;
+
+#pragma mark - Initialization Methods
+///--------------------------------------------------------------------
+/// @name Initialization Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Initializes and returns an devices manager object with the specified delegate.
+ *
+ *  @param delegate The delegate object that will receive events.
+ *
+ *  @return An initialized devices manager object.
+ *
+ *  @see KTKDevicesManagerDelegate
+ */
+- (instancetype)initWithDelegate:(id<KTKDevicesManagerDelegate> _Nullable)delegate;
+
+#pragma mark - Configuration Properties
+///--------------------------------------------------------------------
+/// @name Configuration Properties
+///--------------------------------------------------------------------
+
+/**
+ *  A time interval after which nearby device will be invalidated if not re-discovered.
+ *
+ *  Each time nearby device advertising is discovered its <code>updateAt</code> property is updated.
+ *  If <code>updateAt</code> property is updated for longer than <code>invalidationAge</code> value
+ *  a nearby device will be invalidated/removed from current devices list.
+ *
+ *  Default value is 10.0 seconds.
+ */
+@property (nonatomic, assign, readwrite) NSTimeInterval invalidationAge;
+
+/**
+ *  A mode in which nearby devices discovery is done.
+ *  
+ *  If <code>discoveryInterval</code> property is set or discovery is started with <code>startDevicesDiscoveryWithInterval:</code> method,
+ *  <code>discoveryMode</code> is automatically set to <code>KTKDevicesManagerDiscoveryModeInterval</code>.
+ * 
+ *  When discovery is started with <code>startDevicesDiscovery</code> mode will be set to <code>KTKDevicesManagerDiscoveryModeAuto</code>.
+ *
+ *  @see KTKDevicesManagerDiscoveryMode
+ */
+@property (nonatomic, assign, readwrite) KTKDevicesManagerDiscoveryMode discoveryMode;
+
+/**
+ *  A time interval after which discovered notifications will be delivered.
+ */
+@property (nonatomic, assign, readwrite) NSTimeInterval discoveryInterval;
+
+#pragma mark - Discovery Methods
+///--------------------------------------------------------------------
+/// @name Discovery Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Starts discovery of Kontakt.io's nearby devices.
+ */
+- (void)startDevicesDiscovery;
+
+/**
+ *  Starts discovery of Kontakt.io's nearby devices with specified time interval.
+ *
+ *  @param interval A time interval after which discovered notifications will be delivered.
+ */
+- (void)startDevicesDiscoveryWithInterval:(NSTimeInterval)interval;
+
+/**
+ *  Stops discovery of Kontakt.io's nearby devices.
+ */
+- (void)stopDevicesDiscovery;
+
+/**
+ *  Restarts discovery of Kontakt.io's nearby devices.
+ *
+ *  @param completion A block object to be executed when manager restarts the discovery.
+ */
+- (void)restartDeviceDiscoveryWithCompletion:(void(^)( NSError * _Nullable))completion;
+
+@end
+
+#pragma mark - KTKDevicesManagerDelegate
+@protocol KTKDevicesManagerDelegate <NSObject>
+
+#pragma mark - Required Methods
+///--------------------------------------------------------------------
+/// @name Required Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Tells the delegate that one or more devices were discovered.
+ *
+ *  @param manager The devices manager object reporting the event.
+ *  @param devices An list of discovered nearby devices.
+ */
+@required
+- (void)devicesManager:(KTKDevicesManager*)manager didDiscoverDevices:(NSArray <KTKNearbyDevice*>*)devices;
+
+#pragma mark - Optional Methods
+///--------------------------------------------------------------------
+/// @name Optional Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Tells the delegate that a devices discovery error occurred.
+ *
+ *  @param manager The devices manager object reporting the event.
+ *  @param error   An error object containing the error code that indicates why discovery failed.
+ */
+@optional
+- (void)devicesManagerDidFailToStartDiscovery:(KTKDevicesManager*)manager withError:(NSError*)error;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64/KontaktSDK.framework/Headers/KTKEddystone.h

@@ -0,0 +1,101 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+
+#import "KTKEddystoneUID.h"
+#import "KTKEddystoneURL.h"
+#import "KTKEddystoneTLM.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ *  Represents the current proximity of an entity.
+ */
+typedef NS_ENUM(NSInteger, KTKEddystoneProximity) {
+    /**
+     *  Proximity Unknown
+     */
+    KTKEddystoneProximityUnknown,
+    /**
+     *  Proximity Immediate (± 0-1 meter range)
+     */
+    KTKEddystoneProximityImmediate,
+    /**
+     *  Proximity Near (± 1-8 meters range)
+     */
+    KTKEddystoneProximityNear,
+    /**
+     *  Proximity Far (± 8 and more meters range)
+     */
+    KTKEddystoneProximityFar
+};
+
+#pragma mark - KTKEddystone (Interface)
+@interface KTKEddystone : NSObject <NSCopying, NSSecureCoding>
+
+#pragma mark - Eddystone Frames
+///--------------------------------------------------------------------
+/// @name Eddystone Frames
+///--------------------------------------------------------------------
+
+/**
+ *  UID Frame object. (read-only)
+ *  
+ *  @see KTKEddystoneUID
+ */
+@property (nonatomic, strong, readonly) KTKEddystoneUID * _Nullable eddystoneUID;
+
+/**
+ *  URL Frame object. (read-only)
+ *
+ *  @see KTKEddystoneURL
+ */
+@property (nonatomic, strong, readonly) KTKEddystoneURL * _Nullable eddystoneURL;
+
+/**
+ *  TLM Frame object. (read-only)
+ *
+ *  @see KTKEddystoneTLM
+ */
+@property (nonatomic, strong, readonly) KTKEddystoneTLM * _Nullable eddystoneTLM;
+
+#pragma mark - Eddystone Properties
+///--------------------------------------------------------------------
+/// @name Eddystone Properties
+///--------------------------------------------------------------------
+
+/**
+ *  The accuracy of the proximity value, measured in meters from the eddystone. (read-only)
+ */
+@property (nonatomic, assign, readonly) double accuracy;
+
+/**
+ *  The relative distance to the eddystone. (read-only)
+ *
+ *  @see KTKEddystoneProximity
+ */
+@property (nonatomic, assign, readonly) KTKEddystoneProximity proximity;
+
+/**
+ *  Current RSSI value for the eddystone. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSNumber *RSSI;
+
+/**
+ *  CoreBluetooth peripheral identifier. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSUUID *identifier;
+
+/**
+ *  Last discovery update timestamp. (read-only)
+ */
+@property (nonatomic, assign, readonly) double updatedAt;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64/KontaktSDK.framework/Headers/KTKEddystoneFrame.h

@@ -0,0 +1,47 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ *  Eddystone Frame type.
+ */
+typedef NS_ENUM(NSUInteger, KTKEddystoneFrameType) {
+    /**
+     *  UID Frame type.
+     */
+    KTKEddystoneFrameTypeUID = 0x00,
+    /**
+     *  URL Frame type.
+     */
+    KTKEddystoneFrameTypeURL = 0x10,
+    /**
+     *  TLM (Telemetry) Frame type.
+     */
+    KTKEddystoneFrameTypeTLM = 0x20
+};
+
+#pragma mark - KTKEddystoneFrame (Protocol)
+@protocol KTKEddystoneFrame <NSObject>
+
+#pragma mark - Frame Protocol Properties
+///--------------------------------------------------------------------
+/// @name Frame Protocol Properties
+///--------------------------------------------------------------------
+
+/**
+ *  Frame type. (read-only)
+ *
+ *  @see KTKEddystoneFrameType
+ */
+@property (nonatomic, assign, readonly) KTKEddystoneFrameType type;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64/KontaktSDK.framework/Headers/KTKEddystoneManager.h

@@ -0,0 +1,160 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+@import CoreBluetooth;
+@import Foundation;
+
+#if TARGET_OS_IOS
+@import UIKit;
+#endif
+
+#import "KTKEddystone.h"
+#import "KTKEddystoneRegion.h"
+#import "KTKSecureEddystoneRegion.h"
+#import "KTKDeviceDefinitions.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@protocol KTKEddystoneManagerDelegate;
+
+#pragma mark - KTKEddystoneManager (Interface)
+@interface KTKEddystoneManager : NSObject
+
+#pragma mark - Other Properties
+///--------------------------------------------------------------------
+/// @name Other Properties
+///--------------------------------------------------------------------
+
+/**
+ *  A Boolean indicating whether the eddystone manager is currently discovering eddy stones.
+ */
+@property (nonatomic, assign, readonly, getter=isDiscovering) BOOL discovering;
+
+/**
+ *  The current state of the bluetooth central.
+ */
+@property (nonatomic, assign, readonly) CBManagerState centralState;
+
+/**
+ *  The delegate object that will receive events.
+ *  
+ *  @see KTKEddystoneManagerDelegate
+ */
+@property (nonatomic, weak, readonly) id<KTKEddystoneManagerDelegate> delegate;
+
+#pragma mark - Initialization Methods
+///--------------------------------------------------------------------
+/// @name Initialization Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Initializes and returns an eddystone manager object with the specified delegate.
+ *
+ *  @param delegate The delegate object that will receive events.
+ *
+ *  @return An initialized eddystone manager object.
+ *
+ *  @see KTKEddystoneManagerDelegate
+ */
+- (instancetype)initWithDelegate:(id<KTKEddystoneManagerDelegate>)delegate;
+
+#pragma mark - Eddystone Discovery
+///--------------------------------------------------------------------
+/// @name Eddystone Discovery
+///--------------------------------------------------------------------
+
+/**
+ *  Set of regions currently being tracked using discovery. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSSet *discoveryRegions;
+
+/**
+ *  Threshold after which eddystone device is interpreted as lost in foreground mode. (read-write)
+ */
+@property (nonatomic, assign, readwrite) NSTimeInterval invalidationAgeForeground;
+
+/**
+ *  Threshold after which eddystone device is interpreted as lost in background mode. (read-write)
+ */
+@property (nonatomic, assign, readwrite) NSTimeInterval invalidationAgeBackground;
+
+/**
+ *  Starts the delivery of discovery notifications for eddystones in the specified region.
+ *
+ *  @param region The region that identifies the eddystones.
+ *
+ *  @see KTKEddystoneRegion
+ */
+- (void)startEddystoneDiscoveryInRegion:(__kindof KTKEddystoneRegion * _Nullable)region;
+
+/**
+ *  Stops the delivery of discovery notifications for eddystones in the specified region.
+ *
+ *  @param region The region that identifies the eddystones.
+ * 
+ *  @see KTKEddystoneRegion
+ */
+- (void)stopEddystoneDiscoveryInRegion:(__kindof KTKEddystoneRegion * _Nullable)region;
+
+/**
+ *  Stops the delivery of all discovery notifications for eddystones.
+ */
+- (void)stopEddystoneDiscoveryInAllRegions;
+
+@end
+
+#pragma mark - KTKEddystoneManagerDelegate
+@protocol KTKEddystoneManagerDelegate <NSObject>
+
+#pragma mark - Required Methods
+///--------------------------------------------------------------------
+/// @name Required Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Tells the delegate that one or more eddystones were discovered.
+ *
+ *  @param manager    The eddystone manager object reporting the event.
+ *  @param eddystones Set of KTKEddystone objects representing eddystones currently discovered in the specified region.
+ *  @param region     The region object containing the parameters that were used to locate the eddystones.
+ *
+ *  @see KTKEddystoneManager
+ */
+@required
+- (void)eddystoneManager:(KTKEddystoneManager *)manager didDiscoverEddystones:(NSSet <KTKEddystone*>*)eddystones inRegion:(__kindof KTKEddystoneRegion* _Nullable)region;
+
+#pragma mark - Optional Methods
+///--------------------------------------------------------------------
+/// @name Optional Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Tells the delegate that an error occurred while gathering discovery information for a set of eddystones.
+ *
+ *  @param manager The eddystone manager object reporting the event.
+ *  @param error   An error object containing the error code that indicates why discovery failed.
+ *
+ *  @see KTKEddystoneManager
+ */
+@optional
+- (void)eddystoneManagerDidFailToStartDiscovery:(KTKEddystoneManager*)manager withError:(NSError* _Nullable)error;
+
+/**
+ *  Tells the delegate that eddystone's frame was updated.
+ *
+ *  @param manager   The eddystone manager object reporting the event.
+ *  @param eddystone Eddystone object of which frame was updated.
+ *  @param frameType Frame type of the updated frame.
+ *
+ *  @see KTKEddystoneManager
+ */
+@optional
+- (void)eddystoneManager:(KTKEddystoneManager*)manager didUpdateEddystone:(KTKEddystone*)eddystone withFrame:(KTKEddystoneFrameType)frameType;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64/KontaktSDK.framework/Headers/KTKEddystoneRegion.h

@@ -0,0 +1,85 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+
+NS_ASSUME_NONNULL_BEGIN
+
+#pragma mark - KTKEddystoneRegion (Interface)
+@interface KTKEddystoneRegion : NSObject <NSCopying, NSSecureCoding>
+
+#pragma mark - Eddystone Region Properties
+///--------------------------------------------------------------------
+/// @name Eddystone Region Properties
+///--------------------------------------------------------------------
+
+/**
+ *  Namespace ID string of the eddystone being targeted. (read-only)
+ */
+@property (nonatomic, copy, readwrite) NSString * _Nullable namespaceID;
+
+/**
+ *  Secure namespace ID string of the eddystone being targeted. (read-only)
+ */
+@property (nonatomic, copy, readwrite) NSString * _Nullable instanceID;
+
+/**
+ *  URL object of the eddystone being targeted. (read-only)
+ */
+@property (nonatomic, copy, readwrite) NSURL * _Nullable URL;
+
+/**
+ *  URL domain of the eddystone being targeted. (read-only)
+ */
+@property (nonatomic, copy, readwrite) NSString * _Nullable URLDomain;
+
+#pragma mark - Initialization Methods
+///--------------------------------------------------------------------
+/// @name Initialization Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Initializes and returns a region object that targets an eddystone with the specified namespace ID.
+ *
+ *  @param namespaceID Namespace ID string of the eddystone being targeted.
+ *
+ *  @return An initialized eddystone region object.
+ */
+- (instancetype)initWithNamespaceID:(NSString* _Nonnull)namespaceID;
+
+/**
+ *  Initializes and returns a region object that targets an eddystone with the specified namespace ID and instance ID.
+ *
+ *  @param namespaceID Namespace ID string of the eddystone being targeted.
+ *  @param instanceID Instance ID string of the eddystone being targeted.
+ *
+ *  @return An initialized secure eddystone region object.
+ */
+- (instancetype)initWithNamespaceID:(NSString* _Nonnull)namespaceID
+                         instanceID:(NSString* _Nullable)instanceID;
+
+/**
+ *  Initializes and returns a region object that targets an eddystone with the specified URL.
+ *
+ *  @param URL URL object of the eddystone being targeted.
+ *
+ *  @return An initialized eddystone region object.
+ */
+- (instancetype)initWithURL:(NSURL*)URL; 
+
+/**
+ *  Initializes and returns a region object that targets an eddystone with the specified URL domain.
+ *
+ *  @param URLDomain URL domain of the eddystone being targeted.
+ *
+ *  @return An initialized eddystone region object.
+ */
+- (instancetype)initWithURLDomain:(NSString*)URLDomain;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64/KontaktSDK.framework/Headers/KTKEddystoneTLM.h

@@ -0,0 +1,49 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+
+#import "KTKEddystoneFrame.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+#pragma mark - KTKEddystoneTLM (Interface)
+@interface KTKEddystoneTLM : NSObject <KTKEddystoneFrame, NSCopying, NSSecureCoding>
+
+#pragma mark - TLM (Telemetry) Frame Properties
+///--------------------------------------------------------------------
+/// @name TLM (Telemetry) Frame Properties
+///--------------------------------------------------------------------
+
+/**
+ *  Eddystone Version. (read-only)
+ */
+@property (nonatomic, assign, readonly) NSUInteger version;
+
+/**
+ *  Battery voltage in Volts. (read-only)
+ */
+@property (nonatomic, assign, readonly) double batteryVoltage;
+
+/**
+ *  Temperature reading value in Celcius. (read-only)
+ */
+@property (nonatomic, assign, readonly) double temperature;
+
+/**
+ *  Number of advertising packets sent since power up. (read-only)
+ */
+@property (nonatomic, assign, readonly) NSUInteger advertisingCount;
+
+/**
+ *  Time interval since power up. (read-only)
+ */
+@property (nonatomic, assign, readonly) NSTimeInterval timeIntervalSincePowerUp;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64/KontaktSDK.framework/Headers/KTKEddystoneUID.h

@@ -0,0 +1,55 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+
+#import "KTKEddystoneFrame.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+#pragma mark - KTKEddystoneUID (Interface)
+@interface KTKEddystoneUID : NSObject <KTKEddystoneFrame, NSCopying, NSSecureCoding>
+
+#pragma mark - UID Frame Properties
+///--------------------------------------------------------------------
+/// @name UID Frame Properties
+///--------------------------------------------------------------------
+
+/**
+ *  Namespace ID string. (read-only)
+ */
+@property (nonatomic, copy, readonly) NSString *namespaceID;
+
+/**
+ *  Secure namespace ID string. (read-only)
+ */
+@property (nonatomic, copy, readonly) NSString * _Nullable secureNamespaceID;
+
+/**
+ *  Instance ID string. (read-only)
+ */
+@property (nonatomic, copy, readonly) NSString *instanceID;
+
+#pragma mark - Initialization Methods
+///--------------------------------------------------------------------
+/// @name Initialization Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Initializes and returns a UID frame object with the specified namespace ID and instance ID.
+ *
+ *  @param namespaceID Namespace ID string of the eddystone UID frame object.
+ *  @param instanceID Instance ID string of the eddystone UID frame object.
+ *
+ *  @return An initialized UID frame object.
+ */
+- (instancetype)initWithNamespaceID:(NSString *)namespaceID
+                         instanceID:(NSString *)instanceID;
+
+@end
+
+NS_ASSUME_NONNULL_END