Skip to content

Commit

Permalink
Release 7.0.0-beta.3
Browse files Browse the repository at this point in the history
## 7.0.0-beta.3
⚠️ This is a major release which contains breaking API changes.
### BREAKING CHANGE
-
* Minimum required Dart SDK version to 2.18 (Flutter 3.3.0)
* Xcode 15 is the min version
* iOS 12 is the min version

#### SDK Initialization Required
* Use `FlutterBranchSdk.init()` method to initialize the SDK.

Initialization must be called from `main` or at any time (for example after getting consent for GPDR).

```dart
  await FlutterBranchSdk.init(
      useTestKey: false, enableLogging: false, disableTracking: false);
```

Check additional instructions in the README

#### Deprecated / Removed
-
* `FlutterBranchSdk.initSession()`. Use `FlutterBranchSdk.listSession()`.
* Removed `setIOSSKAdNetworkMaxTime` method
* Removed Facebook App Install Ads on iOS

### Features
-
* Issue #244 - Support for setting customer_event_alias for BranchEvent
* Updated compile & target SDK to Android API 33.
* Updated example app Android compileSdkVersion to 33.

### Native SDK Updates
-
* Updated included iOS SDK to 3.0.0 - [iOS Version History](https://github.com/BranchMetrics/ios-branch-deep-linking-attribution/releases)
  • Loading branch information
RodrigoSMarques committed Oct 11, 2023
1 parent c748b8d commit 375a173
Show file tree
Hide file tree
Showing 10 changed files with 134 additions and 36 deletions.
117 changes: 106 additions & 11 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,121 @@
## 7.0.0
## 7.0.0-beta.3
⚠️ This is a major release which contains breaking API changes.
### BREAKING CHANGE
* Call the `FlutterBranchSdk.init()` method to initialize the SDK.
-
* Minimum required Dart SDK version to 2.18 (Flutter 3.3.0)
* Xcode 15 is the min version
* iOS 12 is the min version

Initialization must be called from `main` or at any time, for example after getting consent for GPDR.
#### SDK Initialization Required
* Use `FlutterBranchSdk.init()` method to initialize the SDK.

The `init` method has optional parameters that allow you:
Initialization must be called from `main` or at any time (for example after getting consent for GPDR).

- change from test to live mode
- enable logging
- disable tracking to comply with GDPR.
```dart
await FlutterBranchSdk.init(
useTestKey: false, enableLogging: false, disableTracking: false);
```

* `initSession` deprecated. Use `listSession`.
Check additional instructions in the README

* Removed deprecated methods:
* `setIOSSKAdNetworkMaxTime` method
#### Deprecated / Removed
-
* `FlutterBranchSdk.initSession()`. Use `FlutterBranchSdk.listSession()`.
* Removed `setIOSSKAdNetworkMaxTime` method
* Removed Facebook App Install Ads on iOS

### Enhancement
### Features
-
* Issue #244 - Support for setting customer_event_alias for BranchEvent
* Updated compile & target SDK to Android API 33.
* Updated example app Android compileSdkVersion to 33.

### Native SDK Updates
-
* Updated included iOS SDK to 3.0.0 - [iOS Version History](https://github.com/BranchMetrics/ios-branch-deep-linking-attribution/releases)

## 7.0.0-beta.2
⚠️ This is a major release which contains breaking API changes.
### BREAKING CHANGE
-
#### SDK Initialization Required
* Use `FlutterBranchSdk.init()` method to initialize the SDK.

Initialization must be called from `main` or at any time (for example after getting consent for GPDR).

```dart
await FlutterBranchSdk.init(
useTestKey: false, enableLogging: false, disableTracking: false);
```

Check additional instructions in the README

#### Deprecated / Removed
-
* `FlutterBranchSdk.initSession()`. Use `FlutterBranchSdk.listSession()`.
* Removed `setIOSSKAdNetworkMaxTime` method
* Removed Facebook App Install Ads on iOS

### Features
-
* Issue #244 - Support for setting customer_event_alias for BranchEvent
* Updated compile & target SDK to Android API 33.
* Updated example app Android compileSdkVersion to 33.

## 7.0.0-beta.1
⚠️ This is a major release which contains breaking API changes.
### BREAKING CHANGE
-
#### SDK Initialization Required
* Use `FlutterBranchSdk.init()` method to initialize the SDK.

Initialization must be called from `main` or at any time (for example after getting consent for GPDR).

```dart
await FlutterBranchSdk.init(
useTestKey: false, enableLogging: false, disableTracking: false);
```

Check additional instructions in the README

#### Deprecated / Removed
-
* `FlutterBranchSdk.initSession()`. Use `FlutterBranchSdk.listSession()`.
* Removed `setIOSSKAdNetworkMaxTime` method
* Removed Facebook App Install Ads on iOS

### Features
-
* Updated compile & target SDK to Android API 33.
* Updated example app Android compileSdkVersion to 33.

## 7.0.0-beta.0
⚠️ This is a major release which contains breaking API changes.
### BREAKING CHANGE
-
#### SDK Initialization Required
* Use `FlutterBranchSdk.init()` method to initialize the SDK.

Initialization must be called from `main` or at any time (for example after getting consent for GPDR).

```dart
await FlutterBranchSdk.init(
useTestKey: false, enableLogging: false, disableTracking: false);
```

Check additional instructions in the README

#### Deprecated / Removed
-
* `FlutterBranchSdk.initSession()`. Use `FlutterBranchSdk.listSession()`.
* Removed `setIOSSKAdNetworkMaxTime` method

### Features
-
* Updated compile & target SDK to Android API 33.
* Updated example app Android compileSdkVersion to 33.


## 6.8.0
* Updated Native `Android` SDKs:
* Android Native SDK Update 5.7.+ - [Android Version History](https://github.com/BranchMetrics/android-branch-deep-linking-attribution/releases)
Expand Down
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,14 +146,16 @@ To initialize Branch:
```dart
import 'package:flutter_branch_sdk/flutter_branch_sdk.dart';
BranchSdk.init();
///options:
/// default false for all options
/// [useTestKey] - Sets `true` to use the test `key_test_...
/// [enableLogging] - Sets `true` turn on debug logging
/// [disableTracking] - Sets `true` to disable tracking in Branch SDK for GDPR compliant on start. After having consent, sets `false`
await FlutterBranchSdk.init(
useTestKey: false, enableLogging: false, disableTracking: false);
```

The optional parameters are:

- *useTestKey* : Sets `true` to use the test `key_test_....` .Default value: false
- *enableLogging* : Sets `true` turn on debug logging. Default value: false
- *disableTracking*: Sets `true` to disable tracking in Branch SDK for GDPR compliant on start. Default value: false

Initialization must be called from `main` or at any time, for example after getting consent for GPDR.

To guarantee the success of this function, ensure you've called the below in the app's main function
Expand Down
2 changes: 1 addition & 1 deletion example/ios/Podfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Uncomment this line to define a global platform for your project
platform :ios, '11.0'
platform :ios, '12.0'

# CocoaPods analytics sends network stats synchronously affecting flutter build latency.
ENV['COCOAPODS_DISABLE_STATS'] = 'true'
Expand Down
14 changes: 7 additions & 7 deletions example/ios/Podfile.lock
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
PODS:
- BranchSDK (2.2.0)
- BranchSDK (3.0.0)
- Flutter (1.0.0)
- flutter_branch_sdk (7.0.0):
- BranchSDK (~> 2.2.0)
- flutter_branch_sdk (7.0.0-beta.2):
- BranchSDK (~> 3.0.0)
- Flutter

DEPENDENCIES:
Expand All @@ -20,10 +20,10 @@ EXTERNAL SOURCES:
:path: ".symlinks/plugins/flutter_branch_sdk/ios"

SPEC CHECKSUMS:
BranchSDK: 8749d10e30725d08b6c188ab90e6fd6223d204db
BranchSDK: e9c0332b2655cf0357d93db479d07152b059e434
Flutter: f04841e97a9d0b0a8025694d0796dd46242b2854
flutter_branch_sdk: c1d49be5fdb6bc5b3caf60e3d7890ffdc17ded48
flutter_branch_sdk: d44ccbe957868d4ff816258a436c23959f6e4cda

PODFILE CHECKSUM: 7368163408c647b7eb699d0d788ba6718e18fb8d
PODFILE CHECKSUM: 4e8f8b2be68aeea4c0d5beb6ff1e79fface1d048

COCOAPODS: 1.12.1
COCOAPODS: 1.13.0
3 changes: 2 additions & 1 deletion example/lib/main.dart
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,9 @@ void main() async {
FlutterBranchSdk.setRequestMetadata('key1', 'value1');
FlutterBranchSdk.setRequestMetadata('key2', 'value2');
*/
await FlutterBranchSdk.init(useTestKey: true, enableLogging: true);
//await FlutterBranchSdk.requestTrackingAuthorization();
await FlutterBranchSdk.init(
useTestKey: false, enableLogging: false, disableTracking: false);
runApp(const MyApp());
}

Expand Down
4 changes: 2 additions & 2 deletions example/pubspec.lock
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ packages:
path: ".."
relative: true
source: path
version: "7.0.0-beta.2"
version: "7.0.0-beta.3"
flutter_lints:
dependency: "direct dev"
description:
Expand Down Expand Up @@ -214,4 +214,4 @@ packages:
version: "0.1.4-beta"
sdks:
dart: ">=3.1.0-185.0.dev <4.0.0"
flutter: ">=2.5.0"
flutter: ">=3.3.0"
2 changes: 1 addition & 1 deletion example/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Demonstrates how to use the flutter_branch_sdk plugin.
publish_to: 'none' # Remove this line if you wish to publish to pub.dev

environment:
sdk: ">=2.17.3 <4.0.0"
sdk: ">=2.18.0 <4.0.0"

# Dependencies specify other packages that your package needs in order to work.
# To automatically upgrade your package dependencies to the latest versions
Expand Down
4 changes: 2 additions & 2 deletions ios/flutter_branch_sdk.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ Flutter Plugin for create deep link using Brach SDK (https://branch.io). This pl
s.source = { :path => '.' }
s.source_files = 'Classes/**/*'
s.dependency 'Flutter'
s.dependency 'BranchSDK', '~> 2.2.1'
s.platform = :ios, '11.0'
s.dependency 'BranchSDK', '~> 3.0.0'
s.platform = :ios, '12.0'
# Flutter.framework does not contain a i386 slice.
s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES', 'EXCLUDED_ARCHS[sdk=iphonesimulator*]' => 'i386' }
s.swift_version = '5.0'
Expand Down
2 changes: 1 addition & 1 deletion pubspec.lock
Original file line number Diff line number Diff line change
Expand Up @@ -199,4 +199,4 @@ packages:
version: "0.1.4-beta"
sdks:
dart: ">=3.1.0-185.0.dev <4.0.0"
flutter: ">=2.5.0"
flutter: ">=3.3.0"
8 changes: 4 additions & 4 deletions pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
name: flutter_branch_sdk
description: Flutter Plugin for create deep link using Brach SDK (https://branch.io). This plugin provides a cross-platform (iOS, Android, Web).
version: 7.0.0-beta.2
version: 7.0.0-beta.3
homepage: https://github.com/RodrigoSMarques/flutter_branch_sdk

environment:
sdk: ">=2.17.3 <4.0.0"
flutter: ">=2.5.0"
sdk: ">=2.18.0 <4.0.0"
flutter: ">=3.3.0"

dependencies:
flutter:
sdk: flutter
flutter_web_plugins:
sdk: flutter
plugin_platform_interface: ^2.1.4
plugin_platform_interface: ^2.1.6
js: ^0.6.7

dev_dependencies:
Expand Down

1 comment on commit 375a173

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.