Skip to content

Commit

Permalink
Add documentation for ActionCodeURL (#3933)
Browse files Browse the repository at this point in the history
  • Loading branch information
avolkovi authored Oct 13, 2020
1 parent d4966cf commit 8c0f1e2
Show file tree
Hide file tree
Showing 49 changed files with 171 additions and 101 deletions.
1 change: 1 addition & 0 deletions common/api-review/auth-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import { UserCredential } from '@firebase/auth-types-exp';

// @public (undocumented)
export class ActionCodeURL implements externs.ActionCodeURL {
// @internal
constructor(actionLink: string);
// (undocumented)
readonly apiKey: string;
Expand Down
9 changes: 1 addition & 8 deletions common/api-review/auth-types-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,19 +45,12 @@ export interface ActionCodeSettings {

// @public
export abstract class ActionCodeURL {
// (undocumented)
readonly apiKey: string;
// (undocumented)
readonly code: string;
// (undocumented)
readonly continueUrl: string | null;
// (undocumented)
readonly languageCode: string | null;
// (undocumented)
readonly operation: Operation;
// (undocumented)
static parseLink(link: string): ActionCodeURL | null;
// (undocumented)
readonly tenantId: string | null;
}

Expand Down Expand Up @@ -116,7 +109,7 @@ export interface Auth {
// (undocumented)
useDeviceLanguage(): void;
// (undocumented)
useEmulator(hostname: string, port: number): void;
useEmulator(url: string): void;
}

// @public
Expand Down
2 changes: 2 additions & 0 deletions docs-exp/auth-types.actioncodeurl.apikey.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## ActionCodeURL.apiKey property

The API key of the email action link.

<b>Signature:</b>

```typescript
Expand Down
2 changes: 2 additions & 0 deletions docs-exp/auth-types.actioncodeurl.code.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## ActionCodeURL.code property

The action code of the email action link.

<b>Signature:</b>

```typescript
Expand Down
2 changes: 2 additions & 0 deletions docs-exp/auth-types.actioncodeurl.continueurl.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## ActionCodeURL.continueUrl property

The continue URL of the email action link. Null if not provided.

<b>Signature:</b>

```typescript
Expand Down
2 changes: 2 additions & 0 deletions docs-exp/auth-types.actioncodeurl.languagecode.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## ActionCodeURL.languageCode property

The language code of the email action link. Null if not provided.

<b>Signature:</b>

```typescript
Expand Down
16 changes: 8 additions & 8 deletions docs-exp/auth-types.actioncodeurl.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## ActionCodeURL class

https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeURL
A utility class to parse email action URLs such as password reset, email verification, email link sign in, etc.

<b>Signature:</b>

Expand All @@ -16,16 +16,16 @@ export abstract class ActionCodeURL

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [apiKey](./auth-types.actioncodeurl.apikey.md) | | string | |
| [code](./auth-types.actioncodeurl.code.md) | | string | |
| [continueUrl](./auth-types.actioncodeurl.continueurl.md) | | string \| null | |
| [languageCode](./auth-types.actioncodeurl.languagecode.md) | | string \| null | |
| [operation](./auth-types.actioncodeurl.operation.md) | | [Operation](./auth-types.operation.md) | |
| [tenantId](./auth-types.actioncodeurl.tenantid.md) | | string \| null | |
| [apiKey](./auth-types.actioncodeurl.apikey.md) | | string | The API key of the email action link. |
| [code](./auth-types.actioncodeurl.code.md) | | string | The action code of the email action link. |
| [continueUrl](./auth-types.actioncodeurl.continueurl.md) | | string \| null | The continue URL of the email action link. Null if not provided. |
| [languageCode](./auth-types.actioncodeurl.languagecode.md) | | string \| null | The language code of the email action link. Null if not provided. |
| [operation](./auth-types.actioncodeurl.operation.md) | | [Operation](./auth-types.operation.md) | The action performed by the email action link. It returns from one of the types from [ActionCodeInfo](./auth-types.actioncodeinfo.md) |
| [tenantId](./auth-types.actioncodeurl.tenantid.md) | | string \| null | The tenant ID of the email action link. Null if the email action is from the parent project. |

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [parseLink(link)](./auth-types.actioncodeurl.parselink.md) | <code>static</code> | |
| [parseLink(link)](./auth-types.actioncodeurl.parselink.md) | <code>static</code> | Parses the email action link string and returns an ActionCodeURL object if the link is valid, otherwise returns null. |

2 changes: 2 additions & 0 deletions docs-exp/auth-types.actioncodeurl.operation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## ActionCodeURL.operation property

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

<b>Signature:</b>

```typescript
Expand Down
6 changes: 5 additions & 1 deletion docs-exp/auth-types.actioncodeurl.parselink.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## ActionCodeURL.parseLink() method

Parses the email action link string and returns an ActionCodeURL object if the link is valid, otherwise returns null.

<b>Signature:</b>

```typescript
Expand All @@ -14,9 +16,11 @@ static parseLink(link: string): ActionCodeURL | null;

| Parameter | Type | Description |
| --- | --- | --- |
| link | string | |
| link | string | The email action link string. |

<b>Returns:</b>

[ActionCodeURL](./auth-types.actioncodeurl.md) \| null

The ActionCodeURL object, or null if the link is invalid.

2 changes: 2 additions & 0 deletions docs-exp/auth-types.actioncodeurl.tenantid.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## ActionCodeURL.tenantId property

The tenant ID of the email action link. Null if the email action is from the parent project.

<b>Signature:</b>

```typescript
Expand Down
2 changes: 1 addition & 1 deletion docs-exp/auth-types.auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,5 @@ export interface Auth
| [signOut()](./auth-types.auth.signout.md) | |
| [updateCurrentUser(user)](./auth-types.auth.updatecurrentuser.md) | |
| [useDeviceLanguage()](./auth-types.auth.usedevicelanguage.md) | |
| [useEmulator(hostname, port)](./auth-types.auth.useemulator.md) | |
| [useEmulator(url)](./auth-types.auth.useemulator.md) | |

5 changes: 2 additions & 3 deletions docs-exp/auth-types.auth.useemulator.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,14 @@
<b>Signature:</b>

```typescript
useEmulator(hostname: string, port: number): void;
useEmulator(url: string): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| hostname | string | |
| port | number | |
| url | string | |

<b>Returns:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs-exp/auth-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

| Class | Description |
| --- | --- |
| [ActionCodeURL](./auth-types.actioncodeurl.md) | https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeURL |
| [ActionCodeURL](./auth-types.actioncodeurl.md) | A utility class to parse email action URLs such as password reset, email verification, email link sign in, etc. |
| [AuthCredential](./auth-types.authcredential.md) | https://firebase.google.com/docs/reference/js/firebase.auth.AuthCredential |
| [EmailAuthProvider](./auth-types.emailauthprovider.md) | A provider for generating email &amp; password and email link credentials<!-- -->https://firebase.google.com/docs/reference/js/firebase.auth.EmailAuthProvider |
| [MultiFactorResolver](./auth-types.multifactorresolver.md) | https://firebase.google.com/docs/reference/js/firebase.auth.multifactorresolver |
Expand Down
20 changes: 0 additions & 20 deletions docs-exp/auth.actioncodeurl._constructor_.md

This file was deleted.

2 changes: 2 additions & 0 deletions docs-exp/auth.actioncodeurl.apikey.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## ActionCodeURL.apiKey property

The API key of the email action link.

<b>Signature:</b>

```typescript
Expand Down
2 changes: 2 additions & 0 deletions docs-exp/auth.actioncodeurl.code.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## ActionCodeURL.code property

The action code of the email action link.

<b>Signature:</b>

```typescript
Expand Down
2 changes: 2 additions & 0 deletions docs-exp/auth.actioncodeurl.continueurl.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## ActionCodeURL.continueUrl property

The continue URL of the email action link. Null if not provided.

<b>Signature:</b>

```typescript
Expand Down
2 changes: 2 additions & 0 deletions docs-exp/auth.actioncodeurl.languagecode.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## ActionCodeURL.languageCode property

The language code of the email action link. Null if not provided.

<b>Signature:</b>

```typescript
Expand Down
22 changes: 9 additions & 13 deletions docs-exp/auth.actioncodeurl.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,29 @@

## ActionCodeURL class

A utility class to parse email action URLs such as password reset, email verification, email link sign in, etc.

<b>Signature:</b>

```typescript
export declare class ActionCodeURL implements externs.ActionCodeURL
```
<b>Implements:</b> externs.[ActionCodeURL](./auth-types.actioncodeurl.md)
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(actionLink)](./auth.actioncodeurl._constructor_.md) | | Constructs a new instance of the <code>ActionCodeURL</code> class |
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [apiKey](./auth.actioncodeurl.apikey.md) | | string | |
| [code](./auth.actioncodeurl.code.md) | | string | |
| [continueUrl](./auth.actioncodeurl.continueurl.md) | | string \| null | |
| [languageCode](./auth.actioncodeurl.languagecode.md) | | string \| null | |
| [operation](./auth.actioncodeurl.operation.md) | | externs.[Operation](./auth-types.operation.md) | |
| [tenantId](./auth.actioncodeurl.tenantid.md) | | string \| null | |
| [apiKey](./auth.actioncodeurl.apikey.md) | | string | The API key of the email action link. |
| [code](./auth.actioncodeurl.code.md) | | string | The action code of the email action link. |
| [continueUrl](./auth.actioncodeurl.continueurl.md) | | string \| null | The continue URL of the email action link. Null if not provided. |
| [languageCode](./auth.actioncodeurl.languagecode.md) | | string \| null | The language code of the email action link. Null if not provided. |
| [operation](./auth.actioncodeurl.operation.md) | | externs.[Operation](./auth-types.operation.md) | The action performed by the email action link. It returns from one of the types from |
| [tenantId](./auth.actioncodeurl.tenantid.md) | | string \| null | The tenant ID of the email action link. Null if the email action is from the parent project. |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [parseLink(link)](./auth.actioncodeurl.parselink.md) | <code>static</code> | |
| [parseLink(link)](./auth.actioncodeurl.parselink.md) | <code>static</code> | Parses the email action link string and returns an ActionCodeURL object if the link is valid, otherwise returns null. |
2 changes: 2 additions & 0 deletions docs-exp/auth.actioncodeurl.operation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## ActionCodeURL.operation property

The action performed by the email action link. It returns from one of the types from

<b>Signature:</b>

```typescript
Expand Down
6 changes: 5 additions & 1 deletion docs-exp/auth.actioncodeurl.parselink.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## ActionCodeURL.parseLink() method

Parses the email action link string and returns an ActionCodeURL object if the link is valid, otherwise returns null.

<b>Signature:</b>

```typescript
Expand All @@ -14,9 +16,11 @@ static parseLink(link: string): externs.ActionCodeURL | null;

| Parameter | Type | Description |
| --- | --- | --- |
| link | string | |
| link | string | The email action link string. |

<b>Returns:</b>

externs.[ActionCodeURL](./auth-types.actioncodeurl.md) \| null

The ActionCodeURL object, or null if the link is invalid.

2 changes: 2 additions & 0 deletions docs-exp/auth.actioncodeurl.tenantid.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## ActionCodeURL.tenantId property

The tenant ID of the email action link. Null if the email action is from the parent project.

<b>Signature:</b>

```typescript
Expand Down
4 changes: 2 additions & 2 deletions docs-exp/auth.authcredential._getidtokenresponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@
<b>Signature:</b>

```typescript
_getIdTokenResponse(_auth: AuthCore): Promise<PhoneOrOauthTokenResponse>;
_getIdTokenResponse(_auth: Auth): Promise<PhoneOrOauthTokenResponse>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| \_auth | AuthCore | |
| \_auth | Auth | |

<b>Returns:</b>

Expand Down
4 changes: 2 additions & 2 deletions docs-exp/auth.authcredential._getreauthenticationresolver.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@
<b>Signature:</b>

```typescript
_getReauthenticationResolver(_auth: AuthCore): Promise<IdTokenResponse>;
_getReauthenticationResolver(_auth: Auth): Promise<IdTokenResponse>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| \_auth | AuthCore | |
| \_auth | Auth | |

<b>Returns:</b>

Expand Down
4 changes: 2 additions & 2 deletions docs-exp/auth.authcredential._linktoidtoken.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@
<b>Signature:</b>

```typescript
_linkToIdToken(_auth: AuthCore, _idToken: string): Promise<IdTokenResponse>;
_linkToIdToken(_auth: Auth, _idToken: string): Promise<IdTokenResponse>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| \_auth | AuthCore | |
| \_auth | Auth | |
| \_idToken | string | |

<b>Returns:</b>
Expand Down
4 changes: 2 additions & 2 deletions docs-exp/auth.emailauthcredential._getidtokenresponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@
<b>Signature:</b>

```typescript
_getIdTokenResponse(auth: AuthCore): Promise<IdTokenResponse>;
_getIdTokenResponse(auth: Auth): Promise<IdTokenResponse>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| auth | AuthCore | |
| auth | Auth | |

<b>Returns:</b>

Expand Down
Loading

0 comments on commit 8c0f1e2

Please sign in to comment.