FirebaseDynamicLinks Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
FIRDynamicLinkIOSParameters
@interface FIRDynamicLinkIOSParameters : NSObject
The Dynamic Link iOS parameters.
-
The bundle ID of the iOS app to use to open the link.
Declaration
Objective-C
@property (nonatomic, copy, readonly, nullable) NSString *bundleID;
-
The appStore ID of the iOS app in AppStore.
Declaration
Objective-C
@property (nonatomic, copy, nullable) NSString *appStoreID;
-
The link to open when the app isn’t installed. Specify this to do something other than
install the app from the App Store when the app isn’t installed, such as open the mobile
web version of the content, or display a promotional page for the app.
Declaration
Objective-C
@property (nonatomic, nullable) NSURL *fallbackURL;
-
The target app’s custom URL scheme, if defined to be something other than the app’s
bundle ID
Declaration
Objective-C
@property (nonatomic, copy, nullable) NSString *customScheme;
-
The bundle ID of the iOS app to use on iPads to open the link. This is only required if
there are separate iPhone and iPad applications.
Declaration
Objective-C
@property (nonatomic, copy, nullable) NSString *iPadBundleID;
-
The link to open on iPads when the app isn’t installed. Specify this to do something
other than install the app from the App Store when the app isn’t installed, such as open the
web version of the content, or display a promotional page for the app.
Declaration
Objective-C
@property (nonatomic, nullable) NSURL *iPadFallbackURL;
-
The minimum version of your app that can open the link. If the
- installed app is an older version, the user is taken to the AppStore to upgrade the app.
Note
It is app’s developer responsibility to open AppStore when received link declares
- higher minimumAppVersion than currently installed.
Declaration
Objective-C
@property (nonatomic, copy, nullable) NSString *minimumAppVersion;
-
A method for creating the iOS parameters object.
Declaration
Objective-C
+ (nonnull instancetype)parametersWithBundleID:(nonnull NSString *)bundleID;
Parameters
bundleID
|
The bundle ID of the iOS app to use to open the link.
|
Return Value
Returns an object to be used with FIRDynamicLinkURLComponents to add iOS parameters to a
generated Dynamic Link URL.
-
A method for creating the iOS parameters object.
Declaration
Objective-C
- (nonnull instancetype)initWithBundleID:(nonnull NSString *)bundleID;
Parameters
bundleID
|
The bundle ID of the iOS app to use to open the link.
|
Return Value
Returns an object to be used with FIRDynamicLinkURLComponents to add iOS parameters to a
generated Dynamic Link URL.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-10-10 UTC.
[null,null,["Last updated 2022-10-10 UTC."],[],[],null,["FIRDynamicLinkIOSParameters \n\n\n @interface FIRDynamicLinkIOSParameters : NSObject\n\nThe Dynamic Link iOS parameters.\n- `\n ``\n ``\n `\n\n [bundleID](#/c:objc(cs)FIRDynamicLinkIOSParameters(py)bundleID)`\n ` \n The bundle ID of the iOS app to use to open the link. \n\n Declaration \n Objective-C \n\n @property (nonatomic, copy, readonly, nullable) NSString *bundleID;\n\n- `\n ``\n ``\n `\n\n [appStoreID](#/c:objc(cs)FIRDynamicLinkIOSParameters(py)appStoreID)`\n ` \n The appStore ID of the iOS app in AppStore. \n\n Declaration \n Objective-C \n\n @property (nonatomic, copy, nullable) NSString *appStoreID;\n\n- `\n ``\n ``\n `\n\n [fallbackURL](#/c:objc(cs)FIRDynamicLinkIOSParameters(py)fallbackURL)`\n ` \n The link to open when the app isn't installed. Specify this to do something other than\n install the app from the App Store when the app isn't installed, such as open the mobile\n web version of the content, or display a promotional page for the app. \n\n Declaration \n Objective-C \n\n @property (nonatomic, nullable) NSURL *fallbackURL;\n\n- `\n ``\n ``\n `\n\n [customScheme](#/c:objc(cs)FIRDynamicLinkIOSParameters(py)customScheme)`\n ` \n The target app's custom URL scheme, if defined to be something other than the app's\n bundle ID \n\n Declaration \n Objective-C \n\n @property (nonatomic, copy, nullable) NSString *customScheme;\n\n- `\n ``\n ``\n `\n\n [iPadBundleID](#/c:objc(cs)FIRDynamicLinkIOSParameters(py)iPadBundleID)`\n ` \n The bundle ID of the iOS app to use on iPads to open the link. This is only required if\n there are separate iPhone and iPad applications. \n\n Declaration \n Objective-C \n\n @property (nonatomic, copy, nullable) NSString *iPadBundleID;\n\n- `\n ``\n ``\n `\n\n [iPadFallbackURL](#/c:objc(cs)FIRDynamicLinkIOSParameters(py)iPadFallbackURL)`\n ` \n The link to open on iPads when the app isn't installed. Specify this to do something\n other than install the app from the App Store when the app isn't installed, such as open the\n web version of the content, or display a promotional page for the app. \n\n Declaration \n Objective-C \n\n @property (nonatomic, nullable) NSURL *iPadFallbackURL;\n\n- `\n ``\n ``\n `\n\n [minimumAppVersion](#/c:objc(cs)FIRDynamicLinkIOSParameters(py)minimumAppVersion)`\n ` \n The minimum version of your app that can open the link. If the\n - installed app is an older version, the user is taken to the AppStore to upgrade the app.\n\n Note\n It is app's developer responsibility to open AppStore when received link declares\n - higher minimumAppVersion than currently installed. \n\n Declaration \n Objective-C \n\n @property (nonatomic, copy, nullable) NSString *minimumAppVersion;\n\n- `\n ``\n ``\n `\n\n [+parametersWithBundleID:](#/c:objc(cs)FIRDynamicLinkIOSParameters(cm)parametersWithBundleID:)`\n ` \n A method for creating the iOS parameters object. \n\n Declaration \n Objective-C \n\n + (nonnull instancetype)parametersWithBundleID:(nonnull NSString *)bundleID;\n\n Parameters\n\n Return Value\n\n Returns an object to be used with FIRDynamicLinkURLComponents to add iOS parameters to a\n generated Dynamic Link URL.\n- `\n ``\n ``\n `\n\n [-initWithBundleID:](#/c:objc(cs)FIRDynamicLinkIOSParameters(im)initWithBundleID:)`\n ` \n A method for creating the iOS parameters object. \n\n Declaration \n Objective-C \n\n - (nonnull instancetype)initWithBundleID:(nonnull NSString *)bundleID;\n\n Parameters\n\n Return Value\n\n Returns an object to be used with FIRDynamicLinkURLComponents to add iOS parameters to a\n generated Dynamic Link URL."]]
