Packagecom.distriqt.extension.firebase.auth
Classpublic class ActionCodeSettings
InheritanceActionCodeSettings Inheritance Object

Structure that contains the required continue/state URL with optional Android and iOS bundle identifiers. The stateUrl used to initialize this class is the link/deep link/fallback url used while constructing the Firebase dynamic link.



Public Properties
 PropertyDefined By
  androidInstallIfNotAvailable : Boolean = false
ActionCodeSettings
  androidMinimumVersion : String
ActionCodeSettings
  androidPackageName : String
ActionCodeSettings
  dynamicLinkDomain : String
ActionCodeSettings
  handleCodeInApp : Boolean
ActionCodeSettings
  iosBundleId : String
ActionCodeSettings
  url : String
ActionCodeSettings
Public Methods
 MethodDefined By
  
ActionCodeSettings
  
setAndroidPackageName(packageName:String, installIfNotAvailable:Boolean = false, minimumVersion:String = null):ActionCodeSettings
Sets the Android package name.
ActionCodeSettings
  
setDynamicLinkDomain(dynamicLinkDomain:String):ActionCodeSettings
Sets the dynamic link domain (or subdomain) to use for the current link if it is to be opened using Firebase Dynamic Links.
ActionCodeSettings
  
setHandleCodeInApp(handleCodeInApp:Boolean):ActionCodeSettings
Whether the email action link will be opened in a mobile app or a web link first.
ActionCodeSettings
  
Sets the iOS bundle ID.
ActionCodeSettings
  
Sets the link (state/continue URL) which has different meanings in different contexts: When the link is handled in the web action widgets, this is the deep link in the continueUrl query parameter. When the link is handled in the app directly, this is the continueUrl query parameter in the deep link of the Dynamic Link.
ActionCodeSettings
Property Detail
androidInstallIfNotAvailableproperty
public var androidInstallIfNotAvailable:Boolean = false

See also

androidMinimumVersionproperty 
public var androidMinimumVersion:String

See also

androidPackageNameproperty 
public var androidPackageName:String

See also

dynamicLinkDomainproperty 
public var dynamicLinkDomain:String

See also

handleCodeInAppproperty 
public var handleCodeInApp:Boolean

See also

iosBundleIdproperty 
public var iosBundleId:String

See also

urlproperty 
public var url:String

See also

Constructor Detail
ActionCodeSettings()Constructor
public function ActionCodeSettings()



Method Detail
setAndroidPackageName()method
public function setAndroidPackageName(packageName:String, installIfNotAvailable:Boolean = false, minimumVersion:String = null):ActionCodeSettings

Sets the Android package name. This will try to open the link in an android app if it is installed. If installIfNotAvailable is set to true, it specifies whether to install the Android app if the device supports it and the app is not already installed. If minimumVersion is specified, and an older version of the app is installed, the user is taken to the Play Store to upgrade the app. The Android app needs to be registered in the Console.

Parameters

packageName:String
 
installIfNotAvailable:Boolean (default = false)
 
minimumVersion:String (default = null)

Returns
ActionCodeSettingsActionCodeSettings instance for chaining calls
setDynamicLinkDomain()method 
public function setDynamicLinkDomain(dynamicLinkDomain:String):ActionCodeSettings

Sets the dynamic link domain (or subdomain) to use for the current link if it is to be opened using Firebase Dynamic Links. As multiple dynamic link domains can be configured per project, this field provides the ability to explicitly choose one. If none is provided, the first domain is used by default.

Parameters

dynamicLinkDomain:String

Returns
ActionCodeSettingsActionCodeSettings instance for chaining calls
setHandleCodeInApp()method 
public function setHandleCodeInApp(handleCodeInApp:Boolean):ActionCodeSettings

Whether the email action link will be opened in a mobile app or a web link first. The default is false. When set to true, the action code link will be be sent as a Universal Link or Android App Link and will be opened by the app if installed. In the false case, the code will be sent to the web widget first and then on continue will redirect to the app if installed.

Parameters

handleCodeInApp:Boolean

Returns
ActionCodeSettingsActionCodeSettings instance for chaining calls
setIOSBundelId()method 
public function setIOSBundelId(bundleId:String):ActionCodeSettings

Sets the iOS bundle ID. This will try to open the link in an iOS app if it is installed. The iOS app needs to be registered in the Console.

Parameters

bundleId:String

Returns
ActionCodeSettingsActionCodeSettings instance for chaining calls
setUrl()method 
public function setUrl(url:String):ActionCodeSettings

Sets the link (state/continue URL) which has different meanings in different contexts:

Parameters

url:String

Returns
ActionCodeSettingsActionCodeSettings instance for chaining calls