com.google.firebase.auth.ActionCodeSettings Maven / Gradle / Ivy
Show all versions of firebase-admin Show documentation
/*
* Copyright 2018 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.firebase.auth;
import static com.google.common.base.Preconditions.checkArgument;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableMap;
import com.google.firebase.internal.NonNull;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Map;
/**
* Defines the required continue/state URL with optional Android and iOS settings. Used when
* invoking the email action link generation APIs in {@link FirebaseAuth}.
*/
public final class ActionCodeSettings {
private final Map properties;
private ActionCodeSettings(Builder builder) {
checkArgument(!Strings.isNullOrEmpty(builder.url), "URL must not be null or empty");
try {
new URL(builder.url);
} catch (MalformedURLException e) {
throw new IllegalArgumentException("Malformed URL string", e);
}
if (builder.androidInstallApp || !Strings.isNullOrEmpty(builder.androidMinimumVersion)) {
checkArgument(!Strings.isNullOrEmpty(builder.androidPackageName),
"Android package name is required when specifying other Android settings");
}
ImmutableMap.Builder properties = ImmutableMap.builder()
.put("continueUrl", builder.url)
.put("canHandleCodeInApp", builder.handleCodeInApp);
if (!Strings.isNullOrEmpty(builder.dynamicLinkDomain)) {
properties.put("dynamicLinkDomain", builder.dynamicLinkDomain);
}
if (!Strings.isNullOrEmpty(builder.iosBundleId)) {
properties.put("iOSBundleId", builder.iosBundleId);
}
if (!Strings.isNullOrEmpty(builder.androidPackageName)) {
properties.put("androidPackageName", builder.androidPackageName);
if (!Strings.isNullOrEmpty(builder.androidMinimumVersion)) {
properties.put("androidMinimumVersion", builder.androidMinimumVersion);
}
if (builder.androidInstallApp) {
properties.put("androidInstallApp", builder.androidInstallApp);
}
}
this.properties = properties.build();
}
Map getProperties() {
return this.properties;
}
/**
* Creates a new {@link ActionCodeSettings.Builder}.
*
* @return A {@link ActionCodeSettings.Builder} instance.
*/
public static Builder builder() {
return new Builder();
}
public static final class Builder {
private String url;
private boolean handleCodeInApp;
private String dynamicLinkDomain;
private String iosBundleId;
private String androidPackageName;
private String androidMinimumVersion;
private boolean androidInstallApp;
private Builder() { }
/**
* Sets the link continue/state URL.
*
* This parameter has different meanings in different contexts:
*
*
* - When the link is handled in the web action widgets, this is the deep link in the
* {@code continueUrl} query parameter.
* - When the link is handled in the app directly, this is the {@code continueUrl} query
* parameter in the deep link of the Dynamic Link.
*
*
* This parameter must be specified when creating a new {@link ActionCodeSettings} instance.
*
* @param url Continue/state URL string.
* @return This builder.
*/
public Builder setUrl(@NonNull String url) {
this.url = url;
return this;
}
/**
* Specifies whether to open the link via a mobile app or a browser. The default is false.
* When set to true, the action code link is sent as a Universal Link or an Android App Link
* and is opened by the app if installed. In the false case, the code is sent to the web widget
* first and then redirects to the app if installed.
*
* @param handleCodeInApp true to open the link in the app, and false otherwise.
* @return This builder.
*/
public Builder setHandleCodeInApp(boolean handleCodeInApp) {
this.handleCodeInApp = handleCodeInApp;
return this;
}
/**
* Sets the dynamic link domain 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
* setting provides the ability to explicitly choose one. If none is provided, the oldest
* domain is used by default.
*
* @param dynamicLinkDomain Firebase Dynamic Link domain string.
* @return This builder.
*/
public Builder setDynamicLinkDomain(String dynamicLinkDomain) {
this.dynamicLinkDomain = dynamicLinkDomain;
return this;
}
/**
* Sets the bundle ID of the iOS app where the link should be handled if the
* application is already installed on the device.
*
* @param iosBundleId The iOS bundle ID string.
*/
public Builder setIosBundleId(String iosBundleId) {
this.iosBundleId = iosBundleId;
return this;
}
/**
* Sets the Android package name of the app where the link should be handled if the
* Android app is installed. Must be specified when setting other Android-specific settings.
*
* @param androidPackageName Package name string. Must be specified, and must not be null
* or empty.
* @return This builder.
*/
public Builder setAndroidPackageName(String androidPackageName) {
this.androidPackageName = androidPackageName;
return this;
}
/**
* Sets the minimum version for Android app. If the installed app is an older version, the user
* is taken to the Play Store to upgrade the app.
*
* @param androidMinimumVersion Minimum version string.
* @return This builder.
*/
public Builder setAndroidMinimumVersion(String androidMinimumVersion) {
this.androidMinimumVersion = androidMinimumVersion;
return this;
}
/**
* Specifies whether to install the Android app if the device supports it and the app is not
* already installed.
*
* @param androidInstallApp true to install the app, and false otherwise.
* @return This builder.
*/
public Builder setAndroidInstallApp(boolean androidInstallApp) {
this.androidInstallApp = androidInstallApp;
return this;
}
/**
* Builds a new {@link ActionCodeSettings}.
*
* @return A non-null {@link ActionCodeSettings}.
*/
public ActionCodeSettings build() {
return new ActionCodeSettings(this);
}
}
}