BranchConfiguration

@interface BranchConfiguration : NSObject <NSCopying>

Use a BranchConfiguration object to configure Branch for your app when you start Branch.

  • Undocumented

    Declaration

    Objective-C

    - (instancetype) init NS_UNAVAILABLE;
    Show on GitHub

  • Declaration

    Objective-C

    - (nonnull instancetype)initWithKey:(nonnull NSString *)key;

    Swift

    init(key: String)

    Parameters

    key

    Your Branch key.

    Return Value

    Returns an initialized BranchConfiguration object.

    Show on GitHub
  • key

    Your Branch key.

    Declaration

    Objective-C

    @property (readwrite, strong, atomic) NSString *_Nonnull key;

    Swift

    var key: String { get set }
    Show on GitHub

  • Use certificate pinning for extra security. The default is to use certificate pinning.

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) BOOL useCertificatePinning;

    Swift

    var useCertificatePinning: Bool { get set }
    Show on GitHub

  • The URL to the Branch API servers.

    Declaration

    Objective-C

    @property (readwrite, copy, atomic) NSString *_Nonnull branchAPIServiceURL;

    Swift

    var branchAPIServiceURL: String { get set }
    Show on GitHub

  • This is Class for the network service. If you want to use your own underlying network service, set the Class of the service here before you start Branch. The class most conform to the BranchNetworkServiceProtocol defined here:

    See

    Branch/BranchNetworkServiceProtocol.h

    You probably don’t need to do this.

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) Class _Nonnull networkServiceClass;

    Swift

    var networkServiceClass: AnyClass { get set }
    Show on GitHub

  • Sets an array of regex patterns that match URLs for Branch to ignore.

    Set this property to prevent URLs containing sensitive data such as oauth tokens, passwords, login credentials, and other URLs from being transmitted to Branch.

    The Branch SDK already ignores login URLs for Facebook, Twitter, Google, and many oauth security URLs, so it’s usually unnecessary to set this parameter yourself.

    Set this parameter with any additional URLs that should be ignored by Branch.

    These are ICU standard regular expressions.

    Declaration

    Objective-C

    @property (readwrite, strong, atomic)
    NSArray<NSString *> *_Nonnull blackListURLRegex;

    Swift

    var blackListURLRegex: [String] { get set }
    Show on GitHub