Constants

The following constants are available globally.

BranchVersionNumber
The Branch SDK version number as a double.
Declaration
Objective-C

extern double BranchVersionNumber
Swift

var BranchVersionNumber: Double
Show on GitHub
BranchVersionString
The Branch SDK version framework string.
Declaration
Objective-C

extern const unsigned char BranchVersionString[]
Show on GitHub

Branch Notifications


                    
                    
                    BranchWillStartSessionNotification

Declaration

Objective-C

extern NSString *const _Nonnull BranchWillStartSessionNotification

Swift

static let BranchWillStartSession: NSNotification.Name

Show on GitHub


                    
                    
                    BranchDidStartSessionNotification

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT NSString*const BranchDidStartSessionNotification

Swift

static let BranchDidStartSession: NSNotification.Name

Show on GitHub


                    
                    
                    BranchDidOpenURLWithSessionNotification

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT NSString*const BranchDidOpenURLWithSessionNotification

Swift

static let BranchDidOpenURLWithSession: NSNotification.Name

Show on GitHub


                    
                    
                    BranchURLKey

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT NSString*const BranchURLKey

Swift

let BranchURLKey: String

Show on GitHub


                    
                    
                    BranchSessionKey

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT NSString*const BranchSessionKey

Swift

let BranchSessionKey: String

Show on GitHub


                    
                    
                    BranchErrorKey

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT NSString*const BranchErrorKey

Swift

let BranchErrorKey: String

Show on GitHub

BNCErrorDomain
The Branch error domain.
Declaration
Objective-C

extern NSString *const _Nonnull BNCErrorDomain
Swift

let BNCErrorDomain: String
Show on GitHub

Commerce Events


                    
                    
                    BranchStandardEventAddToCart

Declaration

Objective-C

extern BranchStandardEvent _Nonnull BranchStandardEventAddToCart

Swift

static let addToCart: BranchStandardEvent

Show on GitHub


                    
                    
                    BranchStandardEventAddToWishlist

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventAddToWishlist

Swift

static let addToWishlist: BranchStandardEvent

Show on GitHub


                    
                    
                    BranchStandardEventViewCart

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventViewCart

Swift

static let viewCart: BranchStandardEvent

Show on GitHub


                    
                    
                    BranchStandardEventInitiatePurchase

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventInitiatePurchase

Swift

static let initiatePurchase: BranchStandardEvent

Show on GitHub


                    
                    
                    BranchStandardEventAddPaymentInfo

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventAddPaymentInfo

Swift

static let addPaymentInfo: BranchStandardEvent

Show on GitHub


                    
                    
                    BranchStandardEventPurchase

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventPurchase

Swift

static let purchase: BranchStandardEvent

Show on GitHub


                    
                    
                    BranchStandardEventSpendCredits

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventSpendCredits

Swift

static let spendCredits: BranchStandardEvent

Show on GitHub

Content Events


                    
                    
                    BranchStandardEventSearch

Declaration

Objective-C

extern BranchStandardEvent _Nonnull BranchStandardEventSearch

Swift

static let search: BranchStandardEvent

Show on GitHub


                    
                    
                    BranchStandardEventViewItem

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventViewItem

Swift

static let viewItem: BranchStandardEvent

Show on GitHub


                    
                    
                    BranchStandardEventViewItems

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventViewItems

Swift

static let viewItems: BranchStandardEvent

Show on GitHub


                    
                    
                    BranchStandardEventRate

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventRate

Swift

static let rate: BranchStandardEvent

Show on GitHub


                    
                    
                    BranchStandardEventShare

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventShare

Swift

static let share: BranchStandardEvent

Show on GitHub

User Lifecycle Events


                    
                    
                    BranchStandardEventCompleteRegistration

Declaration

Objective-C

extern BranchStandardEvent _Nonnull BranchStandardEventCompleteRegistration

Swift

static let completeRegistration: BranchStandardEvent

Show on GitHub


                    
                    
                    BranchStandardEventCompleteTutorial

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventCompleteTutorial

Swift

static let completeTutorial: BranchStandardEvent

Show on GitHub


                    
                    
                    BranchStandardEventAchieveLevel

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventAchieveLevel

Swift

static let achieveLevel: BranchStandardEvent

Show on GitHub


                    
                    
                    BranchStandardEventUnlockAchievement

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventUnlockAchievement

Swift

static let unlockAchievement: BranchStandardEvent

Show on GitHub

BranchContentSchema


                    
                    
                    BranchContentSchemaCommerceAuction

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaCommerceAuction

Swift

static let commerceAuction: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaCommerceBusiness

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaCommerceBusiness

Swift

static let commerceBusiness: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaCommerceOther

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaCommerceOther

Swift

static let commerceOther: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaCommerceProduct

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaCommerceProduct

Swift

static let commerceProduct: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaCommerceRestaurant

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaCommerceRestaurant

Swift

static let commerceRestaurant: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaCommerceService

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaCommerceService

Swift

static let commerceService: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaCommerceTravelFlight

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaCommerceTravelFlight

Swift

static let commerceTravelFlight: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaCommerceTravelHotel

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaCommerceTravelHotel

Swift

static let commerceTravelHotel: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaCommerceTravelOther

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaCommerceTravelOther

Swift

static let commerceTravelOther: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaGameState

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaGameState

Swift

static let gameState: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaMediaImage

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaMediaImage

Swift

static let mediaImage: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaMediaMixed

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaMediaMixed

Swift

static let mediaMixed: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaMediaMusic

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaMediaMusic

Swift

static let mediaMusic: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaMediaOther

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaMediaOther

Swift

static let mediaOther: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaMediaVideo

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaMediaVideo

Swift

static let mediaVideo: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaOther

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaOther

Swift

static let other: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaTextArticle

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaTextArticle

Swift

static let textArticle: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaTextBlog

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaTextBlog

Swift

static let textBlog: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaTextOther

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaTextOther

Swift

static let textOther: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaTextRecipe

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaTextRecipe

Swift

static let textRecipe: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaTextReview

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaTextReview

Swift

static let textReview: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaTextSearchResults

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaTextSearchResults

Swift

static let textSearchResults: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaTextStory

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaTextStory

Swift

static let textStory: BranchContentSchema

Show on GitHub


                    
                    
                    BranchContentSchemaTextTechnicalDoc

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchContentSchema _Nonnull BranchContentSchemaTextTechnicalDoc

Swift

static let textTechnicalDoc: BranchContentSchema

Show on GitHub

BranchCondition


                    
                    
                    BranchConditionOther

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchCondition _Nonnull BranchConditionOther

Swift

static let other: BranchCondition

Show on GitHub


                    
                    
                    BranchConditionNew

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchCondition _Nonnull BranchConditionNew

Swift

static let new: BranchCondition

Show on GitHub


                    
                    
                    BranchConditionExcellent

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchCondition _Nonnull BranchConditionExcellent

Swift

static let excellent: BranchCondition

Show on GitHub


                    
                    
                    BranchConditionGood

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchCondition _Nonnull BranchConditionGood

Swift

static let good: BranchCondition

Show on GitHub


                    
                    
                    BranchConditionFair

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchCondition _Nonnull BranchConditionFair

Swift

static let fair: BranchCondition

Show on GitHub


                    
                    
                    BranchConditionPoor

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchCondition _Nonnull BranchConditionPoor

Swift

static let poor: BranchCondition

Show on GitHub


                    
                    
                    BranchConditionUsed

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchCondition _Nonnull BranchConditionUsed

Swift

static let used: BranchCondition

Show on GitHub


                    
                    
                    BranchConditionRefurbished

Undocumented

Declaration

Objective-C

FOUNDATION_EXPORT BranchCondition _Nonnull BranchConditionRefurbished

Swift

static let refurbished: BranchCondition

Show on GitHub