Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
715 changes: 706 additions & 9 deletions main/docs.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
---
title: "AcceptInvitation"
---

Defined in: [src/screens/accept-invitation/index.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L16)

Class implementing the accept-invitation screen functionality.
This screen is displayed when a user needs to accept an invitation to an organization.


<RequestExample>
```ts Example
import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation';

const acceptInvitation = new AcceptInvitation();
await acceptInvitation.acceptInvitation();
```
</RequestExample>

- Extends `BaseContext`

- Implements [`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers)

## Constructors

<ParamField body="AcceptInvitation" type="Constructor">
{/*> **new AcceptInvitation**(): `AcceptInvitation`*/}

Defined in: [src/screens/accept-invitation/index.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L23)

Creates an instance of AcceptInvitation screen manager.

- Returns `AcceptInvitation`

- Overrides `BaseContext.constructor`

</ParamField>
## Properties

<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}>
{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/}

Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23)

- Implementation of [`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers#branding)

- Inherited from `BaseContext.branding`

</ParamField>

<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}>
{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/}

Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28)

- Implementation of [`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers#client)

- Inherited from `BaseContext.client`

</ParamField>

<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}>
{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/}

Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27)

- Implementation of [`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers#organization)

- Inherited from `BaseContext.organization`

</ParamField>

<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}>
{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/}

Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26)

- Implementation of [`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers#prompt)

- Inherited from `BaseContext.prompt`

</ParamField>

<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation">ScreenMembersOnAcceptInvitation</a></span>}>
{/*> **screen**: [`ScreenMembersOnAcceptInvitation`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation)*/}

Defined in: [src/screens/accept-invitation/index.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L18)

- Implementation of [`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers#screen)

- Overrides `BaseContext.screen`

</ParamField>

<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}>
{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/}

Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25)

- Implementation of [`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers#tenant)

- Inherited from `BaseContext.tenant`

</ParamField>

<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}>
{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/}

Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29)

- Implementation of [`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers#transaction)

- Inherited from `BaseContext.transaction`

</ParamField>

<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}>
{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/}

Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31)

- Implementation of [`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers#untrusteddata)

- Inherited from `BaseContext.untrustedData`

</ParamField>

<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}>
{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/}

Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30)

- Implementation of [`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers#user)

- Inherited from `BaseContext.user`

</ParamField>

<ParamField body='screenIdentifier' type='string'>
{/*> `static` **screenIdentifier**: `string` = `ScreenIds.ACCEPT_INVITATION`*/}

Defined in: [src/screens/accept-invitation/index.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L17)

- Overrides `BaseContext.screenIdentifier`

</ParamField>
## Methods

<ParamField body='acceptInvitation' type='Promise<void>'>
{/*> **acceptInvitation**(`payload?`): `Promise`\<`void`\>*/}

Defined in: [src/screens/accept-invitation/index.ts:40](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L40)

Accepts the invitation to the organization.

<Expandable title="Parameters">
<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}>
[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions)

Optional custom options to include with the request.
</ParamField>
</Expandable>

- Returns `Promise`\<`void`\>

```typescript Example
import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation';

const acceptInvitation = new AcceptInvitation();
await acceptInvitation.acceptInvitation();
```

- Implementation of [`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`acceptInvitation`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers#acceptinvitation)

</ParamField>

<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}>
{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/}

Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99)

Retrieves the array of transaction errors from the context, or an empty array if none exist.

- Returns [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]

An array of error objects from the transaction context.

- Inherited from `BaseContext.getErrors`
</ParamField>
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: "AculError"
---

Defined in: [src/utils/errors.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L10)

AculError

## Throws

Throws an error if the message is empty.

- Extends `Error`

## Extended by

- [`UserInputError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/UserInputError)
- [`SDKUsageError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SDKUsageError)
- [`Auth0ServerError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Auth0ServerError)

## Constructors

<ParamField body="AculError" type="Constructor">
{/*> **new AculError**(`message`, `field?`): `AculError`*/}

Defined in: [src/utils/errors.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L14)

<Expandable title="Parameters">
<ParamField body='message' type='string'>
The error message.
</ParamField>
<ParamField body='field?' type='string'>
The optional field associated with the error.
</ParamField>
</Expandable>
- Returns `AculError`

- Overrides `Error.constructor`

</ParamField>
## Properties

<ParamField body='code' type='string'>
{/*> `readonly` **code**: `string`*/}

Defined in: [src/utils/errors.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L11)

</ParamField>

<ParamField body='field?' type='string'>
{/*> `readonly` `optional` **field**: `string`*/}

Defined in: [src/utils/errors.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L12)
</ParamField>
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: "Auth0ServerError"
---

Defined in: [src/utils/errors.ts:63](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L63)

Auth0ServerError


- Extends [`AculError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError)

## Constructors

<ParamField body="Auth0ServerError" type="Constructor">
{/*> **new Auth0ServerError**(`message`, `field?`): `Auth0ServerError`*/}

Defined in: [src/utils/errors.ts:66](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L66)

<Expandable title="Parameters">
<ParamField body='message' type='string'>
The error message.
</ParamField>
<ParamField body='field?' type='string'>
The optional field associated with the error.
</ParamField>
</Expandable>
- Returns `Auth0ServerError`

- Overrides [`AculError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError).[`constructor`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError#constructor)

</ParamField>
## Properties

<ParamField body='code' type='"AUTH0_SERVER_ERROR"'>
{/*> `readonly` **code**: `"AUTH0_SERVER_ERROR"` = `'AUTH0_SERVER_ERROR'`*/}

Defined in: [src/utils/errors.ts:64](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L64)

- Overrides [`AculError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError).[`code`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError#code)

</ParamField>

<ParamField body='field?' type='string'>
{/*> `readonly` `optional` **field**: `string`*/}

Defined in: [src/utils/errors.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L12)

- Inherited from [`AculError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError).[`field`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError#field)
</ParamField>
Loading