Skip to content

Commit dda3035

Browse files
committed
doc gen output
1 parent 333bb0f commit dda3035

File tree

64 files changed

+2425
-3469
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+2425
-3469
lines changed
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# ActionCodeInfo interface
13+
A response from [checkActionCode()](./auth-cordova.md#checkactioncode_d2ae15a)<!-- -->.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface ActionCodeInfo
19+
```
20+
21+
## Properties
22+
23+
| Property | Type | Description |
24+
| --- | --- | --- |
25+
| [data](./auth-cordova.actioncodeinfo.md#actioncodeinfodata) | { email?: string \| null; multiFactorInfo?: [MultiFactorInfo](./auth-cordova.multifactorinfo.md#multifactorinfo_interface) \| null; previousEmail?: string \| null; } | The data associated with the action code. |
26+
| [operation](./auth-cordova.actioncodeinfo.md#actioncodeinfooperation) | (typeof [ActionCodeOperationMap](./auth-cordova.md#actioncodeoperation)<!-- -->)\[keyof typeof [ActionCodeOperationMap](./auth-cordova.md#actioncodeoperation)<!-- -->\] | The type of operation that generated the action code. |
27+
28+
## ActionCodeInfo.data
29+
30+
The data associated with the action code.
31+
32+
For the [ActionCodeOperation](./auth-cordova.md#actioncodeoperation)<!-- -->.PASSWORD\_RESET, [ActionCodeOperation](./auth-cordova.md#actioncodeoperation)<!-- -->.VERIFY\_EMAIL, and [ActionCodeOperation](./auth-cordova.md#actioncodeoperation)<!-- -->.RECOVER\_EMAIL actions, this object contains an email field with the address the email was sent to.
33+
34+
For the [ActionCodeOperation](./auth-cordova.md#actioncodeoperation)<!-- -->.RECOVER\_EMAIL action, which allows a user to undo an email address change, this object also contains a `previousEmail` field with the user account's current email address. After the action completes, the user's email address will revert to the value in the `email` field from the value in `previousEmail` field.
35+
36+
For the [ActionCodeOperation](./auth-cordova.md#actioncodeoperation)<!-- -->.VERIFY\_AND\_CHANGE\_EMAIL action, which allows a user to verify the email before updating it, this object contains a `previousEmail` field with the user account's email address before updating. After the action completes, the user's email address will be updated to the value in the `email` field from the value in `previousEmail` field.
37+
38+
For the [ActionCodeOperation](./auth-cordova.md#actioncodeoperation)<!-- -->.REVERT\_SECOND\_FACTOR\_ADDITION action, which allows a user to unenroll a newly added second factor, this object contains a `multiFactorInfo` field with the information about the second factor. For phone second factor, the `multiFactorInfo` is a [MultiFactorInfo](./auth-cordova.multifactorinfo.md#multifactorinfo_interface) object, which contains the phone number.
39+
40+
<b>Signature:</b>
41+
42+
```typescript
43+
data: {
44+
email?: string | null;
45+
multiFactorInfo?: MultiFactorInfo | null;
46+
previousEmail?: string | null;
47+
};
48+
```
49+
50+
## ActionCodeInfo.operation
51+
52+
The type of operation that generated the action code.
53+
54+
<b>Signature:</b>
55+
56+
```typescript
57+
operation: (typeof ActionCodeOperationMap)[keyof typeof ActionCodeOperationMap];
58+
```

docs-devsite/auth.actioncodesettings.md renamed to docs-devsite/auth-cordova.actioncodesettings.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ export interface ActionCodeSettings
2222

2323
| Property | Type | Description |
2424
| --- | --- | --- |
25-
| [android](./auth.actioncodesettings.md#actioncodesettingsandroid) | { installApp?: boolean; minimumVersion?: string; packageName: string; } | Sets the Android package name. |
26-
| [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>). |
27-
| [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. |
28-
| [iOS](./auth.actioncodesettings.md#actioncodesettingsios) | { bundleId: string; } | Sets the iOS bundle ID. |
29-
| [url](./auth.actioncodesettings.md#actioncodesettingsurl) | string | Sets the link continue/state URL. |
25+
| [android](./auth-cordova.actioncodesettings.md#actioncodesettingsandroid) | { installApp?: boolean; minimumVersion?: string; packageName: string; } | Sets the Android package name. |
26+
| [dynamicLinkDomain](./auth-cordova.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>). |
27+
| [handleCodeInApp](./auth-cordova.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. |
28+
| [iOS](./auth-cordova.actioncodesettings.md#actioncodesettingsios) | { bundleId: string; } | Sets the iOS bundle ID. |
29+
| [url](./auth-cordova.actioncodesettings.md#actioncodesettingsurl) | string | Sets the link continue/state URL. |
3030

3131
## ActionCodeSettings.android
3232

docs-devsite/auth.actioncodeurl.md renamed to docs-devsite/auth-cordova.actioncodeurl.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,18 @@ export declare class ActionCodeURL
2424

2525
| Property | Modifiers | Type | Description |
2626
| --- | --- | --- | --- |
27-
| [apiKey](./auth.actioncodeurl.md#actioncodeurlapikey) | | string | The API key of the email action link. |
28-
| [code](./auth.actioncodeurl.md#actioncodeurlcode) | | string | The action code of the email action link. |
29-
| [continueUrl](./auth.actioncodeurl.md#actioncodeurlcontinueurl) | | string \| null | The continue URL of the email action link. Null if not provided. |
30-
| [languageCode](./auth.actioncodeurl.md#actioncodeurllanguagecode) | | string \| null | The language code of the email action link. Null if not provided. |
31-
| [operation](./auth.actioncodeurl.md#actioncodeurloperation) | | string | The action performed by the email action link. It returns from one of the types from [ActionCodeInfo](./auth.actioncodeinfo.md#actioncodeinfo_interface) |
32-
| [tenantId](./auth.actioncodeurl.md#actioncodeurltenantid) | | string \| null | The tenant ID of the email action link. Null if the email action is from the parent project. |
27+
| [apiKey](./auth-cordova.actioncodeurl.md#actioncodeurlapikey) | | string | The API key of the email action link. |
28+
| [code](./auth-cordova.actioncodeurl.md#actioncodeurlcode) | | string | The action code of the email action link. |
29+
| [continueUrl](./auth-cordova.actioncodeurl.md#actioncodeurlcontinueurl) | | string \| null | The continue URL of the email action link. Null if not provided. |
30+
| [languageCode](./auth-cordova.actioncodeurl.md#actioncodeurllanguagecode) | | string \| null | The language code of the email action link. Null if not provided. |
31+
| [operation](./auth-cordova.actioncodeurl.md#actioncodeurloperation) | | string | The action performed by the email action link. It returns from one of the types from [ActionCodeInfo](./auth-cordova.actioncodeinfo.md#actioncodeinfo_interface) |
32+
| [tenantId](./auth-cordova.actioncodeurl.md#actioncodeurltenantid) | | string \| null | The tenant ID of the email action link. Null if the email action is from the parent project. |
3333

3434
## Methods
3535

3636
| Method | Modifiers | Description |
3737
| --- | --- | --- |
38-
| [parseLink(link)](./auth.actioncodeurl.md#actioncodeurlparselink) | <code>static</code> | Parses the email action link string and returns an [ActionCodeURL](./auth.actioncodeurl.md#actioncodeurl_class) if the link is valid, otherwise returns null. |
38+
| [parseLink(link)](./auth-cordova.actioncodeurl.md#actioncodeurlparselink) | <code>static</code> | Parses the email action link string and returns an [ActionCodeURL](./auth-cordova.actioncodeurl.md#actioncodeurl_class) if the link is valid, otherwise returns null. |
3939

4040
## ActionCodeURL.apiKey
4141

@@ -79,7 +79,7 @@ readonly languageCode: string | null;
7979

8080
## ActionCodeURL.operation
8181

82-
The action performed by the email action link. It returns from one of the types from [ActionCodeInfo](./auth.actioncodeinfo.md#actioncodeinfo_interface)
82+
The action performed by the email action link. It returns from one of the types from [ActionCodeInfo](./auth-cordova.actioncodeinfo.md#actioncodeinfo_interface)
8383

8484
<b>Signature:</b>
8585

@@ -99,7 +99,7 @@ readonly tenantId: string | null;
9999

100100
## ActionCodeURL.parseLink()
101101

102-
Parses the email action link string and returns an [ActionCodeURL](./auth.actioncodeurl.md#actioncodeurl_class) if the link is valid, otherwise returns null.
102+
Parses the email action link string and returns an [ActionCodeURL](./auth-cordova.actioncodeurl.md#actioncodeurl_class) if the link is valid, otherwise returns null.
103103

104104
<b>Signature:</b>
105105

@@ -115,7 +115,7 @@ static parseLink(link: string): ActionCodeURL | null;
115115

116116
<b>Returns:</b>
117117

118-
[ActionCodeURL](./auth.actioncodeurl.md#actioncodeurl_class) \| null
118+
[ActionCodeURL](./auth-cordova.actioncodeurl.md#actioncodeurl_class) \| null
119119

120-
The [ActionCodeURL](./auth.actioncodeurl.md#actioncodeurl_class) object, or null if the link is invalid.
120+
The [ActionCodeURL](./auth-cordova.actioncodeurl.md#actioncodeurl_class) object, or null if the link is invalid.
121121

docs-devsite/auth.additionaluserinfo.md renamed to docs-devsite/auth-cordova.additionaluserinfo.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ export interface AdditionalUserInfo
2222

2323
| Property | Type | Description |
2424
| --- | --- | --- |
25-
| [isNewUser](./auth.additionaluserinfo.md#additionaluserinfoisnewuser) | boolean | Whether the user is new (created via sign-up) or existing (authenticated using sign-in). |
26-
| [profile](./auth.additionaluserinfo.md#additionaluserinfoprofile) | Record&lt;string, unknown&gt; \| null | Map containing IDP-specific user data. |
27-
| [providerId](./auth.additionaluserinfo.md#additionaluserinfoproviderid) | string \| null | Identifier for the provider used to authenticate this user. |
28-
| [username](./auth.additionaluserinfo.md#additionaluserinfousername) | string \| null | The username if the provider is GitHub or Twitter. |
25+
| [isNewUser](./auth-cordova.additionaluserinfo.md#additionaluserinfoisnewuser) | boolean | Whether the user is new (created via sign-up) or existing (authenticated using sign-in). |
26+
| [profile](./auth-cordova.additionaluserinfo.md#additionaluserinfoprofile) | Record&lt;string, unknown&gt; \| null | Map containing IDP-specific user data. |
27+
| [providerId](./auth-cordova.additionaluserinfo.md#additionaluserinfoproviderid) | string \| null | Identifier for the provider used to authenticate this user. |
28+
| [username](./auth-cordova.additionaluserinfo.md#additionaluserinfousername) | string \| null | The username if the provider is GitHub or Twitter. |
2929

3030
## AdditionalUserInfo.isNewUser
3131

docs-devsite/auth.applicationverifier.md renamed to docs-devsite/auth-cordova.applicationverifier.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ https://github.com/firebase/firebase-js-sdk
1212
# ApplicationVerifier interface
1313
A verifier for domain verification and abuse prevention.
1414

15-
Currently, the only implementation is [RecaptchaVerifier](./auth.recaptchaverifier.md#recaptchaverifier_class)<!-- -->.
15+
Currently, the only implementation is .
1616

1717
<b>Signature:</b>
1818

@@ -24,13 +24,13 @@ export interface ApplicationVerifier
2424

2525
| Property | Type | Description |
2626
| --- | --- | --- |
27-
| [type](./auth.applicationverifier.md#applicationverifiertype) | string | Identifies the type of application verifier (e.g. "recaptcha"). |
27+
| [type](./auth-cordova.applicationverifier.md#applicationverifiertype) | string | Identifies the type of application verifier (e.g. "recaptcha"). |
2828

2929
## Methods
3030

3131
| Method | Description |
3232
| --- | --- |
33-
| [verify()](./auth.applicationverifier.md#applicationverifierverify) | Executes the verification process. |
33+
| [verify()](./auth-cordova.applicationverifier.md#applicationverifierverify) | Executes the verification process. |
3434

3535
## ApplicationVerifier.type
3636

0 commit comments

Comments
 (0)