Update to ContextHub v1.2.0 framework

Author: jeffkibuule

Boundaries/Boundaries-Info.plist

@@ -9,7 +9,7 @@
 	<key>CFBundleExecutable</key>
 	<string>${EXECUTABLE_NAME}</string>
 	<key>CFBundleIdentifier</key>
-	<string>com.chaione.boundaries</string>
+	<string>com.contexthub.boundaries</string>
 	<key>CFBundleInfoDictionaryVersion</key>
 	<string>6.0</string>
 	<key>CFBundleName</key>

ContextHub.framework/Versions/A/ContextHub

@@ -0,0 +1,101 @@
+//
+//  CCHDevice.h
+//  ContextHub
+//
+//  Created by Kevin Lee on 7/24/14.
+//  Copyright (c) 2014 ChaiOne. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import <UIKit/UIKit.h>
+
+#define kDeviceErrorDomain @"com.contexthub.device.error"
+/**
+ ContextHub Device error codes.
+ */
+typedef NS_ENUM(NSInteger, CCHDeviceErrorCode) {
+    /** 
+     Device id cannot be nil 
+     */
+    CCHInvalidDeviceIdParameter,
+    /**
+     Alias cannot be nil
+     */
+    CCHInvalidDeviceAliasParameter,
+    /**
+     Tags cannot be nil
+     */
+    CCHInvalidDeviceTagsParameter
+};
+
+/**
+ The CCHDevice class is used work with devices.
+
+ Structure of device NSDictionary
+ 
+ | key       | value     |
+ | --------- | --------- |
+ | additional_info | NSDicationary of device specific information (not always present) |
+ | alias | alias that is set for the device (not always present) |
+ | device_type | describes the device, often pulled for the user agent  |
+ | id | database id for the device |
+ | last_profile | NSDictionary of contextual information from the last time the device was seen by the server |
+ | push_token | push token assigned to the device (not always present) |
+ | tag_string | a comma separated string of the tags associated with the device |
+ | tags | NSArray of tags associated with the geofence |
+ */
+@interface CCHDevice : NSObject
+
+/**
+ @return The singleton instance of CCHDevice.
+ */
++ (instancetype)sharedInstance;
+
+/**
+ @return The vendor device id as UUIDString.
+ */
+- (NSString *)deviceId;
+
+/**
+ Registers the device with ContextHub.  This method gathers meta-data about the device and sends it to ContextHub.
+ @param completionHandler (optional) Called when the request completes. If an error occurs, the NSError will be passed to the block.
+ @note this method can be called multiple times.
+ */
+- (void)registerDeviceWithCompletionHandler:(void(^)(NSError *error))completionHandler;
+
+
+/**
+ Gets a device from ContextHub using the device Id.
+ 
+ @param deviceId The id of the device stored in ContextHub.
+ @param completionHandler Called when the request completes. The block is passed an NSDictionary object that represents the device.  If an error occurs, the NSError wil be passed to the block.
+ */
+- (void)getDeviceWithId:(NSString *)deviceId completionHandler:(void(^)(NSDictionary *device, NSError *error))completionHandler;
+
+/**
+ Gets devices from ContextHub using the device alias.
+ 
+ @param alias The alias associated with the devices that you are interested in.
+ @param completionHandler Called when the request completes. The block is passed an NSArray of NSDictionary objects that represent the devices.  If an error occurs, the NSError wil be passed to the block.
+ */
+- (void)getDevicesWithAlias:(NSString *)alias completionHandler:(void(^)(NSArray *devices, NSError *error))completionHandler;
+
+/**
+ Gets devices from ContextHub using tags.
+ 
+ @param tags Tags of the devices that you are interested in.
+ @param completionHandler Called when the request completes. The block is passed an NSArray of NSDictionary objects that represent the devices.  If an error occurs, the NSError wil be passed to the block.
+ */
+- (void)getDevicesWithTags:(NSArray *)tags completionHandler:(void(^)(NSArray *devices, NSError *error))completionHandler;
+
+
+/**
+ Updates the device record on contexthub.
+ @param alias (optional) The alias associated with the device.
+ @param tags (optional) The tags to be applied to the device.
+ @param completionHandler Called when the request completes. The block is passed an NSDictionary object that represents the device.  If an error occurs, the NSError wil be passed to the block.
+ @note This method updates the data for the current device.  The tags and alias that are set here can be used with CCHPush.  The tags can also be used with the CCHSubscriptionService.  This method gathers meta-data about the device and sends it to ContextHub along with the alias and tags.  You can call this method multiple times.
+ */
+- (void)updateDeviceWithAlias:(NSString *)alias tags:(NSArray *)tags completionHandler:(void(^)(NSDictionary *device, NSError *error))completionHandler;
+
+@end

ContextHub.framework/Versions/A/Headers/CCHDevice.h

@@ -143,7 +143,7 @@ extern NSString * const CCHUntaggedElements;
  @param completionHandler (optional) Called when the event is created.  If an error occurs, the NSError wil be passed to the block.
  @note The event must contain a name key.  If you want to pass contextual information along with the event, you can do so by setting a data key for the event.
  */
-- (void)triggerEvent:(NSDictionary *)event completionHandeler:(void(^)(NSError *error))completionHandler;
+- (void)triggerEvent:(NSDictionary *)event completionHandler:(void(^)(NSError *error))completionHandler;
 
 /**
  Calling synchronize will tell the SDK to check for server-side context changes and will update monitored regions.

ContextHub.framework/Versions/A/Headers/CCHSensorPipeline.h

@@ -68,6 +68,21 @@ extern NSString * const CCHVaultItemUpdatedNotification;
  */
 extern NSString * const CCHVaultItemDeletedNotification;
 
+/**
+ Posted to tagged device subscribers when a corresponding tagged device is created.
+ */
+extern NSString * const CCHDeviceCreatedNotification;
+
+/**
+ Posted to tagged device subscribers when a corresponding tagged device is updated.
+ */
+extern NSString * const CCHDeviceUpdatedNotification;
+
+/**
+ Posted to tagged device subscribers when a corresponding tagged device is deleted.
+ */
+extern NSString * const CCHDeviceDeletedNotification;
+
 /**
  Beacon option for adding and removing subscriptions.
  */
@@ -83,6 +98,11 @@ extern NSString * const CCHOptionGeofence;
  */
 extern NSString * const CCHOptionVault;
 
+/**
+ Device option for adding and removing subscriptions.
+ */
+extern NSString * const CCHOptionDevice;
+
 
 #define kSubscriptionErrorDomain @"com.contexthub.subscription"
 
@@ -121,6 +141,15 @@ When server changes are made, the device is notified using a background push not
  ### CCHVaultItemDeletedNotification
  the notification object is an id of the vualt item that was deleted.  The userInfo object is not set.
 
+ ### CCHDeviceCreatedNotification
+ the notification object is an NSDictionary representation of the device that was created.  The userInfo object is not set.
+ 
+ ### CCHDeviceUpdatedNotification
+ the notification object is an NSDictionary of representation of the device that was updated.  The userInfo object is not set.
+ 
+ ### CCHDeviceDeletedNotification
+ the notification object is an id of the device that was deleted.  The userInfo object is not set.
+
  */
 @interface CCHSubscriptionService : NSObject
 
@@ -132,9 +161,9 @@ When server changes are made, the device is notified using a background push not
 /**
  Gets all subscriptions for the current device.
  @note Access individual subscriptions using "BeaconSubscription" and "GeofenceSubscription" keys
- @param completion executed when the request completes.  The block is passed an NSDictionary of subscriptions.  If an error occurs, the NSError will be passed to the block.
+ @param completionHandler executed when the request completes.  The block is passed an NSDictionary of subscriptions.  If an error occurs, the NSError will be passed to the block.
  */
-- (void)getSubscriptionsWithCompletion:(void(^)(NSDictionary *subscriptions, NSError *error))completion;
+- (void)getSubscriptionsWithCompletionHandler:(void(^)(NSDictionary *subscriptions, NSError *error))completionHandler;
 
 /**
  Subscribes the device to beacon change notifications for the specified tags.
@@ -168,15 +197,15 @@ When server changes are made, the device is notified using a background push not
  Subscribes the device to change notifications for the specified tags.
  @note This will turn on background push notifications for all elements that have tags matching the tags array specified.  You must enable push notifications, enbale remote notifications and background fetch capabilites, and you must call application:didReceiveRemoteNotification:completionHandler: on CCHPush.
  @param tags An NSArray of tags
- @param options (optional) an NSArray of the elements that you want to subscribe to. (CCHOptionBeacon, CCHOptionGeofence, CCHOptionVault)
+ @param options (optional) an NSArray of the elements that you want to subscribe to. (CCHOptionBeacon, CCHOptionGeofence, CCHOptionVault, CCHOptionDevice)
  @param completionHandler (optional) Is executed when the request completes.  If an error occurs, the NSError will be passed to the block.
  */
 - (void)addSubscriptionsForTags:(NSArray *)tags options:(NSArray *)options completionHandler:(void(^)(NSError *error))completionHandler;
 
 /**
  Unsubscribes the device from change notifications for the specified tags.
  @param tags An NSArray of tags
- @param options (optional) an NSArray of the elements that you want to unsubscribe from. (CCHOptionBeacon, CCHOptionGeofence, CCHOptionVault)
+ @param options (optional) an NSArray of the elements that you want to unsubscribe from. (CCHOptionBeacon, CCHOptionGeofence, CCHOptionVault, CCHOptionDevice)
  @param completionHandler (optional) Is executed when the request completes.  If an error occurs, the NSError will be passed to the block.
  */
 - (void)removeSubscriptionsForTags:(NSArray *)tags options:(NSArray *)options completionHandler:(void(^)(NSError *error))completionHandler;

ContextHub.framework/Versions/A/Headers/CCHSubscriptionService.h

@@ -5,6 +5,8 @@
 //  Created by Travis Fischer on 9/18/13.
 //  Copyright (c) 2013 ChaiOne. All rights reserved.
 //
+//  Version 1.2.0
+//
 
 #import <Foundation/Foundation.h>
 
@@ -20,7 +22,7 @@
 //Application Services
 #import "CCHPush.h"
 #import "CCHVault.h"
-
+#import "CCHDevice.h"
 
 /**
  * The primary interface with the ContextHub SDK
@@ -53,4 +55,9 @@
  If you are using Push Notifications, set this value to YES for debug builds.  This will tell ContextHub that the push token for the device should be used with the Sandbox push service.
  */
 @property (nonatomic, assign) BOOL debug;
+
+/**
+ build version
+ */
+extern NSString * const CCHVersion;
 @end

ContextHub.framework/Versions/A/Headers/ContextHub.h

@@ -1,5 +1,8 @@
-Boundaries (Geofences) Release Notes
----
+# Boundaries (Geofences) Release Notes
+
+## 1.3.2 (Build 172) - August 17, 2014
+- Update to ContextHub v1.2.0 framework
+- Add Table of Contents to README
 
 ## 1.3.1 (Build 171) - August 11, 2014
 - Fix bug where app would alert an error when updating or deleting geofences