Skip to content

Commit bdd5a44

Browse files
committed
Update error message for ERROR_INVALID_HOSTING_LINK_DOMAIN to include that default hosting domains cannot be used.
1 parent 9db4137 commit bdd5a44

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

docs-devsite/auth.actioncodesettings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export interface ActionCodeSettings
2626
| [dynamicLinkDomain](./auth.actioncodesettings.md#actioncodesettingsdynamiclinkdomain) | string | When multiple custom dynamic link domains are defined for a project, specify which one to use when the link is to be opened via a specified mobile app (for example, <code>example.page.link</code>). |
2727
| [handleCodeInApp](./auth.actioncodesettings.md#actioncodesettingshandlecodeinapp) | boolean | 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. |
2828
| [iOS](./auth.actioncodesettings.md#actioncodesettingsios) | { bundleId: string; } | Sets the iOS bundle ID. |
29-
| [linkDomain](./auth.actioncodesettings.md#actioncodesettingslinkdomain) | string | The optional custom Firebase Hosting domain to use when the link is to be opened via a specified mobile app. The domain must be configured in Firebase Hosting and owned by the project. This is a replacement of the Dynamic Link. |
29+
| [linkDomain](./auth.actioncodesettings.md#actioncodesettingslinkdomain) | string | The optional custom Firebase Hosting domain to use when the link is to be opened via a specified mobile app. The domain must be configured in Firebase Hosting and owned by the project. This cannot be a default hosting domain (web.app or firebaseapp.com). |
3030
| [url](./auth.actioncodesettings.md#actioncodesettingsurl) | string | Sets the link continue/state URL. |
3131

3232
## ActionCodeSettings.android
@@ -85,7 +85,7 @@ iOS?: {
8585

8686
## ActionCodeSettings.linkDomain
8787

88-
The optional custom Firebase Hosting domain to use when the link is to be opened via a specified mobile app. The domain must be configured in Firebase Hosting and owned by the project. This is a replacement of the Dynamic Link.
88+
The optional custom Firebase Hosting domain to use when the link is to be opened via a specified mobile app. The domain must be configured in Firebase Hosting and owned by the project. This cannot be a default hosting domain (web.app or firebaseapp.com).
8989

9090
<b>Signature:</b>
9191

packages/auth/src/core/errors.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -390,7 +390,8 @@ function _debugErrorMap(): ErrorMap<AuthErrorCode> {
390390
[AuthErrorCode.PASSWORD_DOES_NOT_MEET_REQUIREMENTS]:
391391
'The password does not meet the requirements.',
392392
[AuthErrorCode.INVALID_HOSTING_LINK_DOMAIN]:
393-
'The provided hosting link domain is not configured in Firebase Hosting or is not owned by the current project.'
393+
'The provided hosting link domain is not configured in Firebase Hosting or is not owned by ' +
394+
'the current project. This cannot be a default hosting domain (web.app or firebaseapp.com).'
394395
};
395396
}
396397

packages/auth/src/model/public_types.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -518,8 +518,7 @@ export interface ActionCodeSettings {
518518
/**
519519
* The optional custom Firebase Hosting domain to use when the link is to be opened via
520520
* a specified mobile app. The domain must be configured in Firebase Hosting and owned
521-
* by the project.
522-
* This is a replacement of the Dynamic Link.
521+
* by the project. This cannot be a default hosting domain (web.app or firebaseapp.com).
523522
* @defaultValue The default hosting domain will be used (for example, `example.firebaseapp.com`)
524523
*/
525524
linkDomain?: string;

0 commit comments

Comments
 (0)