Flutter Branch SDK

https://pub.dev/documentation/flutter_branch_sdk/latest/
Admin
Flutter Branch SDK is a plugin that integrates Branch.io deep linking and attribution, enabling...
Tokens:68,611
Snippets:525
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Retrieve First Install Parameters

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

Retrieves parameters associated with the app's first install event.

```APIDOC
## Retrieve Install (Install Only) Parameters

### Description
Retrieves the parameters that were passed during the app's first install event. This is particularly useful for rewarding users who newly installed the app via a referral link.

### Method
`FlutterBranchSdk.getFirstReferringParams()`

### Usage
On iOS, this method must be called to obtain installation data if `FlutterBranchSdk.listSession()` returns `{+is_first_session: true, +clicked_branch_link: false}`.

### Response Example
```dart
Map<dynamic, dynamic> params = await FlutterBranchSdk.getFirstReferringParams();
// Use params for first install data
```
```

--------------------------------

### Full index.html Example with Branch Integration

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

A complete example of an `index.html` file for a Flutter web application, including the Branch SDK initialization script. This demonstrates the placement of the script within the `<body>` tag and the necessary HTML structure.

```html
<!DOCTYPE html>
<html>
<head>
  <!--
    If you are serving your web app in a path other than the root, change the
    href value below to reflect the base path you are serving from.

    The path provided below has to start and end with a slash "/" in order for
    it to work correctly.

    For more details:
    * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/base

    This is a placeholder for base href that will be replaced by the value of
    the `--base-href` argument provided to `flutter build`.
  -->
  <base href="$FLUTTER_BASE_HREF">

  <meta charset="UTF-8">
  <meta content="IE=Edge" http-equiv="X-UA-Compatible">
  <meta name="description" content="Demonstrates how to use the flutter_branch_sdk plugin.">

  <!-- iOS meta tags & icons -->
  <meta name="apple-mobile-web-app-capable" content="yes">
  <meta name="apple-mobile-web-app-status-bar-style" content="black">
  <meta name="apple-mobile-web-app-title" content="Flutter Branch SDK Example">
  <link rel="apple-touch-icon" href="icons/Icon-192.png">

  <!-- Favicon -->
  <link rel="icon" type="image/png" href="favicon.png"/>

  <title>Flutter Branch SDK Example</title>
  <link rel="manifest" href="manifest.json">
</head>
<body>
  <script>
    // load Branch
    (function(b,r,a,n,c,h,_,s,d,k){if(!b[n]||!b[n]._q){for(;s<_.length;)c(h,_[s++]);d=r.createElement(a);d.async=1;d.src="https://cdn.branch.io/branch-latest.min.js";k=r.getElementsByTagName(a)[0];k.parentNode.insertBefore(d,k);b[n]=h}})(window,document,"script","branch",function(b,r){b[r]=function(){b._q.push([r,arguments])}},{_q:[],_v:1},"addListener banner closeBanner closeJourney data deepview deepviewCta first init link logout removeListener setBranchViewData setIdentity track trackCommerceEvent logEvent disableTracking getBrowserFingerprintId crossPlatformIds lastAttributedTouchData setAPIResponseCallback qrCode setRequestMetaData setAPIUrl getAPIUrl setDMAParamsForEEA".split(" "), 0);
    var options = { 'no_journeys': true, 'tracking_disabled' : false };
    // init Branch - Replace key_live_YOUR_KEY_GOES_HERE with your Branch Key (live version)
    branch.init('key_live_or_test_YOUR_KEY_GOES_HERE', options, function(err, data) {
      if (err != null) {
        console.log('err: ' + err);
      }
    });
  </script>

  <script src="flutter_bootstrap.js" async></script>
</body>
</html>

```

--------------------------------

### Retrieve First Install Parameters

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

Retrieve the parameters passed during the first install event. This is useful for rewarding users who newly installed the app via a referral link. Note: On iOS, this method must be called if FlutterBranchSdk.listSession() returns {+is_first_session: true, +clicked_branch_link: false}.

```dart
Map<dynamic, dynamic> params = await FlutterBranchSdk.getFirstReferringParams();
```

--------------------------------

### Configure Install Referrer Timeout via JSON

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

Configure the Install Referrer timeout via the branch-config.json file for automatic application on SDK initialization. This is the recommended approach. A timeout of 0 disables the timeout.

```json
{
  "installReferrerTimeout": 5000
}
```

--------------------------------

### Install Referrer Timeout Setting

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk-class.html

Method to set the timeout for the install referrer.

```APIDOC
## POST /set/install_referrer_timeout

### Description
Sets the timeout in milliseconds for the install referrer.

### Method
POST

### Endpoint
/set/install_referrer_timeout

### Parameters
#### Request Body
- **timeoutMs** (Integer) - Required - The timeout in milliseconds.

### Response
#### Success Response (200)
void
```

--------------------------------

### Set Install Referrer Timeout

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

Configure the timeout for fetching the Install Referrer string. This optimizes Android performance by limiting the SDK's wait time. Applicable only on Android.

```APIDOC
## Set Install Referrer Timeout

### Description
Provides a setting to cancel the external Install Referrer string fetch. This is useful to optimize performance on Android by limiting the time the SDK waits for the Install Referrer. Only applicable on Android - iOS ignores this setting.

### Method
This is configured via a parameter or a configuration file.

### Parameters
#### Configuration File (`branch-config.json`)
- **installReferrerTimeout** (Integer): Timeout in milliseconds. Must be >= 0. Default is `0`. A value of `0` is meaningful and disables the timeout (`no timeout`).

#### Dart Code
- **timeoutMs** (Integer): Timeout in milliseconds. Must be >= 0. Default is `0`. A value of `0` is meaningful and disables the timeout (`no timeout`).

### Request Example
**Via Dart:**
```dart
// Set timeout to 5 seconds (5000 milliseconds)
FlutterBranchSdk.setInstallReferrerTimeout(5000);
```

**Via branch-config.json (recommended - applied on app startup):**
```json
{
  "installReferrerTimeout": 5000
}
```

### Platform Notes
- **Android**: Sets the timeout for retrieving the Install Referrer string from Google Play Services.
- **iOS**: Not supported.
- **Web**: Not supported.

### Default Value
The default for `installReferrerTimeout` is `0`, which means no timeout.
```

--------------------------------

### setInstallReferrerTimeout static method

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/setInstallReferrerTimeout.html

Provides a setting to cancel the external Install Referrer string fetch. Default is 0 milliseconds, no timeout.

```APIDOC
## setInstallReferrerTimeout static method

### Description
Provides a setting to cancel the external Install Referrer string fetch. Default is 0 milliseconds, no timeout.

### Method
static void

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **timeoutMs** (int) - Required - The timeout duration in milliseconds.

### Request Example
```json
{
  "timeoutMs": 5000
}
```

### Response
#### Success Response (200)
This method does not return a value.

#### Response Example
N/A
```

--------------------------------

### Set Install Referrer Timeout - Dart

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/setInstallReferrerTimeout.html

Use this method to set a timeout for fetching the external Install Referrer string. The default value is 0 milliseconds, which indicates no timeout.

```dart
static void setInstallReferrerTimeout(int timeoutMs) {
  FlutterBranchSdkPlatform.instance.setInstallReferrerTimeout(timeoutMs);
}
```

--------------------------------

### Set Install Referrer Timeout via Dart

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

Set the timeout for fetching the Install Referrer string on Android. This optimizes performance by limiting the SDK's wait time. Only applicable on Android.

```dart
// Set timeout to 5 seconds (5000 milliseconds)
FlutterBranchSdk.setInstallReferrerTimeout(5000);
```

--------------------------------

### handleDeepLink static method

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/handleDeepLink.html

Ends the current deep link session and starts a new one with the provided URL.

```APIDOC
## void handleDeepLink(String url)

### Description
Have Branch end the current deep link session and start a new session with the provided URL.

### Method
static

### Parameters
#### Path Parameters
- **url** (String) - Required - The URL to handle for the new deep link session.

### Implementation
```dart
static void handleDeepLink(String url) {
  FlutterBranchSdkPlatform.instance.handleDeepLink(url);
}
```
```

--------------------------------

### Initialize Branch SDK

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdkPlatform/init.html

Initializes the Branch SDK with optional parameters for logging and attribution. Use this to configure the SDK at the start of your application. Ensure to set appropriate log levels for debugging.

```dart
Future<void> init({
  bool enableLogging = false,
  BranchLogLevel logLevel = BranchLogLevel.VERBOSE,
  BranchAttributionLevel? branchAttributionLevel,
}) async {
  throw UnimplementedError('init has not been implemented');
}
```

--------------------------------

### Initialize imageUrl Property

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/BranchUniversalObject/imageUrl.html

Initializes the imageUrl property as an empty string. This is a common starting point for string properties.

```dart
String imageUrl = '';
```

--------------------------------

### Initialize Coupon Property

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/BranchEvent/coupon.html

Initializes the coupon property as an empty string. This is a common starting point for string properties.

```dart
String coupon = '';
```

--------------------------------

### addSnapPartnerParameter static method

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/addSnapPartnerParameter.html

Adds a Partner Parameter for Snap. Once set, this parameter is attached to installs, opens and events until cleared or the app restarts.

```APIDOC
## addSnapPartnerParameter static method

### Description
Add a Partner Parameter for Snap. Once set, this parameter is attached to installs, opens and events until cleared or the app restarts.

### Method
static void

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **key** (String) - Required - The key for the partner parameter.
- **value** (String) - Required - The value for the partner parameter.

### Request Example
```json
{
  "key": "example_key",
  "value": "example_value"
}
```

### Response
#### Success Response (200)
This method does not return a value.

#### Response Example
None
```

--------------------------------

### Defer iOS SDK Initialization

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

Create this JSON file in `ios/Runner/` to prevent the Branch SDK from initializing automatically on app start. Initialization will then wait until `FlutterBranchSdk.init()` is called.

```json
{
    "deferInitForPluginRuntime": true
}
```

--------------------------------

### Initialize searchQuery Property

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/BranchEvent/searchQuery.html

Initializes the searchQuery property as an empty string. This is a common starting point for search-related functionality.

```dart
String searchQuery = '';
```

--------------------------------

### Implement setPreinstallCampaign Static Method

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/setPreinstallCampaign.html

This method adds pre-install campaign analytics. It requires a String value representing the campaign.

```dart
static void setPreinstallCampaign(String value) {
  FlutterBranchSdkPlatform.instance.setPreinstallCampaign(value);
}
```

--------------------------------

### Get isStandardEvent Property

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/BranchEvent/isStandardEvent.html

Use this getter to check if the event is a standard Branch event. No specific setup or imports are required beyond the Branch SDK initialization.

```dart
bool get isStandardEvent => _isStandardEvent;
```

--------------------------------

### Initialize Branch SDK in index.html

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

Add this script to the top of your `<body>` tag in `web/index.html` to load and initialize the Branch Javascript SDK. Replace 'key_live_or_test_YOUR_KEY_GOES_HERE' with your actual Branch key. Ensure the Branch key is correctly configured, as initialization failure will prevent subsequent Branch method calls.

```html
<script>
    // load Branch
    (function(b,r,a,n,c,h,_,s,d,k){if(!b[n]||!b[n]._q){for(;s<_.length;)c(h,_[s++]);d=r.createElement(a);d.async=1;d.src="https://cdn.branch.io/branch-latest.min.js";k=r.getElementsByTagName(a)[0];k.parentNode.insertBefore(d,k);b[n]=h}})(window,document,"script","branch",function(b,r){b[r]=function(){b._q.push([r,arguments])}},{_q:[],_v:1},"addListener banner closeBanner closeJourney data deepview deepviewCta first init link logout removeListener setBranchViewData setIdentity track trackCommerceEvent logEvent disableTracking getBrowserFingerprintId crossPlatformIds lastAttributedTouchData setAPIResponseCallback qrCode setRequestMetaData setAPIUrl getAPIUrl setDMAParamsForEEA".split(" "), 0);
    var options = { 'no_journeys': true, 'tracking_disabled' : false };
    // init Branch - Replace key_live_YOUR_KEY_GOES_HERE with your Branch Key (live version)
    branch.init('key_live_or_test_YOUR_KEY_GOES_HERE', options, function(err, data) {
      if (err != null) {
        console.log('err: ' + err);
      }
    });
  </script>
```

--------------------------------

### Implement setPreinstallCampaign Method

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdkPlatform/setPreinstallCampaign.html

This method is used to add pre-install campaign analytics. It is currently unimplemented.

```dart
void setPreinstallCampaign(String value) {
  throw UnimplementedError('setPreinstallCampaign has not been implemented');
}
```

--------------------------------

### setPreinstallCampaign Method

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdkPlatform/setPreinstallCampaign.html

Adds pre-install campaign analytics to track campaign performance.

```APIDOC
## setPreinstallCampaign

### Description
Adds the pre-install campaign analytics.

### Method
void

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **value** (String) - Required - The value representing the pre-install campaign.

### Request Example
```dart
setPreinstallCampaign("your_campaign_value");
```

### Response
This method does not return a value.

### Error Handling
This method is marked as `UnimplementedError` and should be implemented by the developer.
```

--------------------------------

### Implement setPreinstallPartner

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/setPreinstallPartner.html

Use this static method to add pre-install campaign analytics. It requires a String value representing the partner.

```dart
static void setPreinstallPartner(String value) {
  FlutterBranchSdkPlatform.instance.setPreinstallPartner(value);
}
```

--------------------------------

### setPreinstallCampaign Static Method

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/setPreinstallCampaign.html

Adds pre-install campaign analytics to the SDK.

```APIDOC
## setPreinstallCampaign(String value)

### Description
Adds the pre-install campaign analytics.

### Method
static void

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### setPreinstallPartner static method

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/setPreinstallPartner.html

Adds pre-install campaign analytics by setting the partner name.

```APIDOC
## setPreinstallPartner static method

### Description
Adds the pre-install campaign analytics by setting the partner name.

### Method
static void

### Endpoint
N/A (This is a static method call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```dart
FlutterBranchSdk.setPreinstallPartner("partner_name");
```

### Response
This method does not return a value.
```

--------------------------------

### BranchLogLevelExtension

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/BranchLogLevelExtension.html

Provides a way to get the string representation of BranchLogLevel.

```APIDOC
## BranchLogLevelExtension Extension

### Description
Extension to convert BranchLogLevel to its string representation.

### Properties

- **value** (String) - Available on BranchLogLevel, provided by the BranchLogLevelExtension extension. No setter.

### Usage Example

```dart
BranchLogLevel level = BranchLogLevel.debug;
String levelString = level.toString(); // "debug"
```
```

--------------------------------

### Development Environment Configuration

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

Configure your Branch SDK for development with verbose logging and test instance enabled. Ensure `testKey` is used.

```json
{
  "testKey": "key_test_xxxx",
  "useTestInstance": true,
  "enableLogging": true,
  "logLevel": "VERBOSE",
  "installReferrerTimeout": 5000
}
```

--------------------------------

### Tracking Authorization

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdkPlatform-class.html

Methods to get the current tracking authorization status and request it from the user.

```APIDOC
## GET /tracking/authorization/status

### Description
Returns the App Tracking Status. On Android, this returns 'notSupported'.

### Method
GET

### Endpoint
/tracking/authorization/status

### Response
#### Success Response (200)
- **status** (AppTrackingStatus) - The current app tracking authorization status.

#### Response Example
```json
{
  "status": "authorized"
}
```

## POST /tracking/authorization/request

### Description
Requests App Tracking Authorization from the user and returns the AppTrackingStatus. On Android, this returns 'notSupported'.

### Method
POST

### Endpoint
/tracking/authorization/request

### Response
#### Success Response (200)
- **status** (AppTrackingStatus) - The status after requesting authorization.

#### Response Example
```json
{
  "status": "denied"
}
```
```

--------------------------------

### Implement setPreinstallPartner Method

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdkPlatform/setPreinstallPartner.html

This snippet shows the basic implementation of the setPreinstallPartner method. It is currently unimplemented and throws an UnimplementedError.

```dart
void setPreinstallPartner(String value) {
  throw UnimplementedError('setPreinstallPartner has not been implemented');
}
```

--------------------------------

### Get Default FlutterBranchSdkPlatform Instance

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdkPlatform/instance.html

Retrieve the default instance of FlutterBranchSdkPlatform. Defaults to `FlutterBranchSdkMethodChannel`.

```dart
static FlutterBranchSdkPlatform get instance => _instance;
```

--------------------------------

### Width Property

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/BranchQrCode/width.html

The width property allows you to set or get the width of an element. It is an optional integer.

```APIDOC
## Width Property

### Description

This property represents the width of an element. It can be set or retrieved.

### Type

`int?` (Nullable Integer)

### Implementation

```dart
int? width;
```

### Usage

This is a getter/setter pair, allowing for direct manipulation of the width value.
```

--------------------------------

### Production Environment Configuration (No Logs)

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

Configure your Branch SDK for production with logging disabled. Ensure `liveKey` is used and `useTestInstance` is false.

```json
{
  "liveKey": "key_live_xxxx",
  "useTestInstance": false,
  "enableLogging": false,
  "installReferrerTimeout": 3000
}
```

--------------------------------

### setPreinstallPartner Method

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdkPlatform/setPreinstallPartner.html

This method allows you to add pre-install campaign analytics. It takes a single string value representing the partner identifier.

```APIDOC
## setPreinstallPartner

### Description
Adds pre-install campaign analytics for a specified partner.

### Method
N/A (This is a method call, not an HTTP endpoint)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **value** (String) - Required - The identifier for the pre-install partner.

### Request Example
```dart
BranchSdk.setPreinstallPartner("partner_name");
```

### Response
This method does not return a value directly. It is used for its side effects of tracking analytics.

#### Success Response (N/A)
N/A

#### Response Example
N/A
```

--------------------------------

### Get Device Advertising Identifier

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

Retrieves the device's advertising identifier. This is useful for tracking and analytics purposes.

```dart
String identifier = await FlutterBranchSdk.getAdvertisingIdentifier();
print(identifier);

```

--------------------------------

### Get Advertising Identifier - Dart

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/getAdvertisingIdentifier.html

Call this method to retrieve the advertising identifier. On Android, it returns an empty string.

```dart
static Future<String> getAdvertisingIdentifier() async {
  return FlutterBranchSdkPlatform.instance.getAdvertisingIdentifier();
}
```

--------------------------------

### Production Environment Configuration (Errors Only)

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

Configure your Branch SDK for production with error logging only. Ensure `liveKey` is used and `useTestInstance` is false.

```json
{
  "liveKey": "key_live_xxxx",
  "useTestInstance": false,
  "enableLogging": true,
  "logLevel": "ERROR",
  "installReferrerTimeout": 3000
}
```

--------------------------------

### Get Tracking Authorization Status

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/getTrackingAuthorizationStatus.html

Retrieves the current app tracking authorization status. On Android, this will return 'notSupported'.

```APIDOC
## getTrackingAuthorizationStatus static method

### Description
Retrieves the current app tracking authorization status.

### Method
`static Future<AppTrackingStatus> getTrackingAuthorizationStatus()`

### Endpoint
N/A (This is a static method call)

### Parameters
None

### Request Body
None

### Response
#### Success Response
- **AppTrackingStatus** (enum) - The current authorization status. Possible values include `authorized`, `denied`, `notDetermined`, `restricted`, and `notSupported` (on Android).

### Response Example
```dart
// Example of a successful response (actual value depends on platform and user settings)
AppTrackingStatus status = await getTrackingAuthorizationStatus();
print(status); // e.g., AppTrackingStatus.authorized or AppTrackingStatus.notSupported
```

### Implementation Example
```dart
static Future<AppTrackingStatus> getTrackingAuthorizationStatus() async {
  return FlutterBranchSdkPlatform.instance.getTrackingAuthorizationStatus();
}
```
```

--------------------------------

### Get Keywords for BranchUniversalObject

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/BranchUniversalObject/getKeywords.html

Retrieves the list of keywords associated with a BranchUniversalObject. This method returns a pre-defined list of keywords.

```dart
List<String> getKeywords() {
  return keywords;
}
```

--------------------------------

### Initializing the Branch SDK

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

Initializes the Branch SDK with optional logging and tracking configurations. Ensure `WidgetsFlutterBinding.ensureInitialized()` is called before this in your `main` function.

```APIDOC
## Initializing the Branch SDK

### Description
Initializes the Branch SDK. This function should be called early in your application's lifecycle, ideally in the `main` function or after obtaining user consent for GDPR.

### Method
`FlutterBranchSdk.init()`

### Parameters
#### Optional Parameters
- **enableLogging** (bool) - Optional - Sets `true` to turn on debug logging. Default value: `false`.
- **logLevel** (BranchLogLevel) - Optional - Controls the verbosity of logs. Default value: `BranchLogLevel.VERBOSE`.
  - `BranchLogLevel.VERBOSE`: All logs including verbose messages (most detailed).
  - `BranchLogLevel.DEBUG`: Debug level logs for development.
  - `BranchLogLevel.INFO`: Informational messages.
  - `BranchLogLevel.WARNING`: Warning messages only.
  - `BranchLogLevel.ERROR`: Error messages only.
  - `BranchLogLevel.NONE`: No logging.
- **branchAttributionLevel** (BranchAttributionLevel) - Optional - The level of attribution data to collect. Default value: `BranchAttributionLevel.FULL`.
  - `BranchAttributionLevel.FULL`: Full Attribution (Default).
  - `BranchAttributionLevel.REDUCED`: Reduced Attribution (Non-Ads + Privacy Frameworks).
  - `BranchAttributionLevel.MINIMAL`: Minimal Attribution - Analytics Only.
  - `BranchAttributionLevel.NONE`: No Attribution - No Analytics (GDPR, CCPA).

_Note: The `disableTracking` parameter is deprecated and should no longer be used. Please use `branchAttributionLevel` to control tracking behavior._

### Request Example
```dart
import 'package:flutter_branch_sdk/flutter_branch_sdk.dart';

// Ensure this is called before any other FlutterBranchSdk calls
WidgetsFlutterBinding.ensureInitialized();

// Basic initialization
await FlutterBranchSdk.init();

// Initialization with verbose logging
await FlutterBranchSdk.init(
  enableLogging: true,
  logLevel: BranchLogLevel.VERBOSE
);

// Initialization for production with error logging only
await FlutterBranchSdk.init(
  enableLogging: true,
  logLevel: BranchLogLevel.ERROR
);

// Initialization with no logging
await FlutterBranchSdk.init(
  enableLogging: false,
  logLevel: BranchLogLevel.NONE
);

// Initialization with minimal attribution
await FlutterBranchSdk.init(
  branchAttributionLevel: BranchAttributionLevel.MINIMAL
);
```
```

--------------------------------

### Staging Environment Configuration

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

Configure your Branch SDK for staging with debug logging and test instance enabled. Ensure `testKey` is used.

```json
{
  "testKey": "key_test_xxxx",
  "useTestInstance": true,
  "enableLogging": true,
  "logLevel": "DEBUG",
  "installReferrerTimeout": 5000
}
```

--------------------------------

### Initialize Title Property

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/BranchUniversalObject/title.html

Initializes the title property as an empty string. This is a common starting point for string variables.

```dart
String title = '';
```

--------------------------------

### SDK Initialization

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk-class.html

Method to initialize the Branch SDK.

```APIDOC
## POST /init

### Description
Initializes the Branch SDK.

### Method
POST

### Endpoint
/init

### Parameters
#### Request Body
- **enableLogging** (Boolean) - Optional - Enables or disables logging. Defaults to false.
- **logLevel** (BranchLogLevel) - Optional - Sets the logging level. Defaults to BranchLogLevel.VERBOSE.
- **branchAttributionLevel** (BranchAttributionLevel) - Optional - Sets the Branch attribution level.

### Response
#### Success Response (200)
void
```

--------------------------------

### Initialize errorMessage Property

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/BranchResponse/errorMessage.html

Initializes the errorMessage property as an empty string. This is a common starting point for error handling.

```dart
String errorMessage = '';
```

--------------------------------

### Initialize BranchQrCode

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/BranchQrCode/BranchQrCode.html

Use this constructor to create a BranchQrCode instance. It accepts optional parameters for customization like colors, margin, width, image format, and a center logo URL. An assertion validates the absolute URL if provided.

```dart
BranchQrCode(
    {this.primaryColor,
    this.backgroundColor,
    this.margin,
    this.width,
    this.imageFormat = BranchImageFormat.PNG,
    this.centerLogoUrl = ''}) {
  if (centerLogoUrl.isNotEmpty) {
    assert(Uri.parse(centerLogoUrl).isAbsolute, 'Invalid URL');
  }
}
```

--------------------------------

### Branch SDK Initialization

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/init.html

Initializes the Branch SDK with the specified configuration options.

```APIDOC
## init static method

### Description
Initializes the Branch SDK with the specified configuration options.
This function initializes the Branch SDK with the specified configuration options.

### Method
static Future<void>

### Endpoint
N/A (Static method)

### Parameters
#### Query Parameters
- **enableLogging** (bool) - Optional - Whether to enable detailed logging. Defaults to `false`.
- **logLevel** (BranchLogLevel) - Optional - The log level for Branch SDK logs. Defaults to `BranchLogLevel.VERBOSE`.
  - `BranchLogLevel.VERBOSE`: All logs including verbose messages (most detailed)
  - `BranchLogLevel.DEBUG`: Debug level logs for development
  - `BranchLogLevel.INFO`: Informational messages
  - `BranchLogLevel.WARNING`: Warning messages only
  - `BranchLogLevel.ERROR`: Error messages only
  - `BranchLogLevel.NONE`: No logging
- **branchAttributionLevel** (BranchAttributionLevel?) - Optional - The level of attribution data to collect.
  - `BranchAttributionLevel.FULL`: Full Attribution (Default)
  - `BranchAttributionLevel.REDUCE`: Reduced Attribution (Non-Ads + Privacy Frameworks)
  - `BranchAttributionLevel.MINIMAL`: Minimal Attribution - Analytics Only
  - `BranchAttributionLevel.NONE`: No Attribution - No Analytics (GDPR, CCPA)

### Request Example
```dart
await BranchSdk.init(
  enableLogging: true,
  logLevel: BranchLogLevel.DEBUG,
  branchAttributionLevel: BranchAttributionLevel.FULL,
);
```

### Response
#### Success Response (void)
This method does not return a value upon successful initialization.

#### Response Example
N/A
```

--------------------------------

### Initialize productName Property

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/BranchContentMetaData/productName.html

This snippet shows the basic initialization of the productName property as a String.

```dart
String productName = '';
```

--------------------------------

### Initialize Branch SDK with Verbose Logging

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

Initialize the Branch SDK for development with verbose logging enabled to capture all debug messages.

```dart
// Development: verbose logging
await FlutterBranchSdk.init(
  enableLogging: true, 
  logLevel: BranchLogLevel.VERBOSE
);
```

--------------------------------

### Partner Parameter Management

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdkPlatform-class.html

Methods for adding and clearing partner parameters for Facebook and Snap, which are attached to installs, opens, and events.

```APIDOC
## POST /partner/parameters

### Description
Adds a Partner Parameter for Facebook or Snap. This parameter is attached to installs, opens, and events until cleared or the app restarts.

### Method
POST

### Endpoint
/partner/parameters

### Parameters
#### Request Body
- **key** (String) - Required - The key for the partner parameter.
- **value** (String) - Required - The value for the partner parameter.
- **platform** (String) - Required - The platform for which to add the parameter (e.g., "facebook", "snap").

### Request Example
```json
{
  "key": "example_key",
  "value": "example_value",
  "platform": "facebook"
}
```

### Response
#### Success Response (200)
- **status** (String) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "success"
}
```

## DELETE /partner/parameters

### Description
Clears all Partner Parameters that have been set.

### Method
DELETE

### Endpoint
/partner/parameters

### Response
#### Success Response (200)
- **status** (String) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Get eventName Property Implementation

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/BranchEvent/eventName.html

This getter returns the private _eventName variable. Ensure _eventName is properly initialized before accessing.

```dart
String get eventName => _eventName;
```

--------------------------------

### Implement setInstallReferrerTimeout

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdkPlatform/setInstallReferrerTimeout.html

This snippet shows the implementation of the setInstallReferrerTimeout method. The default timeout is 0 milliseconds, meaning no timeout is applied. The timeoutMs parameter must be a non-negative integer.

```dart
void setInstallReferrerTimeout(int timeoutMs) {
  throw UnimplementedError('setInstallReferrerTimeout has not been implemented');
}
```

--------------------------------

### Get platformLogs Stream

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdkPlatform/platformLogs.html

This method is intended to return a broadcast Stream of String log messages from the host platform. It is currently unimplemented.

```dart
Stream<String> get platformLogs {
  throw UnimplementedError('platformLogs has not been implemented');
}
```

--------------------------------

### Get Tracking Authorization Status

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/getTrackingAuthorizationStatus.html

Use this method to retrieve the app tracking authorization status. On Android, this method returns AppTrackingStatus.notSupported.

```dart
static Future<AppTrackingStatus> getTrackingAuthorizationStatus() async {
  return FlutterBranchSdkPlatform.instance.getTrackingAuthorizationStatus();
}
```

--------------------------------

### FlutterBranchSdkPlatform() Constructor

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdkPlatform/FlutterBranchSdkPlatform.html

Constructs a new instance of FlutterBranchSdkPlatform.

```APIDOC
## FlutterBranchSdkPlatform()

### Description
Constructs a FlutterBranchSdkPlatform.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
```dart
FlutterBranchSdkPlatform()
```

### Response
N/A
```

--------------------------------

### Convert BranchAttributionLevel to String

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/getBranchAttributionLevelString.html

Use this function to get the string name of a BranchAttributionLevel enum value. It is useful for logging or displaying attribution levels.

```dart
String getBranchAttributionLevelString(BranchAttributionLevel branchAttributionLevel) {
  return branchAttributionLevel.toString().split('.').last;
}
```

--------------------------------

### Initialize Branch SDK with No Logging

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

Initialize the Branch SDK with logging disabled. This is suitable for production environments where detailed logs are not required.

```dart
// No logging
await FlutterBranchSdk.init(
  enableLogging: false, 
  logLevel: BranchLogLevel.NONE
);
```

--------------------------------

### Get Last Attributed Touch Data

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/getLastAttributedTouchData.html

Use this method to retrieve the last attributed touch data. You can optionally specify an attribution window in minutes.

```dart
static Future<BranchResponse> getLastAttributedTouchData({int? attributionWindow}) async {
  return FlutterBranchSdkPlatform.instance.getLastAttributedTouchData(attributionWindow: attributionWindow);
}
```

--------------------------------

### Initialize Branch SDK with Error Logging

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

Initialize the Branch SDK for production with error logging only to minimize log output while capturing critical issues.

```dart
// Production: error logging only
await FlutterBranchSdk.init(
  enableLogging: true, 
  logLevel: BranchLogLevel.ERROR
);
```

--------------------------------

### Implement getQRCodeAsImage Method

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdkPlatform/getQRCodeAsImage.html

This method creates a Branch QR Code image. It requires BranchUniversalObject, BranchLinkProperties, and BranchQrCode objects. Currently, it throws an UnimplementedError.

```dart
Future<BranchResponse> getQRCodeAsImage({
  required BranchUniversalObject buo,
  required BranchLinkProperties linkProperties,
  required BranchQrCode qrCodeSettings,
}) async {
  throw UnimplementedError('getQRCodeAsImage has not been implemented');
}
```

--------------------------------

### Implement handleDeepLink Method

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdkPlatform/handleDeepLink.html

This method is used to end the current deep link session and start a new session with the provided URL. It is an asynchronous operation.

```dart
Future<void> handleDeepLink(String url) async {
  throw UnimplementedError('handleDeepLink has not been implemented');
}
```

--------------------------------

### Initialize Branch SDK

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/init.html

Initializes the Branch SDK with configurable logging and attribution levels. Ensure this is called early in your application's lifecycle.

```dart
static Future<void> init({
  bool enableLogging = false,
  BranchLogLevel logLevel = BranchLogLevel.VERBOSE,
  BranchAttributionLevel? branchAttributionLevel,
}) async {
  await FlutterBranchSdkPlatform.instance.init(
    enableLogging: enableLogging,
    logLevel: logLevel,
    branchAttributionLevel: branchAttributionLevel,
  );
}
```

--------------------------------

### Convert BranchEventAdType to String

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/getBranchEventAdTypeString.html

Use this function to get the string name of a BranchEventAdType enum. It splits the enum's string representation and returns the last part.

```dart
String getBranchEventAdTypeString(BranchEventAdType branchEventAdType) {
  return branchEventAdType.toString().split('.').last;
}
```

--------------------------------

### SDK Initialization and Identity

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdkPlatform-class.html

Methods for initializing the Branch SDK, setting user identity, and checking if a user is identified.

```APIDOC
## POST /init

### Description
Initializes the Branch SDK. Logging and log level can be configured.

### Method
POST

### Endpoint
/init

### Parameters
#### Request Body
- **enableLogging** (Boolean) - Optional - Enables SDK logging. Defaults to false.
- **logLevel** (BranchLogLevel) - Optional - Sets the logging level. Defaults to BranchLogLevel.VERBOSE.
- **branchAttributionLevel** (BranchAttributionLevel) - Optional - Sets the consumer protection attribution level.

### Request Example
```json
{
  "enableLogging": true,
  "logLevel": "DEBUG"
}
```

### Response
#### Success Response (200)
- **status** (String) - Indicates the success of the initialization.

#### Response Example
```json
{
  "status": "initialized"
}
```

## GET /user/is_identified

### Description
Indicates whether or not a custom identity has been specified for the current user. This is independent of installs.

### Method
GET

### Endpoint
/user/is_identified

### Response
#### Success Response (200)
- **isIdentified** (Boolean) - True if a custom identity is set, false otherwise.

#### Response Example
```json
{
  "isIdentified": true
}
```

## POST /identity/set

### Description
Sets a custom identity for the current user. This identity persists across installs if the device ID is maintained.

### Method
POST

### Endpoint
/identity/set

### Parameters
#### Request Body
- **userId** (String) - Required - The unique identifier for the user.

### Request Example
```json
{
  "userId": "user_12345"
}
```

### Response
#### Success Response (200)
- **status** (String) - Indicates the success of setting the identity.

#### Response Example
```json
{
  "status": "identity_set"
}
```
```

--------------------------------

### Get Platform Logs

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/platformLogs.html

Provides a broadcast Stream of String log messages from the host platform. These logs are unified into a String format for visibility in the Flutter debug console.

```APIDOC
## GET /platformLogs

### Description
Retrieves a broadcast Stream of log messages emitted by the host platform (iOS/Android). The SDK transforms raw platform data into a unified String format for display in the Flutter debug console.

### Method
GET

### Endpoint
/platformLogs

### Parameters
This endpoint does not accept any path, query, or request body parameters.

### Response
#### Success Response (200)
- **platformLogs** (Stream<String>) - A broadcast Stream that emits log messages as Strings.

#### Response Example
```dart
// Example of how to listen to the stream
FlutterBranchSdk.platformLogs.listen((logMessage) {
  print('Platform Log: $logMessage');
});
```
```

--------------------------------

### Get First Referring Parameters - Dart

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/getFirstReferringParams.html

Call this method to retrieve the first parameters associated with the link that referred the user. Ensure the Branch SDK is initialized before calling.

```dart
static Future<Map<dynamic, dynamic>> getFirstReferringParams() async {
  return await FlutterBranchSdkPlatform.instance.getFirstReferringParams();
}
```

--------------------------------

### Initialize Branch SDK

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

Initialize the Branch SDK with optional logging enabled. Ensure WidgetsFlutterBinding.ensureInitialized() is called in your main function before this.

```dart
import 'package:flutter_branch_sdk/flutter_branch_sdk.dart';

await FlutterBranchSdk.init(enableLogging: false);
```

--------------------------------

### Static Instance

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdkPlatform-class.html

Provides access to the default instance of the Branch SDK.

```APIDOC
## Static Properties

### instance

#### Description
The default instance of FlutterBranchSdkPlatform to use.

#### Type
FlutterBranchSdkPlatform

#### Access
Getter/Setter pair
```

--------------------------------

### Get Latest Referring Parameters

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/getLatestReferringParams.html

Call this static method to retrieve the last parameters associated with the link that referred the user. Ensure the Branch SDK is initialized before calling this method.

```dart
static Future<Map<dynamic, dynamic>> getLatestReferringParams() async {
  return await FlutterBranchSdkPlatform.instance.getLatestReferringParams();
}
```

--------------------------------

### getQRCodeAsData Method

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdkPlatform/getQRCodeAsData.html

Creates a Branch QR Code image and returns it as a Uint8List.

```APIDOC
## POST /qr/v1/generate

### Description
Creates a Branch QR Code image. Returns the QR code as Uint8List.

### Method
POST

### Endpoint
/qr/v1/generate

### Parameters
#### Request Body
- **buo** (BranchUniversalObject) - Required - The Branch Universal Object to associate with the QR code.
- **linkProperties** (BranchLinkProperties) - Required - Properties for the Branch link.
- **qrCodeSettings** (BranchQrCode) - Required - Settings for the QR code generation.

### Request Example
```json
{
  "buo": { ... },
  "linkProperties": { ... },
  "qrCodeSettings": { ... }
}
```

### Response
#### Success Response (200)
- **qrCodeData** (Uint8List) - The QR code image data.

#### Response Example
```json
{
  "qrCodeData": "base64EncodedImageData"
}
```
```

--------------------------------

### FlutterBranchSdkPlatform Class Overview

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdkPlatform-class.html

Provides an overview of the FlutterBranchSdkPlatform class, its inheritance, constructor, and properties.

```APIDOC
## FlutterBranchSdkPlatform Class

### Description
An abstract class representing the platform-specific implementation of the Branch SDK for Flutter. It defines the interface that concrete platform implementations (iOS/Android) must adhere to.

### Inheritance
- Object
- PlatformInterface
- FlutterBranchSdkPlatform

### Constructors 

#### FlutterBranchSdkPlatform()

- **Description**: Constructs an instance of the FlutterBranchSdkPlatform.

### Properties 

#### hashCode → int

- **Description**: The hash code for this object. (inherited from Object)
- **Setter**: No setter

#### platformLogs → Stream<String>

- **Description**: A broadcast Stream that provides log messages emitted by the host platform (iOS/Android). It subscribes to the EventChannel and transforms raw platform data into String format for unified visibility in the Flutter debug console. This property is an override.
- **Setter**: No setter

#### runtimeType → Type

- **Description**: A representation of the runtime type of the object. (inherited from Object)
- **Setter**: No setter
```

--------------------------------

### Get Current Tracking Authorization Status on iOS

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

Retrieve the current App Tracking Transparency authorization status from the device. This can be called at any time to check the user's permission status.

```dart
AppTrackingStatus status = await FlutterBranchSdk.getTrackingAuthorizationStatus();
print(status);
```

--------------------------------

### Get Content Schema String - Dart

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/getContentSchemaString.html

Extracts the string representation of a BranchContentSchema. Returns null if the input contentSchema is null. The function splits the string representation by '.' and returns the last element.

```dart
String? getContentSchemaString(BranchContentSchema? contentSchema) {
  if (contentSchema == null) return null;
  return contentSchema.toString().split('.').last;
}
```

--------------------------------

### getQRCodeAsImage

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/getQRCodeAsImage.html

Creates a Branch QR Code image and returns it.

```APIDOC
## POST /qr_code/image

### Description
Creates a Branch QR Code image. Returns the QR code as an Image.

### Method
POST

### Endpoint
/qr_code/image

### Parameters
#### Request Body
- **buo** (BranchUniversalObject) - Required - The Branch Universal Object to associate with the QR code.
- **linkProperties** (BranchLinkProperties) - Required - Properties for the link to be generated.
- **qrCode** (BranchQrCode) - Required - Settings for the QR code generation.

### Request Example
```json
{
  "buo": { ... },
  "linkProperties": { ... },
  "qrCode": { ... }
}
```

### Response
#### Success Response (200)
- **imageData** (String) - The QR code image data.

#### Response Example
```json
{
  "imageData": "base64_encoded_image_string"
}
```
```

--------------------------------

### BranchQrCode Constructor and Properties

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/BranchQrCode-class.html

This snippet details the constructor for the BranchQrCode class and its associated properties.

```APIDOC
## BranchQrCode Constructor

### Description
Initializes a new instance of the BranchQrCode class.

### Parameters
- **primaryColor** (Color?) - Optional - The primary color for the QR code.
- **backgroundColor** (Color?) - Optional - The background color for the QR code.
- **margin** (int?) - Optional - The margin around the QR code.
- **width** (int?) - Optional - The width of the QR code.
- **imageFormat** (BranchImageFormat) - Optional - The format of the QR code image, defaults to BranchImageFormat.PNG.
- **centerLogoUrl** (String) - Optional - The URL for a logo to be placed in the center of the QR code.

## BranchQrCode Properties

### backgroundColor
- **Type**: Color?
- **Description**: Getter/setter pair for the background color.

### centerLogoUrl
- **Type**: String
- **Description**: Getter/setter pair for the center logo URL.

### hashCode
- **Type**: int
- **Description**: The hash code for this object. (inherited)

### imageFormat
- **Type**: BranchImageFormat
- **Description**: Getter/setter pair for the image format.

### margin
- **Type**: int?
- **Description**: Getter/setter pair for the margin.

### primaryColor
- **Type**: Color?
- **Description**: Getter/setter pair for the primary color.

### runtimeType
- **Type**: Type
- **Description**: A representation of the runtime type of the object. (inherited)

### width
- **Type**: int?
- **Description**: Getter/setter pair for the width.
```

--------------------------------

### addFacebookPartnerParameter static method

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/addFacebookPartnerParameter.html

Adds a partner parameter for Facebook. This parameter is attached to installs, opens, and events until cleared or the app restarts. Refer to Facebook's documentation for valid parameter details.

```APIDOC
## addFacebookPartnerParameter static method

### Description
Adds a Partner Parameter for Facebook. Once set, this parameter is attached to installs, opens and events until cleared or the app restarts. See Facebook's documentation for details on valid parameters.

### Method
static void

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **key** (String) - Required - The key for the partner parameter.
- **value** (String) - Required - The value for the partner parameter.

### Request Example
```dart
// Example usage (not a direct request body, but shows method call)
await BranchFlutterSdk.addFacebookPartnerParameter(key: 'your_key', value: 'your_value');
```

### Response
#### Success Response (200)
This method does not return a value upon success.

#### Response Example
N/A
```

--------------------------------

### iOS 14+ App Tracking Transparency (ATT)

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/index.html

Manage user tracking permissions on iOS 14.5+ using the AppTrackingTransparency framework. Includes methods to request authorization and get the current status.

```APIDOC
## iOS 14+ App Tracking Transparency

### Description
Starting with iOS 14.5, iPadOS 14.5, and tvOS 14.5, you’ll need to receive the user’s permission through the AppTrackingTransparency framework to track them or access their device’s advertising identifier. Tracking refers to the act of linking user or device data collected from your app with user or device data collected from other companies’ apps, websites, or offline properties for targeted advertising or advertising measurement purposes. Tracking also refers to sharing user or device data with data brokers.

### Configuration
Update your `Info.plist` file located in `ios/Runner` directory and add the `NSUserTrackingUsageDescription` key with a custom message describing your usage.

```xml
<key>NSUserTrackingUsageDescription</key>
<string>App would like to access IDFA for tracking purpose</string>
```

### Methods
#### Request Tracking Authorization
Shows the App Tracking Transparency dialog to the user and returns their authorization status.

**Method:** `requestTrackingAuthorization()`
**Returns:** `Future<AppTrackingStatus>`

**Request Example:**
```dart
AppTrackingStatus status = await FlutterBranchSdk.requestTrackingAuthorization();
print(status);
```

#### Get Tracking Authorization Status
Retrieves the current authorization status for tracking.

**Method:** `getTrackingAuthorizationStatus()`
**Returns:** `Future<AppTrackingStatus>`

**Request Example:**
```dart
AppTrackingStatus status = await FlutterBranchSdk.getTrackingAuthorizationStatus();
print(status);
```

### AppTrackingStatus Enum
Possible values for the tracking authorization status:

- **`notDetermined`**: The user has not yet received an authorization request dialog.
- **`restricted`**: The device is restricted, tracking is disabled and the system can't show a request dialog.
- **`denied`**: The user denies authorization for tracking.
- **`authorized`**: The user authorizes access to tracking.
- **`notSupported`**: The platform is not iOS or the iOS version is below 14.0.

### Important Note
After the user's response to the ATT prompt, call the `handleATTAuthorizationStatus` Branch SDK method to monitor the performance of the ATT prompt.
```

--------------------------------

### FlutterBranchSdk Constructor

Source: https://pub.dev/documentation/flutter_branch_sdk/latest/flutter_branch_sdk/FlutterBranchSdk/FlutterBranchSdk.html

Initializes a new instance of the FlutterBranchSdk class.

```APIDOC
## FlutterBranchSdk()

### Description
Initializes a new instance of the FlutterBranchSdk class.

### Method
Constructor

### Endpoint
N/A

### Parameters
This constructor does not take any parameters.

### Request Example
N/A

### Response
N/A
```
Tokens:
Raw