Skip to content

Commit 031cacb

Browse files
author
Bitrise Bot
committed
New release 3.0.2
1 parent 3894216 commit 031cacb

File tree

7 files changed

+156
-140
lines changed

7 files changed

+156
-140
lines changed
0 Bytes
Binary file not shown.

Beaconstac/Beaconstac.framework/Headers/Beaconstac.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
// Copyright © 2017 MobStac. All rights reserved.
77
//
88

9+
#import <Foundation/Foundation.h>
910
#import <UIKit/UIKit.h>
1011

1112
//! Project version number for Beaconstac.
0 Bytes
Binary file not shown.

BeaconstacSampleApp/BeaconstacSampleApp.xcodeproj/project.pbxproj

Lines changed: 116 additions & 116 deletions
Large diffs are not rendered by default.

BeaconstacSampleApp/BeaconstacSampleApp.xcodeproj/xcshareddata/xcschemes/BeaconstacSampleApp.xcscheme

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
buildForArchiving = "YES">
1515
<BuildableReference
1616
BuildableIdentifier = 'primary'
17-
BlueprintIdentifier = '26B449E61397E553C4680487'
17+
BlueprintIdentifier = '9F0867E28FFEC5C61D8ACB27'
1818
BlueprintName = 'BeaconstacSampleApp'
1919
ReferencedContainer = 'container:BeaconstacSampleApp.xcodeproj'
2020
BuildableName = 'BeaconstacSampleApp.app'>
@@ -32,7 +32,7 @@
3232
<MacroExpansion>
3333
<BuildableReference
3434
BuildableIdentifier = 'primary'
35-
BlueprintIdentifier = '26B449E61397E553C4680487'
35+
BlueprintIdentifier = '9F0867E28FFEC5C61D8ACB27'
3636
BlueprintName = 'BeaconstacSampleApp'
3737
ReferencedContainer = 'container:BeaconstacSampleApp.xcodeproj'
3838
BuildableName = 'BeaconstacSampleApp.app'>
@@ -55,7 +55,7 @@
5555
runnableDebuggingMode = "0">
5656
<BuildableReference
5757
BuildableIdentifier = 'primary'
58-
BlueprintIdentifier = '26B449E61397E553C4680487'
58+
BlueprintIdentifier = '9F0867E28FFEC5C61D8ACB27'
5959
BlueprintName = 'BeaconstacSampleApp'
6060
ReferencedContainer = 'container:BeaconstacSampleApp.xcodeproj'
6161
BuildableName = 'BeaconstacSampleApp.app'>
@@ -71,7 +71,7 @@
7171
<BuildableProductRunnable>
7272
<BuildableReference
7373
BuildableIdentifier = 'primary'
74-
BlueprintIdentifier = '26B449E61397E553C4680487'
74+
BlueprintIdentifier = '9F0867E28FFEC5C61D8ACB27'
7575
BlueprintName = 'BeaconstacSampleApp'
7676
ReferencedContainer = 'container:BeaconstacSampleApp.xcodeproj'
7777
BuildableName = 'BeaconstacSampleApp.app'>

CHANGELOG.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
### v3.0.1 released on December 14, 2017
1+
### v3.0.2 released on December 20, 2017
2+
3+
* Fixed pod issues
4+
* Fixed documentation
5+
* Fixed path issues for the Sample App and the pod spec
26

3-
* Event Logging changes.
4-
* Fix defnition of `BeaconDelegate`'s didRagneBeacons to return `MBeacon` objects.
5-
* Fix method signature.
67

7-
### v3.0.2 released on December 14, 2017
8+
### v3.0.1 released on December 14, 2017
89

910
* Event Logging changes.
1011
* Fix defnition of `BeaconDelegate`'s didRagneBeacons to return `MBeacon` objects.

README.md

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,12 @@ Try out the Beaconstac Demo app on the [iTunes App Store](https://itunes.apple.c
1515

1616
## Installation
1717
##### Using Cocoapods (recommended):
18-
Add the following to your Podfile in your project
18+
Add the following to your Podfile in your project, we are supporting iOS 10.0+ make sure your pod has proper platform set.
1919

2020
```pod
21-
pod 'Beaconstac'
21+
platform :ios, '10.0'
22+
target '<My-App-Target>''
23+
pod 'Beaconstac', '~> 3.0'
2224
```
2325

2426
Run `pod install` in the project directory
@@ -30,18 +32,17 @@ Run `pod install` in the project directory
3032
2. Drag and drop the Beaconstac.framework file into your Xcode project. Make sure that "Copy Items to Destination's Group Folder" is checked.
3133
<img src="images/frameworkdrop.png" alt="Build Phases" width="600">
3234

33-
3. Navigate to Beaconstac.framework/Resources folder in Finder and drop the Beaconstac.bundle into Project navigator area. Make sure that "Copy Items to Destination's Group Folder" checked.
34-
<img src="images/bundledrop.png" alt="Build Phases" width="600">
35+
3. Add the `Beaconstac.framework` to the embedded binaries section of your destination app target.
3536

36-
4. In Build Phases under Target, add the following frameworks in “Link Binary With Libraries” section:
37+
4. In Build Phases under destination app target, add the following frameworks in Link Binary With Libraries section:
3738
- CoreData.framework
3839
- SystemConfiguration.framework
3940
- CoreBluetooth.framework
4041
- CoreLocation.framework
4142

4243
## Configure your project
4344

44-
1. In Info.plist, add a new fields, `NSLocationAlwaysUsageDescription`, `NSLocationAlwaysAndWhenInUsageDescription` with relevant values that you want to show to the user. This is mandatory for iOS 10 and above.
45+
1. In Info.plist, add a new fields, `NSLocationAlwaysUsageDescription`, `NSLocationAlwaysAndWhenInUsageDescription`, `NSBluetoothPeripheralUsageDescription` with relevant values that you want to show to the user. This is mandatory for iOS 10 and above.
4546
<img src="images/usagedescription.png" alt="Build Phases" width="600">
4647

4748
## Pre-requisite
@@ -58,6 +59,12 @@ __MY_DEVELOPER_TOKEN__
5859

5960
The app should provide the developer token while initializing the SDK. Get it from [Beaconstac Dashboard Account Page](https://dashboard.beaconstac.com/#/account).
6061

62+
## Beaconstac Sample App
63+
64+
To run our Beaconstac Sample App make the following changes to the build settings.
65+
1. Search for `Framework Search Paths`
66+
2. Change the value to the abosulte path of the `Beaconstac.framework`.
67+
6168
## Set Up
6269

6370
1. Import the framework header in your class
@@ -70,7 +77,13 @@ import Beaconstac
7077

7178
```swift
7279
do {
73-
beaconstacInstance = try Beaconstac.sharedInstance("MY_DEVELOPER_TOKEN")
80+
Beaconstac.sharedInstance("MY_DEVELOPER_TOKEN", completion: : { (beaconstac, error) in
81+
if let beaconstacInstance = beaconstac {
82+
// Successful...
83+
} else if let e = error {
84+
print(e)
85+
}
86+
}))
7487
} catch let error {
7588
print(error)
7689
}
@@ -79,17 +92,19 @@ do {
7992

8093
3. If you want to use the `advacnced integration`, use __iBeaconOption__ as defined below
8194

82-
| iBeaconOption | Location Authorization | Monitoring | Ranging | Description |
95+
| iBeaconOption | Location Authorization | Monitoring | Ranging | Description |
8396
|:------------------------------:|:--------------------------:|:--------------------------------:| :------------------------:|:----------------------------------------------:|
8497
| WhenInUse | When In Use Authorization | CoreLocation API doesn't support | CoreLocation API supports | App should be in the foreground |
8598
| BackgroundRangeOnDisplayWakeUp | Always Authorization | CoreLocation API supports | CoreLocation API supports | App can be in the background but doesn't range |
8699

87100
```swift
88101
do {
89-
beaconstacInstance = try Beaconstac.sharedInstance("My_DEVELOPER_TOKEN", ibeaconOption: .BackgroundRangeOnDisplayWakeUp, delegate: self, completion: : { (beaconstac, error) in
90-
if error == nil {
91-
beaconstac?.startScanningBeacons()
92-
// Initialization successful, it just works...
102+
Beaconstac.sharedInstance("My_DEVELOPER_TOKEN", ibeaconOption: .BackgroundRangeOnDisplayWakeUp, delegate: self, completion: : { (beaconstac, error) in
103+
if let beaconstacInstance = beaconstac {
104+
beaconstac?.startScanningBeacons()
105+
// Initialization successful, it just works...
106+
} else if let e = error {
107+
print(e)
93108
}
94109
})
95110
} catch let error {
@@ -203,7 +218,7 @@ beaconstacInstance.BEACON_EXIT_BIAS = 15 // Set the difference value
203218
```swift
204219

205220
// Check if the notification is from SDK and provide UNNotificationPresentationOptions or nil by invoking the below method.
206-
public func notificatoinOptionsForBeaconstacNotification(_ notification: UNNotification) -> UNNotificationPresentationOptions?
221+
public func notificationOptionsForBeaconstacNotification(_ notification: UNNotification) -> UNNotificationPresentationOptions?
207222

208223

209224
// EXAMPLE:
@@ -219,7 +234,6 @@ func userNotificationCenter(_ center: UNUserNotificationCenter, willPresent noti
219234

220235

221236

222-
223237
// Check if SDK can handle the notification by invoking the below method.
224238
public func showCardViewerForLocalNotification(_ notification: UNNotification) -> Bool
225239

@@ -239,7 +253,7 @@ func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive respo
239253
12. You are required to `add filters` regarding the app user, if the marketer has provided the filters. To do so
240254

241255
```swift
242-
// Provide the filters to the SDK as Key-Value pairs using dictionary. Note keys are keys insensitive.
256+
// Provide the filters to the SDK as Key-Value pairs using dictionary. Note keys are case insensitive.
243257
func addFilters(_ filters: Dictionary<String, Any>)
244258
```
245259
__Note__: If the rule contains the filters and app doesn't provide it, the rule will be treated as a filter validation failed and we won't trigger that particular rule.

0 commit comments

Comments
 (0)