Class AcceptInvitation

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

Hierarchy

BaseContext
- AcceptInvitation

Implements

Classes.AcceptInvitationMembers

Index

Constructors

Properties

branding client organization prompt screen tenant transaction untrustedData user screenIdentifier

Methods

acceptInvitation getError

Constructors

constructor

new AcceptInvitation(): AcceptInvitation
Creates an instance of AcceptInvitation screen manager.

Returns AcceptInvitation
Overrides BaseContext.constructor
- Defined in src/screens/accept-invitation/index.ts:23

Properties

branding

branding: Classes.BrandingMembers

client

client: Classes.ClientMembers

organization

organization: Classes.OrganizationMembers

prompt

prompt: Classes.PromptMembers

screen

screen: Classes.ScreenMembersOnAcceptInvitation

tenant

tenant: Classes.TenantMembers

transaction

transaction: Classes.TransactionMembers

untrustedData

untrustedData: Classes.UntrustedDataMembers

user

user: Classes.UserMembers

`Static`screenIdentifier

screenIdentifier: string = ScreenIds.ACCEPT_INVITATION

Methods

acceptInvitation

acceptInvitation(payload?: Classes.CustomOptions): Promise<void>
Accepts the invitation to the organization.
Parameters
- Optionalpayload: Classes.CustomOptions
  Optional custom options to include with the request.
Returns Promise<void>
Example
```
import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation';

const acceptInvitation = new AcceptInvitation();
await acceptInvitation.acceptInvitation();
```
Implementation of AcceptInvitationMembers.acceptInvitation
- Defined in src/screens/accept-invitation/index.ts:40

getError

getError(): Classes.Error[]
Retrieves the array of transaction errors from the context, or an empty array if none exist.

Returns Classes.Error[]
An array of error objects from the transaction context.
Inherited from BaseContext.getError
- Defined in src/models/base-context.ts:99